Parameter descriptions
- CMDSCOPE
- This parameter applies to z/OS only and specifies how the command is
executed when the queue manager is a member of a queue-sharing group.
- ' '
- The command is executed on the queue manager on which it was entered.
This is the default value.
- qmgr-name
- The command is executed on the queue manager you specify, providing
the queue manager is active within the queue-sharing group.
You can specify
a queue manager name, other than the queue manager on which the command was
entered, only if you are using a queue-sharing group environment and if the
command server is enabled.
- *
- The command is executed on the local queue manager and is also passed
to every active queue manager in the queue-sharing group. The effect of this
is the same as entering the command on every queue manager in the queue-sharing
group.
This parameter is not valid with TYPE(EARLY).
- INCLINT(integer)
- Specifies a value in minutes defining a period immediately before the
current time, and requests that only objects that have been created or changed
within that period (as defined by the ALTDATE and ALTTIME attributes) are
included. The value must be in the range zero through 999 999. A value of
zero means there is no time limit (this is the default).
This parameter
is valid only with TYPE(CONFIGEV).
- NAME(generic-object-name)
- Requests that only objects whose names match the one specified are included.
A trailing asterisk (*) matches all object names with the specified stem followed
by zero or more characters. An asterisk (*) on its own specifies all objects
(this is the default). NAME is ignored if OBJECT(QMGR) is specified.
This
parameter is not valid with TYPE(EARLY).
- OBJECT(objtype)
- Requests that only objects of the specified type are included. (Synonyms
for object types, such as QL, can also be specified.) The default is ALL,
to include objects of every type.
This parameter is valid only with TYPE(CONFIGEV).
- TYPE
- This is required. Values are:
- CONFIGEV
- Requests that the queue manager generates a configuration event message
for every object that matches the selection criteria specified by the OBJECT,
NAME and INCLINT parameters. Matching objects defined with QSGDISP(QMGR)
or QSGDISP(COPY) are always included. Matching objects defined with QSGDISP(GROUP)
or QSGDISP(SHARED) are included only if the command is being executed on the
queue manager where it is entered.
- EARLY
- Requests that the subsystem function routines (generally known as early
code) for the queue manager replace themselves with the corresponding routines
in the linkpack area (LPA).
You only need to use this command after you
install new subsystem function routines (provided as corrective maintenance
or with a new version or release of WebSphere MQ). This command instructs the queue
manager to use the new routines.
See the WebSphere MQ for z/OS System Setup Guide for more
information about WebSphere MQ early code routines.
- EXPIRY
- Requests that the queue manager performs a scan to discard expired messages
for every queue that matches the selection criteria specified by the NAME
parameter. (The scan is performed regardless of the setting of the EXPRYINT
queue manager attribute.)
Note:
If TYPE(EARLY) is specified, no other keywords are allowed
and the command can be issued only from the z/OS console and only if the
queue manager is not active.
Usage Notes
Issue this command with TYPE(CONFIGEV) after setting the CONFIGEV queue
manager attribute to ENABLED, to bring the queue manager configuration up-to-date.
To ensure that complete configuration information is generated, include all
objects; if you have many objects, it might be preferable to use several
commands, each with a different selection of objects, but such that all are
included.
You can also use the command with TYPE(CONFIGEV) to recover from problems
such as errors on the event queue. In such cases, use appropriate selection
criteria, to avoid excessive processing time and event messages generation.
Issue the the command with TYPE(EXPIRY) at any time when you believe that
a queue could contain numbers of expired messages.