REFRESH QMGR (refresh a queue manager)

Use the MQSC command REFRESH QMGR to perform special operations on queue managers.

Using MQSC commands

For information on how you use MQSC commands, see Performing local administration tasks using MQSC commands.

Syntax diagram

Synonym: None

REFRESH QMGR

Read syntax diagramSkip visual syntax diagram REFRESH QMGR TYPE ( CONFIGEVConfig Event attrsEARLY1EXPIRY1NAME(*)NAME(generic-object-name)PROXYSUB ) CMDSCOPE(' ')CMDSCOPE(qmgr-name)2CMDSCOPE(*)21
Config Event attrs
Read syntax diagramSkip visual syntax diagramINCLINT(0)INCLINT(integer)NAME(*)NAME(generic-object-name)OBJECT(ALL)OBJECT(AUTHINFO)OBJECT(AUTHREC)3OBJECT(CFSTRUCT)1OBJECT(CHANNEL)OBJECT(CHLAUTH)OBJECT(LISTENER)3OBJECT(NAMELIST)OBJECT(PROCESS)OBJECT(QALIAS)OBJECT(QLOCAL)OBJECT(QMGR)OBJECT(QMODEL)OBJECT(QREMOTE)OBJECT(QUEUE)OBJECT(SERVICE)3OBJECT(STGCLASS)1OBJECT(TOPIC)
Notes:
  • 1 Valid only on z/OS®.
  • 2 Valid only when the queue manager is a member of a queue sharing group.
  • 3 Not valid on z/OS.
[z/OS]

Using REFRESH QMGR on z/OS

REFRESH QMGR can be used on z/OS. Depending on the parameters used on the command, it may be issued from various sources. For an explanation of the symbols in this table, see Sources from which you can issue MQSC commands on z/OS.

Table 1. REFRESH QMGR command and command sources
Command Command Sources Notes
REFRESH QMGR TYPE(CONFIGEV) 2CR  
REFRESH QMGR TYPE(EARLY) C Queue manager must not be active.
REFRESH QMGR TYPE(EXPIRY) 2CR  
REFRESH QMGR TYPE(PROXYSUB) 2CR CHINIT must be active to complete the command.

Usage Notes for REFRESH QMGR

  1. 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.
  2. 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.
  3. Issue the command with TYPE(EXPIRY) at any time when you believe that a queue could contain numbers of expired messages.
  4. [z/OS]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.
  5. You are unlikely to use REFRESH QMGR TYPE(PROXYSUB) other than in exceptional circumstances. See Resynchronization of proxy subscriptions.
  6. Successful completion of the REFRESH QMGR TYPE(PROXYSUB) command does not mean that the action completed. To check for true completion, see the REFRESH QMGR TYPE(PROXYSUB) step in Checking that async commands for distributed networks have finished.
  7. [z/OS]If a REFRESH QMGR TYPE(PROXYSUB) command is issued on z/OS when the CHINIT is not running, the command is queued up and will be processed when the CHINIT starts.
  8. Running the command REFRESH QMGR TYPE(CONFIGEV) OBJECT(ALL) includes authority records.

    You cannot specify the INCLINT and NAME parameters if you explicitly specify AUTHREC events. If you specify OBJECT(ALL) the INCLINT and NAME parameters are ignored.

Parameter descriptions for REFRESH QMGR

[z/OS]CMDSCOPE
This parameter applies to z/OS only and specifies how the command runs when the queue manager is a member of a queue sharing group.
' '
The command runs on the queue manager on which it was entered. This is the default value.
qmgr-name
The command runs 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 runs 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 with names that 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 need to use this command only after you install new subsystem function routines (provided as corrective maintenance or with a new version or release of IBM® MQ). This command instructs the queue manager to use the new routines.

[z/OS]See Update the z/OS link list and LPA for more information about IBM 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.)
PROXYSUB
Requests that the queue manager resynchronizes the proxy subscriptions that are held with, and on behalf of, queue managers that are connected in a hierarchy or publish/subscribe cluster.

You should only resynchronize the proxy subscriptions in exceptional circumstances. See Resynchronization of proxy subscriptions.