SET MANAGER

Parameters

NAME(manager-name-mask)

On z/OS® systems, this parameter value is the 1- through 4-character specific or generic name of the queue managers that you want to monitor. To specify a generic name, enter a character string followed by an asterisk (*). For example, to monitor all z/OS system queue managers, specify NAME(*). This parameter is required on z/OS systems.

On distributed systems, specify the full name of the queue manager that you want to monitor without any asterisks. If you do not specify this parameter, the default queue manager is monitored.

GROUP(group-name)

A previously defined group that has parameter defaults that apply to this queue manager. The name must exactly match the name that is specified on a prior SET GROUP statement. The default group that is provided is named DEFAULT.

ACTIVE(YES|NO)

Indicates whether to actively monitor this queue manager. YES is the default.

AGGRHIST(aggregation-samples)

Specifies the number of recent samples to maintain in agent storage for all queue managers in this group. The default value is 15. You can view data per recent sample interval about a given object by linking from a row about the object to a workspace with a name that begins with "Recent."

COMMAND(YES|NO)

Specifies if passing IBM MQ commands to the queue manager from Tivoli Enterprise Portal is available.

Valid values are as follows:

• YES: Enables the MQ Command feature. You can then pass IBM MQ commands to the queue manager from Tivoli Enterprise Portal. This is the default value.
• NO: Disables the MQ Command feature.

EVENTS(REMOVE|BROWSE|NO)

Specifies how to access system event queues.

Valid values are as follows:

• REMOVE: Read and remove messages from the system event queues. This setting provides the most accurate event reporting. The value that is configured automatically during the installation and configuration process is REMOVE. When REMOVE is specified, the agent opens the event queues for exclusive access.

  To provide support for multiple applications to read event queues, use the SET EVENTQIN and SET EVENTQOUT commands as described in SET EVENTQIN and SET EVENTQOUT.

• BROWSE: Browse (read without removing) messages in the system event queues. Specify this value if more than one application (IBM MQ Monitoring Agent or another application) reads the event queues. In this case, you must run a separate application to clean the queues, such as CSQUTIL with the EMPTY function.
  Remember: If you specify EVENTS(BROWSE) and other applications perform destructive reads against the event queues, IBM MQ Monitoring Agent might miss some or all event messages.
• NO: Do not monitor system event queues.

HLQ(high-level-qualifier)

Specifies the high-level qualifier for queue names that are created by IBM MQ Monitoring Agent. The default value is KMQ. The maximum length of this parameter is 8 characters.

IBM MQ Monitoring Agent uses these names:

hlq.COMMAND.REPLY
hlq.REPLY

where hlq is the value that is specified by the HLQ parameter of the SET MANAGER or the SET GROUP command.

You can predefine queues by those names in your queue managers if you want. If they are not predefined, the agent will create dynamic queues using the model queue that is specified by the RQMODEL parameter on the SET MANAGER or SET GROUP command.

After OA61473, if predefined or permanent dynamic queues by the names given above already exist, the agent will reuse those queues when it is started. By default, the agent uses the permanent dynamic model queue called SYSTEM.COMMAND.REPLY.MODEL. A permanent dynamic model queue in the RQMODEL agent parameter like this causes the agent to create queues by those names the first time the agent is started and then to reuse them when the agent is restarted. If RQMODEL specifies a different model queue for a temporary dynamic queue, the agent will create temporary dynamic queues by those names each time it is started.

If for any reason you want to monitor the same queue manager by more than one agent, you must make sure this HLQ parameter is unique for each agent runtime on the same LPAR; it is suggested in this case to append the 1-4 characters used for RTE_STC_PREFIX to "KMQ."

ICYCLE(interval-cycle)

This parameter applies only to z/OS systems.

This optional parameter specifies the number of sample interval cycles to wait before gathering performance data for the specified queue managers. The default value is 1 minute. You can use this parameter to lengthen the sampling interval for a specific queue manager or a group of queue managers whose data collection is less critical and can be performed less frequently. For example, if the sample interval (SAMPINT) for a queue manager is set to 60 and its interval cycle (ICYCLE) is set to 5, interrogative processing for that queue manager is performed on only every fifth cycle; every five minutes instead of every minute.

If you do not specify the ICYCLE parameter, or if it is not specified on a prior SET GROUP statement, the default value is 1; queue manager data is gathered once every sample interval (SAMPINT).

LIKE(queue-manager-name)

The name or the nickname of a previously defined queue manager. Parameter values that are not specified in this SET MANAGER statement are copied from the corresponding values for the named queue manager.

ACTIONAUTHUSERS(user-name-mask-list)

This parameter is only applicable to the manual Take Action command.

Specifies that the Tivoli Enterprise Portal user ID must match one of the user name mask lists before the Take Action command can be issued.

If the ACTIONAUTHUSERS parameter value is specified as empty [()], it indicates that ACTIONAUTHUSERS is not defined in the parameters list. This ACTIONAUTHUSERS parameter is ignored.

If the ACTIONAUTHUSERS parameter value is set to a user name mask list, it specifies which Tivoli Enterprise Portal users are authorized to issue the Take Action commands that are associated with this IBM MQ Monitoring Agent. There can be multiple entries that are associated with this parameter. Separate each entry with a comma (,). An entry can be a mask that includes the asterisk (*) and question mark (?) wildcard characters. A Tivoli Enterprise Portal user that has an ID that matches any masks in this list is authorized to issue the Take Action commands. Tivoli Enterprise Portal user IDs are defined within the Tivoli Enterprise Monitoring Server and do not necessarily exist on the node on which the IBM MQ Monitoring Agent is running.

ACTIONACCOUNT(UIUSER|MQAGENT|USER=user-id)

This parameter is only applicable to the Take Action commands that are provided with IBM MQ Monitoring Agent.

Specifies that IBM MQ Monitoring Agent uses the ACTIONACCOUNT value as an alternate user ID when interacting with IBM MQ. The ACTIONACCOUNT parameter specifies whether the authorization should use the Tivoli Enterprise Portal user ID, the monitoring agent account, or the predefined account.

Valid values are as follows:

• (): Overrides the value defined on the SET GROUP or SET MANAGER command.
• UIUSER: The agent uses the Tivoli Enterprise Portal user ID to interact with IBM MQ.
• MQAGENT: The agent uses the monitoring agent account to interact with IBM MQ.
• USER=user-id: The agent uses the predefined account (user-id) to interact with IBM MQ.

If a value other than these values is specified, the value is not valid; the ACTIONACCOUNT parameter is regarded as not being defined on the command.

For the reflex automation, only the ID that is specified in ACTIONACCOUNT(USER=user_id) is used to issue the MQ command; otherwise, the MQ Monitoring agent user ID is used to issue the MQ command.

MSGACCESS(NONE|DESC|RETRY|DATA|DELETE|USEQACCESS)

Controls the level of user access to messages in queues for the specified queue managers.

Valid values are as follows:

• NONE: No access to message functions is permitted for the specified queue managers, including the ability to list messages on a queue or collect message statistics.
• DESC: Message descriptor browse is permitted for message summary workspaces, message detail workspaces, or message statistics workspaces and situations. This is the default level.
• RETRY: DLQ retry and message descriptor browse are permitted.
• DATA: Message data (contents) browse, message descriptor browse, and DLQ retry are permitted.
• DELETE: Deletion of messages and all other message functions are permitted.
• USEQACCESS: Specifies that all the queues that belongs to the current group or queue manager must be defined by a new SET QACCESS command to grant message access rights. The queues that belong to the current group and that are not defined by a SET QACCESS command have the message access level NONE.

NICKNAME(nickname)

A 1- through 48-character nickname (alternate name) for this queue manager. Subsequent commands can refer to the manager by its manager name or by this nickname. This parameter is optional.

RETAINHIST(historical-retention-value)

Number of minutes that queue manager objects (such as channels and queues) that are no longer defined in the queue manager are retained in agent memory and returned for display in workspaces, so that it is easier to link to historical data about the objects. You can decrease the RETAINHIST value if you want less data to be maintained in memory for these objects that are no longer defined. This parameter is only valid for channels and local queues.

RQMODEL(reply-to-queue's-model-queue)

Specifies the 1- through 48-character name of a model queue to use as a model for the reply-to queue of IBM MQ Monitoring Agent, if you did not predefine queues. If you require dynamic queues, see the description of the HLQ parameter.

If you do not specify a value for the RQMODEL parameter, the following standard system default models are used as a model for the reply-to-queue of IBM MQ Monitoring Agent.

• SYSTEM.COMMAND.REPLY.MODEL

If the queue that you specify as a model has a definition type of permanent dynamic [DEFTYPE(PERMDYN)], some unused reply-to-queues might accumulate. These have the names in the following forms:

• hlq.COMMAND.REPLY.dynamicsuffix
  hlq.REPLY.dynamicsuffix

where the hlq value is the value that is specified on the HLQ parameter on the SET MANAGER or the SET GROUP command, and the dynamicsuffix value is the standard dynamic suffix that is provided by IBM MQ.

STATUS(ADD|DELETE|RESET)

Specifies what to do if this SET MANAGER command was previously specified with the same name.

This parameter applies only to z/OS systems.

If this parameter is omitted, the manager definition is added if it is a new name; it is modified if the same name was specified previously.

Valid values are as follows:

• ADD: Creates a new manager definition.
• DELETE: Deletes the manager definition and all associated historical data.
• RESET: Resets the monitoring parameters that are associated with this queue manager to their original values (as defined on the original SET MANAGER command for this manager name).

SYSNAME(z/OS-system-id)

The SMF system ID where this queue manager runs. If this parameter is omitted, this SET MANAGER command applies to any z/OS systems.

REMOTE(YES|NO)

Specifies whether the queue manager is a remote queue manager or a local one.

If this parameter is omitted, the queue manager is a local queue manager.

Valid values are as follows:

• YES: The queue manager is a remote queue manager.
• NO: The queue manager is a local queue manager.

MSGSITACCOUNT(MQAGENT|USER=user_id)

Specifies the IBM MQ Monitoring Agent uses the MSGSITACCOUNT value as an alternate user ID to interact with IBM MQ for message monitoring situations.

This parameter is applicable only to the situations that are defined against the Message Summary attribute group.

This parameter takes effect only when the MSGSITMON is set to YES.

Valid values are as follows:

• MQAGENT: The agent uses the monitoring agent account to interact with IBM MQ.
• USER=user-id: The agent uses the predefined account (user-id) to interact with IBM MQ.

MSGSITMON (YES|NO|STATONLY)

Specifies whether to enable situations that are defined against the Message Summary attribute group for monitoring message content and message header.

Valid values are as follows:

• YES: Enables situations for message monitoring. This value takes effect only when the MSGSITACCOUNT parameter is specified. Otherwise, it defaults to STATONLY.
• NO: Disables the situations for the message monitoring and disables message statistics monitoring.
• STATONLY: This is the default value. The behavior of the IBM MQ Monitoring Agent is not changed. Situations cannot be defined against the Message Summary attribute group to monitor message content and message header. This is the value to use when the MSGSITMON parameter is not specified.