DISPLAY CHANNEL

Use the MQSC command DISPLAY CHANNEL to display a channel definition.

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 2CR. For an explanation of the source symbols, see Sources from which we can issue MQSC commands on z/OS .

Syntax diagram
Usage notes
Parameter descriptions for DISPLAY CHANNEL
Requested parameters

Synonym: DIS CHL

DISPLAY CHANNEL

Requested attrs

Notes:

¹ Valid only on z/OS when the queue manager is a member of a queue sharing group.
² Not valid for z/OS client-connection channels.
³ Valid only on z/OS.
⁴ Valid only for RCVR, RQSTR, CLUSRCVR and (for z/OS only) SVRCONN channel types.
⁵ Not valid on z/OS.

Usage notes

We can only display cluster-sender channels if they were created manually. See Cluster channels.

The values shown describe the current definition of the channel. If the channel has been altered since it was started, any currently running instance of the channel object might not have the same values as the current definition.

Parameter descriptions for DISPLAY CHANNEL

We must specify the name of the channel definition we want to display. It can be a specific channel name or a generic channel name. By using a generic channel name, we can display either:

All channel definitions
One or more channel definitions that match the specified name

(generic-channel-name)

The name of the channel definition to be displayed (see Rules for naming IBM MQ objects ). 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 only 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

Almost any parameter that can be used to display attributes for this DISPLAY command. However, we cannot use the CMDSCOPE, QSGDISP, or MCANAME parameters as filter keywords. We cannot use TYPE (or CHLTYPE) if it is also used to select channels. Channels of a type for which the filter keyword is not a valid attribute are 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.
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 this 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 this 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, this 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. However, if the attribute value is one from a possible set of values on a parameter (for example, the value SDR on the TYPE parameter), we can only use EQ or NE.
A generic value. This is a character string (such as the character string you supply for the DESCR parameter) with an asterisk at the end, for example ABC*. The characters must be valid for the attribute we are testing. 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 the results of querying all the parameters. If ALL is specified, any request for a specific parameter is ignored. The result of querying with ALL is to return the results for all of the possible parameters.

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

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

If no parameters are specified (and the ALL parameter is not specified or defaulted), the default is that the channel names only are displayed.

On z/OS, the CHLTYPE and QSGDISP values are also displayed.

CMDSCOPE

This parameter 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 the command was entered, only if we 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.

QSGDISP

Specifies the disposition of the objects for which information is to be displayed. Values are:

LIVE

This is the default value and displays information for objects defined with QSGDISP(QMGR) or QSGDISP(COPY).

ALL

Displays information for objects defined with QSGDISP(QMGR) or QSGDISP(COPY).

If there is a shared queue manager environment, and the command is being executed on the queue manager where it was issued, this option also displays information for objects defined with QSGDISP(GROUP).

If QSGDISP(ALL) is specified in a shared queue manager environment, the command might give duplicated names (with different dispositions). Note: In the QSGDISP(LIVE) case, this occurs only where a shared and a non-shared queue have the same name; such a situation should not occur in a well-managed system. In a shared queue manager environment, use

DISPLAY CHANNEL(name) CMDSCOPE(*) QSGDISP(ALL)

to list ALL objects matching

name

in the queue sharing group without duplicating those in the shared repository.

COPY

Display information only for objects defined with QSGDISP(COPY).

GROUP

Display information only for objects defined with QSGDISP(GROUP). This is allowed only if there is a shared queue manager environment.

PRIVATE

Display information only for objects defined with QSGDISP(QMGR) or QSGDISP(COPY). Note that QSGDISP(PRIVATE) displays the same information as QSGDISP(LIVE).

QMGR

Display information only for objects defined with QSGDISP(QMGR).

QSGDISP displays one of the following values:

QMGR: The object was defined with QSGDISP(QMGR).
GROUP: The object was defined with QSGDISP(GROUP).
COPY: The object was defined with QSGDISP(COPY).

We cannot use QSGDISP as a filter keyword.

TYPE

This is optional. It can be used to restrict the display to channels of one type. The value is one of the following:

ALL: Channels of all types are displayed (this is the default).
SDR: Sender channels only are displayed.
SVR: Server channels only are displayed.
RCVR: Receiver channels only are displayed.
RQSTR: Requester channels only are displayed.
CLNTCONN: Client-connection channels only are displayed.
SVRCONN: Server-connection channels only are displayed.
CLUSSDR: Cluster-sender channels only are displayed. ).
CLUSRCVR: Cluster-receiver channels only are displayed. ).
AMQP: AMQP channels only are displayed.

CHLTYPE( type ) can be used as a synonym for this parameter. ,

Requested parameters

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

Some parameters are relevant only for channels of a particular type or types. Attributes that are not relevant for a particular type of channel cause no output, nor is an error raised. The following table shows the parameters that are relevant for each type of channel. There is a description of each parameter after the table. Parameters are optional unless the description states that they are required.

Parameter	SDR	SVR	RCVR	RQSTR	CLNT- CONN	SVR- CONN	CLUS- SDR	CLUS- RCVR	AMQP
AFFINITY
ALTDATE
ALTTIME
AMQPKA
AUTOSTART
BATCHHB
BATCHINT
BATCHLIM
BATCHSZ
CERTLABL
channel-name
CHLTYPE
CLNTWGHT
CLUSNL
CLUSTER
CLWLPRTY
CLWLRANK
CLWLWGHT
COMPHDR
COMPMSG
CONNAME
CONVERT
DEFCDISP
DEFRECON
DESCR
DISCINT
HBINT
KAINT
LOCLADDR
LONGRTY
LONGTMR
MAXINST
MAXINSTC
MAXMSGL
MCANAME
MCATYPE
MCAUSER
MODENAME
MONCHL
MRDATA
MREXIT
MRRTY
MRTMR
MSGDATA
MSGEXIT
NETPRTY
NPMSPEED
PASSWORD
PORT
PROPCTL
PUTAUT						¹
QMNAME
RESETSEQ
RCVDATA
RCVEXIT
SCYDATA
SCYEXIT
SENDDATA
SENDEXIT
SEQWRAP
SHARECNV
SHORTRTY
SHORTTMR
SPLPROT
SSLCAUTH
SSLCIPH
SSLPEER
STATCHL
TPNAME
TPROOT
TRPTYPE
USECLTID
USEDLQ
USERID
XMITQ

Note:

PUTAUT is valid for a channel type of SVRCONN on z/OS only.

AFFINITY

The channel affinity attribute.

PREFERRED: Subsequent connections in a process attempt to use the same channel definition as the first connection.
NONE: All connections in a process select an applicable definition based on the weighting with any applicable CLNTWGHT(0) definitions selected first in alphabetical order.

ALTDATE

The date on which the definition was last altered, in the form yyyy-mm-dd.

ALTTIME

The time at which the definition was last altered, in the form hh.mm.ss.

AMQPKA

The keep alive time for an AMQP channel in milliseconds.

AUTOSTART

Whether an LU 6.2 responder process should be started for the channel.

BATCHHB

The batch heartbeating 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.

CERTLABL

Certificate label.

CHLTYPE

Channel type.

The channel type is always displayed if we specify a generic channel name and do not request any other parameters. On z/OS, the channel type is always displayed.

On Multiplatforms, TYPE can be used as a synonym for this parameter.

CLNTWGHT

The client channel weighting.

The special value 0 indicates that no random load balancing is performed and applicable definitions are selected in alphabetical order. If random load balancing is performed the value is in the range 1 - 99 where 1 is the lowest weighting and 99 is the highest.

CLUSTER

The name of the cluster to which the channel belongs.

CLUSNL

The name of the namelist that specifies the list of clusters to which the channel belongs.

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. For sender, server, cluster-sender, cluster-receiver, and client-connection channels, the values specified are in order of preference.

COMPMSG

The list of message data compression techniques supported by the channel. For sender, server, cluster-sender, cluster-receiver, and client-connection channels, the values specified are in order of preference.

CONNAME

Connection name.

CONVERT

Whether sender should convert application message data.

DEFCDISP

Specifies the default channel disposition of the channels for which information is to be returned. If this keyword is not present, channels of all default channel dispositions are eligible.

ALL: Channels of all default channel dispositions are displayed.
This is the default setting.
PRIVATE: Only channels where the default channel disposition is PRIVATE are displayed.
SHARED: Only channels where the default channel disposition is FIXSHARED or SHARED are displayed.

Note: This does not apply to client-connection channel types on z/OS.

DESCR

Default client reconnection option.

DESCR

Description.

DISCINT

Disconnection interval.

HBINT

Heartbeat interval.

KAINT

KeepAlive timing for the channel.

LOCLADDR

Local communications address for the channel.

LONGRTY

Long retry count.

LONGTMR

Long retry timer.

MAXINST( integer )

The maximum number of instances of a server-connection channel that are permitted to run simultaneously.

MAXINSTC( integer )

The maximum number of instances of a server-connection channel, started from a single client, that are permitted to run simultaneously. Note: In this context, connections originating from the same remote network address are regarded as coming from the same client.

MAXMSGL

Maximum message length for channel.

MCANAME

Message channel agent name.

We cannot use MCANAME as a filter keyword.

MCATYPE

Whether message channel agent runs as a separate process or a separate thread.

MCAUSER

Message channel agent user identifier.

MODENAME

LU 6.2 mode name.

MONCHL

Online monitoring data collection.

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, this is displayed as asterisks on all platforms except z/OS.

PORT

The port number used to connect an AMQP channel.

PROPCTL

Message property control.

Specifies what happens to properties of messages when the message is about to be sent to a V6 or prior queue manager (a queue manager that does not understand the concept of a property descriptor).

This parameter is applicable to Sender, Server, Cluster Sender, and Cluster Receiver channels.

This parameter is optional.

Permitted values are:

COMPAT

This is the default value.

Message properties	Result
The message contains a property with a prefix of mcd., jms., usr. or mqext.	All optional message properties (where the Support value is MQPD_SUPPORT_OPTIONAL), except those in the message descriptor or extension, are placed in one or more MQRFH2 headers in the message data before the message it sent to the remote queue manager.
The message does not contain a property with a prefix of mcd., jms., usr. or mqext.	All message properties, except those in the message descriptor or extension, are removed from the message before the message is sent to the remote queue manager.
The message contains a property where the Support field of the property descriptor is not set to MQPD_SUPPORT_OPTIONAL	The message is rejected with reason MQRC_UNSUPPORTED_PROPERTY and treated in accordance with its report options.
The message contains one or more properties where the Support field of the property descriptor is set to MQPD_SUPPORT_OPTIONAL but other fields of the property descriptor are set to non-default values	The properties with non-default values are removed from the message before the message is sent to the remote queue manager.
The MQRFH2 folder that would contain the message property needs to be assigned with the content='properties' attribute	The properties are removed to prevent MQRFH2 headers with unsupported syntax flowing to a V6 or prior queue manager.

NONE

All properties of the message, except those in the message descriptor or extension, are removed from the message before the message is sent to the remote queue manager.

If the message contains a property where the Support field of the property descriptor is not set to MQPD_SUPPORT_OPTIONAL then the message is rejected with reason MQRC_UNSUPPORTED_PROPERTY and treated in accordance with its report options.

ALL

All properties of the message are included with the message when it is sent to the remote queue manager. The properties, except those in the message descriptor (or extension), are placed in one or more MQRFH2 headers in the message data.

PUTAUT

Put authority.

QMNAME

Queue manager name.

RESETSEQ

Pending reset sequence number.

This is the sequence number from an outstanding request and it indicates a user RESET CHANNEL command request is outstanding.

A value of zero indicates that there is no outstanding RESET CHANNEL. The value can be in the range 1 - 999999999.

This parameter is not applicable on z/OS.

RCVDATA

Channel receive exit user data.

RCVEXIT

Channel receive exit names.

SCYDATA

Channel security exit user data.

SCYEXIT

Channel security exit names.

SENDDATA

Channel send exit user data.

SENDEXIT

Channel send exit names.

SEQWRAP

Sequence number wrap value.

SHARECNV

Sharing conversations value.

SHORTRTY

Specifies the maximum number of times that the channel is to try allocating a session to its partner.

SHORTTMR

Short retry timer.

SPLPROT

SPLPROT (Security Policy Protection) specifies how a server-to-server Message Channel Agent should deal with message protection when AMS is active and an applicable policy exists.

SSLCAUTH

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.

STATCHL

Statistics data collection.

TPNAME

LU 6.2 transaction program name.

TPROOT

The topic root for an AMQP channel.

TRPTYPE

Transport type.

USECLTID

Specifies that the client ID should be used for authorization checks for an AMQP channel, instead of the MCAUSER attribute value.

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.

XMITQ

Transmission queue name.

For more details of these parameters, see DEFINE CHANNEL. Parent topic: MQSC commands