Home
Parameter descriptions
You must specify the name of the channel for which you want to display status information. This can be a specific channel name or a generic channel name. By using a generic channel name, we can display either:
- Status information for all channels, or
- Status information for one or more channels that match the specified name.
We can also specify whether you want:
Status for all channels that meet the selection criteria is given, whether the channels were defined manually or automatically.
There are three classes of data available for channel status. These are saved, current, and (on z/OS only) short.
The status fields available for saved data are a subset of the fields available for current data and are called common status fields. Note that although the common data fields are the same, the data values might be different for saved and current status. The rest of the fields available for current data are called current-only status fields.
- Saved data consists of the common status fields noted in the syntax diagram. This data is reset at the following times:
- For all channels:
- When the channel enters or leaves STOPPED or RETRY state
- On AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, and Windows, when the queue manager is ended
- For a sending channel:
- Before requesting confirmation that a batch of messages has been received
- When confirmation has been received
- For a receiving channel:
- Just before confirming that a batch of messages has been received
- For a server connection channel:
- No data is saved
Therefore, a channel that has never been current cannot have any saved status.
Status is not saved until a persistent message is transmitted across a channel, or a nonpersistent message is transmitted with a NPMSPEED of NORMAL. Because status is saved at the end of each batch, a channel does not have any saved status until at least one batch has been transmitted.
- Current data consists of the common status fields and current-only status fields as noted in the syntax diagram. The data fields are continually updated as messages are sent/received.
- Short data consists of the STATUS current data item and the short status field as noted in the syntax diagram.
This method of operation has the following consequences:
- An inactive channel might not have any saved status – if it has never been current or has not yet reached a point where saved status is reset.
- The "common" data fields might have different values for saved and current status.
- A current channel always has current status and might have saved status.
On Compaq NonStop Kernel, channel status is updated only at the boundaries of batch processing. Channel status information is not updated for every message transfer because of the potential impact on the performance of channels. This means that the common status data values are identical for both the current and saved sets.
Channels can be current or inactive:
- Current channels
- These are channels that have been started, or on which a client has connected, and that have not finished or disconnected normally. They might not yet have reached the point of transferring messages, or data, or even of establishing contact with the partner. Current channels have current status and might also have saved status.
The term Active is used to describe the set of current channels that are not stopped.
- Inactive channels
- These are channels that either:
- Have not been started
- On which a client has not connected
- Have finished
- Have disconnected normally
(Note that if a channel is stopped, it is not yet considered to have finished normally – and is, therefore, still current.) Inactive channels have either saved status or no status at all.
There can be more than one instance of the same named receiver, requester, cluster-receiver, or server-connection channel current at the same time (the requester is acting as a receiver). This occurs if several senders, at different queue managers, each initiate a session with this receiver, using the same channel name. For channels of other types, there can only be one instance current at any time.
For all channel types, however, there can be more than one set of saved status information available for a given channel name. At most one of these sets relates to a current instance of the channel, the rest relate to previously-current instances. Multiple instances arise if different transmission queue names or connection names have been used in connection with the same channel. This can happen in the following cases:
- At a sender or server:
- If the same channel has been connected to by different requesters (servers only)
- If the transmission queue name has been changed in the definition
- If the connection name has been changed in the definition
- At a receiver or requester:
- If the same channel has been connected to by different senders or servers
- If the connection name has been changed in the definition (for requester channels initiating connection)
The number of sets that are displayed for a given channel can be limited by using the XMITQ, CONNAME, and CURRENT parameters on the command.
- (generic-channel-name)
- The name of the channel definition for which status information is to be displayed. A trailing asterisk (*) matches all channel definitions with the specified stem followed by zero or more characters. An asterisk (*) on its own specifies all channel definitions.
- WHERE
- Specify a filter condition to display status information for those 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
- The parameter to be used to display attributes for this DISPLAY command. However, we cannot use the following parameters as filter keywords: CHLDISP, CMDSCOPE, COMPRATE, COMPTIME, CURRENT, EXITTIME, JOBNAME (on z/OS), MCASTAT (on z/OS), MONITOR, NETTIME, SAVED, SHORT, XBATCHSZ, or XQTIME as filter keywords.
You cannot use CONNAME or XMITQ as filter keywords if you also use them to select channel status.
Status information for channels of a type for which the filter keyword is not valid is not displayed.
- operator
- This is used to determine whether a channel satisfies the filter value on the given filter keyword. 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 this 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 this to display objects the attributes of which do not contain the specified item.
- filter-value
- The value that the attribute value must be tested against using the operator. Depending on the filter-keyword, this can be:
- An explicit value, that is a valid value for the attribute being tested.
You can use operators LT, GT, EQ, NE, LE or GE only. However, if the attribute value is one from a possible set of values on a parameter (for example, the value SDR on the CHLTYPE parameter), we can only use EQ or NE.
- A generic value. This is a character string with an asterisk at the end, for example 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.
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. 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.
- ALL
- Specify this to display all the status information for each relevant instance.
If SAVED is specified, this causes only common status information to be displayed, not current-only status information.
If this parameter is specified, any parameters requesting specific status information that are also specified have no effect; all the information is displayed.
- CHLDISP
- This parameter applies to z/OS only and specifies the disposition of the channels for which information is to be displayed, as used in the START and STOP CHANNEL commands, and not that set by QSGDISP for the channel definition. Values are:
- ALL
- This is the default value and displays requested status information for private channels.
If there is a shared queue manager environment and the command is being executed on the queue manager where it was issued, or if CURRENT is specified, this option also displays the requested status information for shared channels.
- PRIVATE
- Display requested status information for private channels.
- SHARED
- Display requested status information for shared channels. This is allowed only if there is a shared queue manager environment, and either:
- CMDSCOPE is blank or the local queue manager
- CURRENT is specified
CHLDISP displays the following values:
- PRIVATE
- The status is for a private channel.
- SHARED
- The status is for a shared channel.
- FIXSHARED
- The status is for a shared channel, tied to a specific queue manager.
- CMDSCOPE
- This parameter applies to z/OS only and specifies how the command is executed when the queue manager is a member of a queue-sharing group.
- ‘ ’
- The command is executed on the queue manager on which it was entered. This is the default value.
- qmgr-name
- The command is executed 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 it was entered, only if you are using a queue-sharing group environment and if the command server is enabled.
- *
- The command is executed on the local queue manager and is also passed to every active queue manager in the queue-sharing group. The effect of this is the same as entering the command on every queue manager in the queue-sharing group.
We cannot use CMDSCOPE as a filter keyword.
See Table 1, Table 2, and Table 3 for the permitted combinations of CHLDISP and CMDSCOPE.
- CONNAME(connection-name)
- The connection name for which status information is to be displayed, for the specified channel or channels.
This parameter can be used to limit the number of sets of status information that is displayed. If it is not specified, the display is not limited in this way.
The value returned for CONNAME might not be the same as in the channel definition, and might differ between the current channel status and the saved channel status. (Using CONNAME for limiting the number of sets of status is therefore not recommended.)
For example, when using TCP, if CONNAME in the channel definition :
- Is blank or is in "host name" format, the channel status value has the resolved IP address.
- Includes the port number, the current channel status value includes the port number (except on z/OS), but the saved channel status value does not.
For SAVED or SHORT status, this value could also be the queue manager name, or queue-sharing group name, of the remote system.
- CURRENT
- This is the default, and indicates that current status information as held by the channel initiator for current channels only is to be displayed.
Both common and current-only status information can be requested for current channels.
Short status information is not displayed if this parameter is specified.
- SAVED
- Specify this to display saved status information for both current and inactive channels.
Only common status information can be displayed. Short and current-only status information is not displayed for current channels if this parameter is specified.
- SHORT
- This indicates that short status information and the STATUS item for current channels only is to be displayed.
Other common status and current-only status information is not displayed for current channels if this parameter is specified.
- MONITOR
- Specify this to return the set of online monitoring parameters. These are COMPRATE, COMPTIME, EXITTIME, MONCHL, NETTIME, XBATCHSZ, XQMSGSA, and XQTIME. If you specify this parameter, any of the monitoring parameters that you request specifically have no effect; all monitoring parameters are still displayed.
- XMITQ(q-name)
- The name of the transmission queue for which status information is to be displayed, for the specified channel or channels.
This parameter can be used to limit the number of sets of status information that is displayed. If it is not specified, the display is not limited in this way.
The following information is always returned, for each set of status information:
- The channel name
- The transmission queue name (for sender and server channels)
- The connection name
- The remote queue-manager, or queue-sharing group, name (only for current status, and for all channel types except server-connection channels )
- The remote partner application name (for server-connection channels)
- The type of status information returned (CURRENT, SAVED, or on z/OS only, SHORT)
- STATUS (except SAVED on z/OS)
- On z/OS, CHLDISP
- STOPREQ (only for current status)
- SUBSTATE
If no parameters requesting specific status information are specified (and the ALL parameter is not specified), no further information is returned.
If status information is requested that is not relevant for the particular channel type, this is not an error.
Parent topic:
DISPLAY CHSTATUS
sc11840_
Home