Inquire Cluster Queue Manager

The Inquire Cluster Queue Manager (MQCMD_INQUIRE_CLUSTER_Q_MGR) command inquires about the attributes of IBM MQ queue managers in a cluster.

Required parameters

ClusterQMgrName (MQCFST)

Queue manager name (parameter identifier: MQCA_CLUSTER_Q_MGR_NAME).

Generic queue manager names are supported. A generic name is a character string followed by an asterisk *, for example ABC*. It selects all queue managers having names that start with the selected character string. An asterisk on its own matches all possible names.

The queue manager name is always returned, regardless of the attributes requested.

The maximum length of the string is MQ_Q_MGR_NAME_LENGTH.

Optional parameters

Channel (MQCFST)

Channel name (parameter identifier: MQCACH_CHANNEL_NAME).

Specifies that eligible cluster queue managers are limited to those having the specified channel name.

Generic channel names are supported. A generic name is a character string followed by an asterisk *, for example ABC*. It selects all queue managers having names that start with the selected character string. An asterisk on its own matches all possible names.

The maximum length of the string is MQ_CHANNEL_NAME_LENGTH.

If we do not specify a value for this parameter, channel information about all queue managers in the cluster is returned.

ClusterName (MQCFST)

Cluster name (parameter identifier: MQCA_CLUSTER_NAME).

Specifies that eligible cluster queue managers are limited to those having the specified cluster name.

Generic cluster names are supported. A generic name is a character string followed by an asterisk *, for example ABC*. It selects all queue managers having names that start with the selected character string. An asterisk on its own matches all possible names.

The maximum length of the string is MQ_CLUSTER_NAME_LENGTH.

If we do not specify a value for this parameter, cluster information about all queue managers inquired is returned.

ClusterQMgrAttrs (MQCFIL)

Attributes (parameter identifier: MQIACF_CLUSTER_Q_MGR_ATTRS).

Some parameters are relevant only for cluster channels of a particular type or types. Attributes that are not relevant for a particular type of channel cause no output, and do not cause an error. To check which attributes apply to which channel types; see Channel attributes and channel types.

The attribute list might specify the following value on its own. If the parameter is not specified, a default value is used.

MQIACF_ALL: All attributes.

Alternative, supply a combination of the following values:

MQCA_ALTERATION_DATE: The date on which the information was last altered.
MQCA_ALTERATION_TIME: The time at which the information was last altered.
MQCA_CLUSTER_DATE: The date on which the information became available to the local queue manager.
MQCA_CLUSTER_NAME: The name of the cluster to which the channel belongs.
MQCA_CLUSTER_Q_MGR_NAME: The name of the cluster to which the channel belongs.
MQCA_CLUSTER_TIME: The time at which the information became available to the local queue manager.
MQCA_Q_MGR_IDENTIFIER: The unique identifier of the queue manager.
MQCA_VERSION: The version of the IBM MQ installation that the cluster queue manager is associated with.
MQCA_XMIT_Q_NAME: The cluster transmission queue used by the queue manager.
MQCACH_CONNECTION_NAME: Connection name.
MQCACH_DESCRIPTION: Description.
MQCACH_LOCAL_ADDRESS: Local communications address for the channel.
MQCACH_MCA_NAME: Message channel agent name.
We cannot use MQCACH_MCA_NAME as a parameter to filter on.
MQCACH_MCA_USER_ID: MCA user identifier.
MQCACH_MODE_NAME: Mode name.
MQCACH_MR_EXIT_NAME: Message-retry exit name.
MQCACH_MR_EXIT_USER_DATA: Message-retry exit user data.
MQCACH_MSG_EXIT_NAME: Message exit name.
MQCACH_MSG_EXIT_USER_DATA: Message exit user data.
MQCACH_PASSWORD: Password.
This parameter is not valid on z/OS .
MQCACH_RCV_EXIT_NAME: Receive exit name.
MQCACH_RCV_EXIT_USER_DATA: Receive exit user data.
MQCACH_SEC_EXIT_NAME: Security exit name.
MQCACH_SEC_EXIT_USER_DATA: Security exit user data.
MQCACH_SEND_EXIT_NAME: Send exit name.
MQCACH_SEND_EXIT_USER_DATA: Send exit user data.
MQCACH_SSL_CIPHER_SPEC: TLS cipher spec.
MQIACH_SSL_CLIENT_AUTH: TLS client authentication.
MQCACH_SSL_PEER_NAME: TLS peer name.
MQCACH_TP_NAME: Transaction program name.
MQCACH_USER_ID: User identifier.
This parameter is not valid on z/OS.
MQIA_MONITORING_CHANNEL: Online monitoring data collection.
MQIA_USE_DEAD_LETTER_Q: Determines whether the dead-letter queue is used when messages cannot be delivered by channels.
MQIACF_Q_MGR_DEFINITION_TYPE: How the cluster queue manager was defined.
MQIACF_Q_MGR_TYPE: The function of the queue manager in the cluster.
MQIACF_SUSPEND: Specifies whether the queue manager is suspended from the cluster.
MQIACH_BATCH_HB: The value being used for the batch heartbeat.
MQIACH_BATCH_INTERVAL: Batch wait interval (seconds).
MQIACH_BATCH_DATA_LIMIT: Batch data limit (kilobytes).
MQIACH_BATCH_SIZE: Batch size.
MQIACH_CHANNEL_STATUS: Channel status.
MQIACH_CLWL_CHANNEL_PRIORITY: Cluster workload channel priority.
MQIACH_CLWL_CHANNEL_RANK: Cluster workload channel rank.
MQIACH_CLWL_CHANNEL_WEIGHT: Cluster workload channel weight.
MQIACH_DATA_CONVERSION: Specifies whether sender must convert application data.
MQIACH_DISC_INTERVAL: Disconnection interval.
MQIACH_HB_INTERVAL: Heartbeat interval (seconds).
MQIACH_HDR_COMPRESSION: The list of header data compression techniques supported by the channel.
MQIACH_KEEP_ALIVE_INTERVAL: KeepAlive interval (valid on z/OS only).
MQIACH_LONG_RETRY: Count of long duration attempts.
MQIACH_LONG_TIMER: Long duration timer.
MQIACH_MAX_MSG_LENGTH: Maximum message length.
MQIACH_MCA_TYPE: MCA type.
MQIACH_MR_COUNT: Count of send message attempts.
MQIACH_MR_INTERVAL: Interval between attempting to resend a message in milliseconds.
MQIACH_MSG_COMPRESSION: List of message data compression techniques supported by the channel.
MQIACH_NETWORK_PRIORITY: Network priority.
MQIACH_NPM_SPEED: Speed of nonpersistent messages.
MQIACH_PUT_AUTHORITY: Put authority.
MQIACH_SEQUENCE_NUMBER_WRAP: Sequence number wrap.
MQIACH_SHORT_RETRY: Count of short duration attempts.
MQIACH_SHORT_TIMER: Short duration timer.
MQIACH_XMIT_PROTOCOL_TYPE: Transmission protocol type.

CommandScope (MQCFST)

Command scope (parameter identifier: MQCACF_COMMAND_SCOPE). This parameter applies to z/OS only. Specifies how the command is processed when the queue manager is a member of a queue sharing group. We can specify one of the following values:

Blank (or omit the parameter altogether). The command is processed on the queue manager on which it was entered.
A queue manager name. The command is processed 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, we must be using a queue sharing group environment. The command server must be enabled.
An asterisk * . The command is processed 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.

We cannot use CommandScope as a parameter to filter on.

IntegerFilterCommand (MQCFIF): Integer filter command descriptor. The parameter identifier must be any integer type parameter allowed in ClusterQMgrAttrs except MQIACF_ALL and others as noted. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFIF - PCF integer filter parameter for information about using this filter condition.
If you specify an integer filter, we cannot also specify a string filter using the StringFilterCommand parameter.

StringFilterCommand (MQCFSF)

String filter command descriptor. The parameter identifier must be any string type parameter allowed in ClusterQMgrAttrs except MQCA_CLUSTER_Q_MGR_NAME and others as noted. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFSF - PCF string filter parameter for information about using this filter condition.

If you specify a string filter for Channel or ClusterName, we cannot also specify the Channel or ClusterName parameter.

If you specify a string filter, we cannot also specify an integer filter using the IntegerFilterCommand parameter.

Parent topic: Definitions of the Programmable Command Formats