WRKMQMCL (Work with MQ Clusters)

The Work with MQ Clusters command, WRKMQMCL, allows you to work with multiple cluster queue manager definitions that are defined on the local queue manager.

Where allowed to run: All environments (*ALL)
Threadsafe: Yes

Parameters

Table 1. Command parameters
Keyword	Description	Choices	Notes
CLUSQMGR	Cluster Queue Manager name	`Character value`, *ALL	Optional, Positional 1
MQMNAME	Message Queue Manager name	`Character value`, *DFT	Optional, Positional 2
WHERE	Filter command	Single values: *NONE Other values: `Element list`	Optional, Positional 3
	Element 1: Filter keyword	ALTDATE, ALTTIME, BATCHHB, BATCHINT, BATCHLIM, BATCHSIZE, CHLNAME, CLUSDATE, CLUSQMGR, CLUSTER, CLUSTIME, CLWLPRTY, CLWLRANK, CLWLWGHT, COMPHDR, COMPMSG, CONNAME, CVTMSG, DFNTYPE, DSCITV, HRTBTINTVL, KAINT, LOCLADDR, LONGRTY, LONGTMR, MAXMSGLEN, MCANAME, MCATYPE, MCAUSRID, MONCHL, MSGEXIT, MSGRTYDATA, MSGRTYEXIT, MSGRTYITV, MSGRTYNBR, MSGUSRDATA, NETPRTY, NPMSPEED, PUTAUT, QMID, QMTYPE, RCVEXIT, RCVUSRDATA, SCYEXIT, SCYUSRDATA, SEQNUMWRAP, SHORTRTY, SHORTTMR, SNDEXIT, SNDUSRDATA, SSLCAUTH, SSLCIPH, SSLPEER, STATCHL, STATUS, SUSPEND, TEXT, TRPTYPE, USERID , XMITQ
	Element 2: Filter operator	GT, LT, EQ, NE, GE, LE, LK, NL, CT, EX, CTG, EXG
	Element 3: Filter value	Character value

Cluster Queue Manager name (CLUSQMGR)

Specifies the name or names of the cluster queue manager definitions.

*ALL: All cluster queue manager definitions are selected.
generic-cluster-queue-manager-name: Specify the generic name of the MQ cluster queue manager definitions. A generic name is a character string followed by an asterisk (*)> For example ABC*, it selects all cluster queue manager definitions having names that start with the character string. You are recommended to specify the name required within quotation marks. Using this format ensures that your selection is precisely what you entered. You cannot select all the uppercase and lowercase versions of a generic name on a single panel, without requesting all the names.
cluster-queue-manager-name: Specify the name of the MQ cluster queue manager definition.

Message Queue Manager name (MQMNAME)

Specifies the name of the queue manager.

*DFT: Use the default queue manager.
queue-manager-name: Specify the name of the queue manager.

Filter command (WHERE)

This parameter can be used to selectively display only those cluster queue managers with particular attributes.

The parameter takes three arguments, a keyword, an operator and a value.

Generic strings are allowed for values which are names.

The operator can take one of the following values:

*GT: Greater than.
Applicable to integer and non-generic string values.
*LT: Less than.
Applicable to integer and non-generic string values
*EQ: Equal to.
Applicable to integer and non-generic string values.
*NE: Not equal to.
Applicable to integer and non-generic string values.
*GE: Greater than or equal to.
Applicable to integer and non-generic string values.
*LE: Less than or equal to.
Applicable to integer and non-generic string values.
*LK: Like.
Applicable to generic string values.
*NL: Not like.
Applicable to generic string values.
*CT: Contains.
Applicable to non-generic list values.
*EX: Excludes.
Applicable to non-generic list values.
*CTG: Contains generic.
Applicable to generic list values.
*EXG: Excludes generic.
Applicable to generic list values.

The keyword can take one of the following values:

*ALTDATE

The date on which the definition or information was last altered.

The filter value is the data in the form yyyy-mm-dd.

*ALTTIME

The time at which the definition or information was last altered.

The filter value is the time in the form hh:mm:ss.

*BATCHHB

Batch heartbeat interval in milliseconds.

The filter value is the integer interval time.

*BATCHINT

Batch interval in milliseconds.

The filter value is the integer interval time.

*BATCHLIM

Batch data limit in kilobytes.

The limit of the amount of data that can be sent through a channel.

*BATCHSIZE

Batch size.

The filter value is the integer batch size.

*CHANNEL

The channel name of the cluster queue manager.

The filter value is the name of the channel.

*CLUSDATE

The date on which the definition became available to the local queue manager.

The filter value is the data in the form yyyy-mm-dd.

*CLUSQMGR

The cluster queue manager name.

The filter value is the name of the cluster queue manager.

*CLUSTER

The cluster to which the cluster queue manager belongs.

The filter value is the name of the cluster.

*CLUSTIME

The time at which the definition became available to the local queue manager.

The filter value is the time in the form hh:mm:ss.

*CLWLRANK

Cluster workload rank.

The filter value is the integer rank.

*CLWLPRTY

Cluster workload priority.

The filter value is the integer priority.

*CLWLWGHT

Cluster workload weight.

The filter value is the integer weight.

*COMPHDR

Header compression.

The filter value is one of the following:

*NONE: No header data compression is performed.
*SYSTEM: Header data compression is performed.

*COMPMSG

Message compression.

The filter value is one of the following:

*NONE: No message data compression is performed.
*RLE: Message data compression is performed using RLE.
*ZLIBHIGH: Message data compression is performed using ZLIB compression. A high level of compression is preferred.
*ZLIBFAST: Message data compression is performed using ZLIB compression. A fast compression time is preferred.
*LZ4FAST: Message data compression is performed using the LZ4 compression technique. A fast compression time is preferred.
*LZ4HIGH: Message data compression is performed using the LZ4 compression technique. A high level of compression is preferred.
*ANY: Any compression technique supported by the queue manager can be used.

*CONNAME

Remote connection name.

The filter value is the connection name string.

*CVTMSG

Whether the message should be converted before transmission.

The filter value is one of the following:

*YES: The application data in the message is converted before sending.
*NO: The application data in the message is not converted before sending.

*DFNTYPE

How the cluster channel was defined.

The filter value is one of the following:

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

*DSCITV

Disconnect interval in seconds.

The filter value is the integer interval time.

*HRTBTINTVL

Heartbeat interval in seconds.

The filter value is the integer interval time.

*KAINT

Keep alive interval in seconds.

The filter value is the integer interval time.

*LOCLADDR

Local connection name.

The filter value is the connection name string.

*LONGRTY

Long retry count.

The filter value is the integer count.

*LONGTMR

Long retry interval in seconds.

The filter value is the integer interval time.

*MAXMSGLEN

Maximum message length.

The filter value is the integer length.

*MCANAME

Message channel agent name.

The filter value is the agent name.

*MCATYPE

Whether the message channel agent program should run as a thread or process.

The filter value is one of the following:

*PROCESS: The message channel agent runs as a separate process.
*THREAD: The message channel agent runs as a separate thread.

*MCAUSRID

Message channel agent user identifier.

The filter value is the user identifier string.

*MONCHL

Channel Monitoring.

The filter value is one of the following:

*QMGR: The collection of Online Monitoring Data is inherited from the setting of the queue manager attribute MONCHL.
*OFF: Online Monitoring Data collection for this channel is disabled.
*LOW: Monitoring data collection is turned on with a low ratio of data collection.
*MEDIUM: Monitoring data collection is turned on with a moderate ratio of data collection.
*HIGH: Monitoring data collection is turned on with a high ratio of data collection.

*MSGEXIT

Message exit name.

The filter value is the exit name.

*MSGRTYDATA

Message retry exit user data.

The filter value is the user data string.

*MSGRTYEXIT

Message retry exit name.

The filter value is the exit name.

*MSGRTYITV

Message retry interval interval in seconds.

The filter value is the integer interval time.

*MSGRTYNBR

Number of message retries.

The filter value is the integer number of retries.

*MSGUSRDATA

Message exit user data.

The filter value is the user data string.

*NETPRTY

Network connection priority in the range 0 through 9.

The filter value is the integer priority value.

*NPMSPEED

Whether the channel supports fast non persistent messages.

The filter value is one of the following:

*FAST: The channel supports fast non persistent messages.
*NORMAL: The channel does not support fast non persistent messages.

*PUTAUT

Whether the user identifier in the context information should be used.

The filter value is one of the following:

*DFT: No authority check is made before the message is put on the destination queue.
*CTX: The user identifier in the message context information is used to establish authority to put the message.

*QMID

The internally generated unique name of the cluster queue manager.

The filter value is the unique name.

*QMTYPE

The function of the cluster queue manager in the cluster.

The filter value is one of the following:

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

*RCVEXIT

Receive exit name.

The filter value is the exit name.

*RCVUSRDATA

Receive exit user data.

The filter value is the user data string.

*SCYEXIT

Security exit name.

The filter value is the exit name.

*SCYUSRDATA

Security exit user data.

The filter value is the user data string.

*SEQNUMWRAP

Maximum message sequence number.

The filter value is the integer sequence number.

*SHORTRTY

Short retry count.

The filter value is the integer count.

*SHORTTMR

short retry interval in seconds.

The filter value is the integer interval time.

*SNDEXIT

Send exit name.

The filter value is the exit name.

*SNDUSRDATA

Send exit user data.

The filter value is the user data string.

*SSLCAUTH

Whether the channel should carry out client authentication over TLS.

The filter value is one of the following:

*REQUIRED: Client authentication is required.
*OPTIONAL: Client authentication is optional.

*SSLCIPH

The CipherSpec using in TLS channel negotiation.

The filter value is the name of the CipherSpec.

*SSLPEER

The X500 peer name used in TLS channel negotiation.

The filter value is the peer name.

*STATCHL

Channel Statistics.

The filter value is one of the following:

*QMGR: The collection of statistics data is inherited from the setting of the queue manager attribute STATCHL.
*OFF: Statistics data collection for this channel is disabled.
*LOW: Statistics data collection is turned on with a low ratio of data collection.
*MEDIUM: Statistics data collection is turned on with a moderate ratio of data collection.
*HIGH: Statistics data collection is turned on with a high ratio of data collection.

*STATUS

The current status of the channel for this cluster queue manager.

The filter value is one of the following:

*STARTING: The channel is waiting to become active.
*BINDING: The channel is performing channel negotiation.
*INACTIVE: The channel is not active.
*INITIALIZING: The channel initiator is attempting to start a channel.
*RUNNING: The channel is either transferring messages, or is waiting for messages to arrive on the transmission queue.
*STOPPING: The channel is stopping, or a close request has been received.
*RETRYING: A previous attempt to establish a connection has failed. The MCA will reattempt connection after the specified time interval.
*PAUSED: The channel is waiting for the message-retry interval to complete before retrying an MQPUT operation.
*STOPPED: The channel has either been manually stopped, or the retry limit has been reached.
*REQUESTING: A local requester channel is requesting services from a remote MCA.

*SUSPEND

Whether this cluster queue manager is suspended from the cluster or not.

The filter value is either *NO or *YES.

*TEXT

Descriptive comment.

The filter value is the text description of the channel.

*TMQNAME

Transmission queue name.

The filter value is the name of the queue.

*USERID

Task user identifier.

The filter value is the user identifier string.

*XMITQ

Name of cluster transmission queue.

The filter value is the transmission queue name string.