DISPLAY CLUSQMGR

Use the MQSC command DISPLAY CLUSQMGR to display information about cluster channels for queue managers in a cluster.

Use MQSC commands

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

We can issue this command from sources CR. For an explanation of the source symbols, see Use commands on z/OS®.

Syntax diagram
Usage notes
Parameter descriptions for DISPLAY CLUSQMGR
Requested parameters
Channel parameters

Synonym : DIS CLUSQMGR

DISPLAY CLUSQMGR

ALL

CHANNEL(generic-name)

CLUSTER(generic-name)

CMDSCOPE(' ')CMDSCOPE(qmgr-name)

CMDSCOPE(*)1

2Requested attributes

Channel attributes

Requested attributes

Channel attributes

PROPCTLPUTAUTRCVDATARCVEXITSCYDATASCYEXITSENDDATASENDEXITSEQWRAPSHORTRTYSHORTTMRSSLCAUTHSSLCIPHSSLPEERTPNAMETRPTYPEUSEDLQUSERIDXMITQ

Notes:

¹ Valid only on z/OS when the queue manager is a member of a queue-sharing group.
² Valid only on z/OS.
³ Not valid on z/OS.

Usage notes

Unlike the DISPLAY CHANNEL command, this command includes information about cluster channels that are auto-defined, and the status of cluster channels. Note: On z/OS, the command fails if the channel initiator is not started.

Parameter descriptions for DISPLAY CLUSQMGR

( generic-qmgr-name )

The name of the cluster queue manager for which information is to be displayed.

A trailing asterisk * matches all cluster queue managers with the specified stem followed by zero or more characters. An asterisk * on its own specifies all cluster queue managers.

WHERE

Specify a filter condition to display only those cluster channels that satisfy the selection criterion of the filter condition. The filter condition is in three parts: filter-keyword, operator, and filter-value:

filter-keyword

Almost any parameter that can be used to display attributes for this DISPLAY command. However, we cannot use the CMDSCOPE or MCANAME parameters as filter keywords. We cannot use CHANNEL or CLUSTER as filter keywords if we use them to select cluster queue managers.

operator

The operators are:

LT: Less than
GT: Greater than
EQ: Equal to
NE: Not equal to
LE: Less than or equal to
GE: Greater than or equal to
LK: Matches a generic string that you provide as a filter-value
NL: Does not match a generic string that you provide as a filter-value
CT: Contains a specified item. If the filter-keyword is a list, we can use CT to display objects the attributes of which contain the specified item.
EX: Does not contain a specified item. If the filter-keyword is a list, we can use EX to display objects the attributes of which do not contain the specified item.
CTG: Contains an item which matches a generic string that you provide as a filter-value. If the filter-keyword is a list, we can use CTG to display objects the attributes of which match the generic string.
EXG: Does not contain any item which matches a generic string that you provide as a filter-value. If the filter-keyword is a list, we can use EXG to display objects the attributes of which do not match the generic string.

filter-value

The value that the attribute value must be tested against using the operator. Depending on the filter-keyword, filter-value can be:

An explicit value, that is a valid value for the attribute being tested.
We can use operators LT, GT, EQ, NE, LE,, or GE only. If the attribute value is a value from a possible set of values, we can use only EQ or NE. For example, the value STARTING on the STATUS parameter.
A generic value. filter-value is a character string. An example is ABC*. If the operator is LK, all items where the attribute value begins with the string, ABC in the example, are listed. If the operator is NL, all items where the attribute value does not begin with the string are listed. Only a single trailing wildcard character (asterisk) is permitted.
We cannot use a generic filter-value for parameters with numeric values or with one of a set of values.
An item in a list of values. The value can be explicit or, if it is a character value, it can be explicit or generic. If it is explicit, use CT or EX as the operator. For example, if the value DEF is specified with the operator CT, all items where one of the attribute values is DEF are listed. If it is generic, use CTG or EXG as the operator. If ABC* is specified with the operator CTG, all items where one of the attribute values begins with ABC are listed.

ALL

Specify ALL to display all the parameters. If this parameter is specified, any parameters that are also requested specifically have no effect; all parameters are still displayed.

ALL is the default if we do not specify a generic name and do not request any specific parameters.

On z/OS ALL is also the default if you specify a filter condition using the WHERE parameter, but on other platforms, only requested attributes are displayed.

CHANNEL ( generic-name )

This is optional, and limits the information displayed to cluster channels with the specified channel name. The value can be a generic name.

CLUSTER ( generic-name )

This is optional, and limits the information displayed to cluster queue managers with the specified cluster name. The value can be a generic name.

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. '' 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.
We can specify a queue manager name, other than the queue manager on which the command was entered. We can enter a different queue manager name, 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 * is the same as entering the command on every queue manager in the queue sharing group.

We cannot use CMDSCOPE as a filter keyword.

Requested parameters

Specify one or more parameters that define the data to be displayed. The parameters can be specified in any order, but do not specify the same parameter more than once.

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.

CLUSDATE

The date on which the definition became available to the local queue manager, in the form yyyy-mm-dd.

CLUSTIME

The time at which the definition became available to the local queue manager, in the form hh.mm.ss.

DEFTYPE

How the cluster channel was defined:

CLUSSDR: As a cluster-sender channel from an explicit definition.
CLUSSDRA: As a cluster-sender channel by auto-definition alone.
CLUSSDRB: As a cluster-sender channel by auto-definition and an explicit definition.
CLUSRCVR: As a cluster-receiver channel from an explicit definition.

QMID

The internally generated unique name of the cluster queue manager.

QMTYPE

The function of the cluster queue manager in the cluster:

REPOS: Provides a full repository service.
NORMAL: Does not provide a full repository service.

STATUS

The status of the channel for this cluster queue manager is one of the following values:

STARTING

The channel was started and is waiting to become active.

BINDING

The channel is performing channel negotiation and is not yet ready to transfer messages.

INACTIVE

The channel is not active.

INITIALIZING

The channel initiator is attempting to start a channel.

On z/OS, INITIALIZING is displayed as INITIALIZI.

RUNNING

The channel is either transferring messages at this moment, or is waiting for messages to arrive on the transmission queue so that they can be transferred.

STOPPING

The channel is stopping, or received a close request.

RETRYING

A previous attempt to establish a connection failed. The MCA attempts to connect again after the specified time interval.

PAUSED

The channel is waiting for the message-retry interval to complete before trying an MQPUT operation again.

STOPPED

This state can be caused by one of the following events:

Channel manually stopped.
A user entered a stop channel command for this channel.
The number of attempts to establish a connection reached the maximum number of attempts allowed for the channel.
No further attempt is made to establish a connection automatically.

A channel in this state can be restarted only by issuing the START CHANNEL command, or starting the MCA program in an operating-system dependent manner.

REQUESTING

A local requester channel is requesting services from a remote MCA.

SWITCHING

The channel is switching transmission queues.

SUSPEND

Specifies whether this cluster queue manager is suspended from the cluster or not (as a result of the SUSPEND QMGR command). The value of SUSPEND is either YES or NO.

VERSION

The version of the IBM MQ installation that the cluster queue manager is associated with. The version has the format VVRRMMFF:

VV: Version
RR: Release
MM: Maintenance level
FF: Fix level

XMITQ

The cluster transmission queue.

Channel parameters

ALTDATE: The date on which the definition or information was last altered, in the form yyyy-mm-dd
ALTTIME: The time at which the definition or information was last altered, in the form hh.mm.ss
BATCHHB: The batch heartbeat value being used.
BATCHINT: Minimum batch duration.
BATCHLIM: Batch data limit.
The limit of the amount of data that can be sent through a channel.
BATCHSZ: Batch size.
CLWLPRTY: The priority of the channel for the purposes of cluster workload distribution.
CLWLRANK: The rank of the channel for the purposes of cluster workload distribution.
CLWLWGHT: The weighting of the channel for the purposes of cluster workload distribution.
COMPHDR: The list of header data compression techniques supported by the channel.
COMPMSG: The list of message data compression techniques supported by the channel.
CONNAME: Connection name.
CONVERT: Specifies whether the sender converts application message data.
DESCR: Description.
DISCINT: Disconnection interval.
HBINT: Heartbeat interval.
KAINT: KeepAlive timing for the channel.
LOCLADDR: Local communications address for the channel.
LONGRTY: Limit of number of attempts to connect using the long duration timer.
LONGTMR: Long duration timer.
MAXMSGL: Maximum message length for channel.
MCANAME: Message channel agent name.
We cannot use MCANAME as a filter keyword.
MCATYPE: Specifies whether the message channel agent runs as a separate process or a separate thread.
MCAUSER: Message channel agent user identifier.
MODENAME: LU 6.2 mode name.
MRDATA: Channel message-retry exit user data.
MREXIT: Channel message-retry exit name.
MRRTY: Channel message-retry count.
MRTMR: Channel message-retry time.
MSGDATA: Channel message exit user data.
MSGEXIT: Channel message exit names.
NETPRTY: The priority for the network connection.
NPMSPEED: Nonpersistent message speed.
PASSWORD: Password for initiating LU 6.2 session (if nonblank, PASSWORD is displayed as asterisks).
PROPCTL: Message property control.
PUTAUT: Put authority.
RCVDATA: Channel receive exit user data.
RCVEXIT: Channel receive exit names.
SCYDATA: Channel security exit user data.
SCYEXIT: Channel security exit name.
SENDDATA: Channel send exit user data.
SENDEXIT: Channel send exit names.
SEQWRAP: Sequence number wrap value.
SHORTRTY: Limit of number of attempts to connect using the short duration timer.
SHORTTMR: Short duration timer.
SSLCAUTH: Specifies whether TLS client authentication is required.
SSLCIPH: Cipher specification for the TLS connection.
SSLPEER: Filter for the Distinguished Name from the certificate of the peer queue manager or client at the other end of the channel.
TRPTYPE: Transport type.
TPNAME: LU 6.2 transaction program name.
USEDLQ: Determines whether the dead-letter queue is used when messages cannot be delivered by channels.
USERID: User identifier for initiating LU 6.2 session.

For more information about channel parameters, see DEFINE CHANNEL