Refresh Queue Manager

Use the Refresh Queue Manager (MQCMD_REFRESH_Q_MGR) command to perform special operations on queue managers.


Required parameters

    RefreshType (MQCFIN)
    Type of information to be refreshed (parameter identifier: MQIACF_REFRESH_TYPE). Use this parameter to specify the type of information to be refreshed. The value can be any of the following values:

      MQRT_CONFIGURATION
      MQRT_CONFIGURATION causes the queue manager to generate configuration event messages for every object definition that matches the selection criteria specified by the ObjectType, ObjectName, and RefreshInterval parameters.

      A Refresh Queue Manager command with a RefreshType value of MQRT_CONFIGURATION is generated automatically when the value of the queue manager's ConfigurationEvent parameter changes from MQEVR_DISABLED to MQEVR_ENABLED.

      Use this command with a RefreshType of MQRT_CONFIGURATION 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 message generation.

      MQRT_EXPIRY
      This requests that the queue manager performs a scan to discard expired messages for every queue that matches the selection criteria specified by the ObjectName parameter. Note: Valid only on z/OS®.

      MQRT_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.

      See Task 3: Update the z/OS link list and LPA for more information about IBM MQ early code routines.

      MQRT_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.


Optional parameters (Refresh Queue Manager)

    CommandScope (MQCFST)
    Command scope (parameter identifier: MQCACF_COMMAND_SCOPE). Specifies how the command is executed when the queue manager is a member of a queue-sharing group. We can specify one of the following:

    • blank (or omit the parameter altogether). The command is executed on the queue manager on which it was entered.
    • a queue manager name. The command is executed on the queue manager you specify, providing it is active within the queue sharing group. If you specify a queue manager name other than the queue manager on which it was entered, you must be using a queue sharing group environment, and the command server must be enabled.
    • an asterisk (*). The command is executed on the local queue manager and is also passed to every active queue manager in the queue sharing group.

    The maximum length is MQ_QSG_NAME_LENGTH.

    ObjectName (MQCFST)
    Name of object to be included in the processing of this command (parameter identifier: MQCACF_OBJECT_NAME).

    Use this parameter to specify the name of the object to be included in the processing of this command.

    Generic names are supported. A generic name is a character string followed by an asterisk (*), for example ABC*, and it selects all objects having names that start with the selected character string. An asterisk on its own matches all possible names.

    The maximum length is MQ_OBJECT_NAME_LENGTH.

    ObjectType (MQCFIN)
    Object type for which configuration data is to be refreshed (parameter identifier: MQIACF_OBJECT_TYPE). Use this parameter to specify the object type for which configuration data is to be refreshed. This parameter is valid only if the value of RefreshType is MQRT_CONFIGURATION. The default value, in that case, is MQOT_ALL. The value can be one of:

      MQOT_AUTH_INFO
      Authentication information object.

      MQOT_CF_STRUC
      CF structure.

      MQOT_CHANNEL
      Channel.

      MQOT_CHLAUTH
      Channel authentication

      MQOT_LISTENER
      Listener.

      MQOT_NAMELIST
      Namelist.

      MQOT_PROCESS
      Process definition.

      MQOT_Q
      Queue.

      MQOT_LOCAL_Q
      Local queue.

      MQOT_MODEL_Q
      Model queue.

      MQOT_ALIAS_Q
      Alias queue.

      MQOT_REMOTE_Q
      Remote queue.

      MQOT_Q_MGR
      Queue manager.

      MQOT_CFSTRUC
      CF structure.

      MQOT_SERVICE
      Service. Note: Not valid on z/OS.

      MQOT_STORAGE_CLASS
      Storage class.

      MQOT_TOPIC
      Topic name.

    RefreshInterval (MQCFIN)
    Refresh interval (parameter identifier: MQIACF_REFRESH_INTERVAL).

    Use this parameter to specify a value, in minutes, defining a period immediately before the current time. This requests that only objects that have been created or altered within that period (as defined by their AlterationDate and AlterationTime attributes) are included.

    Specify a value in the range zero through 999 999. A value of zero means there is no time limit (0 is the default).

    This parameter is valid only if the value of RefreshType is MQRT_CONFIGURATION.


Usage Notes for Refresh Queue Manager

  1. Issue this command with RefreshType (MQRT_CONFIGURATION) after setting the MQRT_CONFIGURATION 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 we 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. We can also use the command with RefreshType (MQRT_CONFIGURATION) 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 RefreshType (MQRT_EXPIRY) at any time when you believe that a queue could contain numbers of expired messages.
  4. If RefreshType (MQRT_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 Queue Manager RefreshType (MQRT_PROXYSUB) other than in exceptional circumstances. See Resynchronization of proxy subscriptions.
  6. If a Refresh Queue Manager Object Type(MQRT_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.
  7. Running the command Refresh Queue Manager RefreshType (MQRT_CONFIGURATION) Object Type(MQOT_ALL) includes authority records.

    We cannot specify the Refresh Interval and Object Name parameters if you explicitly specify Authority Record events. If you specify Object Type(MQOT_ALL) the Refresh Interval and Object Name parameters are ignored.