Inquire Channel (Response)

The response to the Inquire Channel (MQCMD_INQUIRE_CHANNEL) command consists of the response header followed by the ChannelName and ChannelType structures (and on z/OS only, the DefaultChannelDisposition, and QSGDisposition structure), and the requested combination of attribute parameter structures (where applicable).

If a generic channel name was specified, one such message is generated for each channel found.

Always returned:

ChannelName , ChannelType , DefaultChannelDisposition , QSGDisposition

Returned if requested:

AlterationDate, AlterationTime, BatchDataLimit, BatchHeartbeat, BatchInterval, BatchSize, Certificatelabel, ChannelDesc, ChannelMonitoring, ChannelStatistics, ClientChannelWeight, ClientIdentifier, ClusterName, ClusterNamelist, CLWLChannelPriority, CLWLChannelRank, CLWLChannelWeight, ConnectionAffinity, ConnectionName, DataConversion, DefReconnect, DiscInterval, HeaderCompression, HeartbeatInterval, InDoubtInbound, InDoubtOutbound, KeepAliveInterval, LastMsgTime, LocalAddress, LongRetryCount, LongRetryInterval, MaxMsgLength, MCAName, MCAType, MCAUserIdentifier, MessageCompression, ModeName, MsgExit, MsgRetryCount, MsgRetryExit, MsgRetryInterval, MsgRetryUserData, MsgsReceived, MsgsSent, MsgUserData, NetworkPriority, NonPersistentMsgSpeed, Password, PendingOutbound, PropertyControl, PutAuthority, QMgrName, ReceiveExit, ReceiveUserData, ResetSeq, SecurityExit, SecurityUserData, SendExit, SendUserData, SeqNumberWrap, SharingConversations, ShortRetryCount, ShortRetryInterval, SPLProtection, SSLCipherSpec, SSLCipherSuite, SSLClientAuth, SSLPeerName, TpName, TransportType, UseDLQ, UserIdentifier, XmitQName

Response data

AlterationDate (MQCFST)

Alteration date, in the form yyyy-mm-dd (parameter identifier: MQCA_ALTERATION_DATE).

The date when the information was last altered.

AlterationTime (MQCFST)

Alteration time, in the form hh.mm.ss (parameter identifier: MQCA_ALTERATION_TIME).

The time when the information was last altered.

BatchDataLimit (MQCFIN)

Batch data limit (parameter identifier: MQIACH_BATCH_DATA_LIMIT).

The limit, in kilobytes, of the amount of data that can be sent through a channel before taking a sync point. A sync point is taken after the message that caused the limit to be reached has flowed across the channel. A value of zero in this attribute means that no data limit is applied to batches over this channel.

This parameter only applies to channels with a ChannelType of MQCHT_SENDER, MQCHT_SERVER, MQCHT_CLUSRCVR, or MQCHT_CLUSSDR.

BatchHeartbeat (MQCFIN)

The value being used for the batch heartbeating (parameter identifier: MQIACH_BATCH_HB).

The value can be 0 - 999999. A value of 0 indicates that heartbeating is not in use.

BatchInterval (MQCFIN)

Batch interval (parameter identifier: MQIACH_BATCH_INTERVAL).

BatchSize (MQCFIN)

Batch size (parameter identifier: MQIACH_BATCH_SIZE).

Certificatelabel (MQCFST)

Certificate label (parameter identifier: MQCA_CERT_LABEL).

Specifies the certificate label in use.

The maximum length is MQ_CERT_LABEL_LENGTH.

ChannelDesc (MQCFST)

Channel description (parameter identifier: MQCACH_DESC).

The maximum length of the string is MQ_CHANNEL_DESC_LENGTH.

ChannelMonitoring (MQCFIN)

Online monitoring data collection (parameter identifier: MQIA_MONITORING_CHANNEL). The value can be any of the following values:

MQMON_OFF

Online monitoring data collection is turned off for this channel.

MQMON_Q_MGR

The value of the queue manager's ChannelMonitoring parameter is inherited by the channel.

MQMON_LOW

Online monitoring data collection is turned on, with a low rate of data collection, for this channel unless the queue manager's ChannelMonitoring parameter is MQMON_NONE.

MQMON_MEDIUM

Online monitoring data collection is turned on, with a moderate rate of data collection, for this channel unless the queue manager's ChannelMonitoring parameter is MQMON_NONE.

MQMON_HIGH

Online monitoring data collection is turned on, with a high rate of data collection, for this channel unless the queue manager's ChannelMonitoring parameter is MQMON_NONE.

ChannelName (MQCFST)

Channel name (parameter identifier: MQCACH_CHANNEL_NAME).

The maximum length of the string is MQ_CHANNEL_NAME_LENGTH.

ChannelStatistics (MQCFIN)

Statistics data collection (parameter identifier: MQIA_STATISTICS_CHANNEL). The value can be any of the following values:

MQMON_OFF

Statistics data collection is turned off for this channel.

MQMON_Q_MGR

The value of the queue manager's ChannelStatistics parameter is inherited by the channel.

MQMON_LOW

Statistics data collection is turned on, with a low rate of data collection, for this channel unless the queue manager's ChannelStatistics parameter is MQMON_NONE.

MQMON_MEDIUM

Statistics data collection is turned on, with a moderate rate of data collection, for this channel unless the queue manager's ChannelStatistics parameter is MQMON_NONE.

MQMON_HIGH

Statistics data collection is turned on, with a high rate of data collection, for this channel unless the queue manager's ChannelStatistics parameter is MQMON_NONE.

On z/OS systems, enabling this parameter simply turns on statistics data collection, regardless of the value you select. Specifying LOW, MEDIUM, or HIGH makes no difference to your results. This parameter must be enabled in order to collect channel accounting records.

ChannelType (MQCFIN)

Channel type (parameter identifier: MQIACH_CHANNEL_TYPE). The value can be any of the following values:

MQCHT_SENDER

Sender.

MQCHT_SERVER

Server.

MQCHT_RECEIVER

Receiver.

MQCHT_REQUESTER

Requester.

MQCHT_SVRCONN

Server-connection (for use by clients).

MQCHT_CLNTCONN

Client connection.

MQCHT_CLUSRCVR

Cluster-receiver.

MQCHT_CLUSSDR

Cluster-sender.

MQCHT_MQTT

Telemetry channel.

ClientChannelWeight (MQCFIN)

Client Channel Weight (parameter identifier: MQIACH_CLIENT_CHANNEL_WEIGHT).

The client channel weighting attribute is used so client channel definitions can be selected at random, with the larger weightings having a higher probability of selection, when more than one suitable definition is available.

The value can be 0 - 99. The default is 0.

This parameter is only valid for channels with a ChannelType of MQCHT_CLNTCONN

ClientIdentifier (MQCFST)

the clientId of the client (parameter identifier: MQCACH_CLIENT_ID).

ClusterName (MQCFST)

Cluster name (parameter identifier: MQCA_CLUSTER_NAME).

ClusterNamelist (MQCFST)

Cluster namelist (parameter identifier: MQCA_CLUSTER_NAMELIST).

CLWLChannelPriority (MQCFIN)

Channel priority (parameter identifier: MQIACH_CLWL_CHANNEL_PRIORITY).

CLWLChannelRank (MQCFIN)

Channel rank (parameter identifier: MQIACH_CLWL_CHANNEL_RANK).

CLWLChannelWeight (MQCFIN)

Channel weighting (parameter identifier: MQIACH_CLWL_CHANNEL_WEIGHT).

ConnectionAffinity (MQCFIN)

Channel Affinity (parameter identifier: MQIACH_CONNECTION_AFFINITY) The channel affinity attribute specifies whether client applications that connect multiple times using the same queue manager name, use the same client channel. The value can be any of the following values:

MQCAFTY_PREFERRED

The first connection in a process reading a client channel definition table (CCDT) creates a list of applicable definitions based on the weighting with any zero ClientChannelWeight definitions first in alphabetical order. Each connection in the process attempts to connect using the first definition in the list. If a connection is unsuccessful the next definition is used. Unsuccessful nonzero ClientChannelWeight definitions are moved to the end of the list. Zero ClientChannelWeight definitions remain at the start of the list and are selected first for each connection. For C, C++ and .NET (including fully managed .NET) clients the list is updated if the CCDT has been modified since the list was created. Each client process with the same host name creates the same list.

MQCAFTY_PREFERRED is the default, and has the value of 1.

MQCAFTY_NONE

The first connection in a process reading a CCDT creates a list of applicable definitions. All connections in a process independently select an applicable definition based on the weighting with any applicable zero ClientChannelWeight definitions selected first in alphabetical order. For C, C++ and .NET (including fully managed .NET) clients the list is updated if the CCDT has been modified since the list was created.

This parameter is only valid for channels with a ChannelType of MQCHT_CLNTCONN.

ConnectionName (MQCFST)

Connection name (parameter identifier: MQCACH_CONNECTION_NAME).

The maximum length of the string is MQ_CONN_NAME_LENGTH. On z/OS, it is MQ_LOCAL_ADDRESS_LENGTH.

The ConnectionName is a comma-separated list.

DataConversion (MQCFIN)

Whether sender must convert application data (parameter identifier: MQIACH_DATA_CONVERSION). The value can be:

MQCDC_NO_SENDER_CONVERSION

No conversion by sender.

MQCDC_SENDER_CONVERSION

Conversion by sender.

DefaultChannelDisposition (MQCFIN)

Default channel disposition (parameter identifier: MQIACH_DEF_CHANNEL_DISP).

This parameter applies to z/OS only.

Specifies the intended disposition of the channel when active. The value can be any of the following values:

MQCHLD_PRIVATE

The intended use of the object is as a private channel.

MQCHLD_FIXSHARED

The intended use of the object is as a shared channel linked to a specific queue manager.

MQCHLD_SHARED

The intended use of the object is as a shared channel.

DiscInterval (MQCFIN)

Disconnection interval (parameter identifier: MQIACH_DISC_INTERVAL).

DefReconnect (MQCFIN)

Client channel default reconnection option (parameter identifier: MQIACH_DEF_RECONNECT).

The returned values can be:

MQRCN_NO

MQRCN_NO is the default value.

Unless overridden by MQCONNX, the client is not reconnected automatically.

MQRCN_YES

Unless overridden by MQCONNX, the client reconnects automatically.

MQRCN_Q_MGR

Unless overridden by MQCONNX, the client reconnects automatically, but only to the same queue manager. The QMGR option has the same effect as MQCNO_RECONNECT_Q_MGR.

MQRCN_DISABLED

Reconnection is disabled, even if requested by the client program using the MQCONNX MQI call.

HeaderCompression (MQCFIL)

Header data compression techniques supported by the channel (parameter identifier: MQIACH_HDR_COMPRESSION). For sender, server, cluster-sender, cluster-receiver, and client-connection channels, the values specified are in order of preference.

The value can be one, or more, of

MQCOMPRESS_NONE

No header data compression is performed.

MQCOMPRESS_SYSTEM

Header data compression is performed.

HeartbeatInterval (MQCFIN)

Heartbeat interval (parameter identifier: MQIACH_HB_INTERVAL).

InDoubtInbound (MQCFIN)

Number of inbound messages to the client that are in doubt (Parameter identifier: MQIACH_IN_DOUBT_IN).

InDoubtOutbound (MQCFIN)

Number of outbound messages from the client that are in doubt (Parameter identifier: MQIACH_IN_DOUBT_OUT).

KeepAliveInterval (MQCFIN)

KeepAlive interval (parameter identifier: MQIACH_KEEP_ALIVE_INTERVAL).

LastMsgTime (MQCFST)

The time that the last message was sent or received (parameter identifier: MQCACH_LAST_MSG_TIME).

The maximum length of the string is MQ_TIME_LENGTH.

LocalAddress (MQCFST)

Local communications address for the channel (parameter identifier: MQCACH_LOCAL_ADDRESS).

The maximum length of the string is MQ_LOCAL_ADDRESS_LENGTH.

LongRetryCount (MQCFIN)

Long retry count (parameter identifier: MQIACH_LONG_RETRY).

LongRetryInterval (MQCFIN)

Long timer (parameter identifier: MQIACH_LONG_TIMER).

MaxInstances (MQCFIN)

Maximum number of simultaneous instances of a server-connection channel (parameter identifier: MQIACH_MAX_INSTANCES).

This parameter is returned only for server-connection channels in response to an Inquire Channel call with ChannelAttrs including MQIACF_ALL or MQIACH_MAX_INSTANCES.

MaxInstancesPerClient (MQCFIN)

Maximum number of simultaneous instances of a server-connection channel that can be started from a single client (parameter identifier: MQIACH_MAX_INSTS_PER_CLIENT).

This parameter is returned only for server-connection channels in response to an Inquire Channel call with ChannelAttrs including MQIACF_ALL or MQIACH_MAX_INSTS_PER_CLIENT.

MaxMsgLength (MQCFIN)

Maximum message length (parameter identifier: MQIACH_MAX_MSG_LENGTH).

MCAName (MQCFST)

Message channel agent name (parameter identifier: MQCACH_MCA_NAME).

The maximum length of the string is MQ_MCA_NAME_LENGTH.

MCAType (MQCFIN)

Message channel agent type (parameter identifier: MQIACH_MCA_TYPE). The value can be any of the following values:

MQMCAT_PROCESS

Process.

MQMCAT_THREAD

Thread ( Windows only).

MCAUserIdentifier (MQCFST)

Message channel agent user identifier (parameter identifier: MQCACH_MCA_USER_ID). Note: An alternative way of providing a user ID for a channel to run under is to use channel authentication records. With channel authentication records, different connections can use the same channel while using different credentials. If both MCAUSER on the channel is set and channel authentication records are used to apply to the same channel, the channel authentication records take precedence. The MCAUSER on the channel definition is only used if the channel authentication record uses USERSRC(CHANNEL). For more details, see Channel authentication records

The maximum length of the MCA user identifier depends on the environment in which the MCA is running. MQ_MCA_USER_ID_LENGTH gives the maximum length for the environment for which your application is running. MQ_MAX_MCA_USER_ID_LENGTH gives the maximum for all supported environments.

On Windows, the user identifier might be qualified with the domain name in the following format:

user@domain

MessageCompression (MQCFIL)

Message data compression techniques supported by the channel (parameter identifier: MQIACH_MSG_COMPRESSION). For sender, server, cluster-sender, cluster-receiver, and client-connection channels, the values specified are in order of preference.

The value can be one, or more, of:

MQCOMPRESS_NONE

No message data compression is performed.

MQCOMPRESS_RLE

Message data compression is performed using run-length encoding.

MQCOMPRESS_ZLIBFAST

Message data compression is performed using ZLIB encoding with speed prioritized.

MQCOMPRESS_ZLIBHIGH

Message data compression is performed using ZLIB encoding with compression prioritized.

MQCOMPRESS_ANY

Any compression technique supported by the queue manager can be used. MQCOMPRESS_ANY is only valid for receiver, requester, and server-connection channels.

ModeName (MQCFST)

Mode name (parameter identifier: MQCACH_MODE_NAME).

The maximum length of the string is MQ_MODE_NAME_LENGTH.

MsgExit (MQCFST)

Message exit name (parameter identifier: MQCACH_MSG_EXIT_NAME).

The maximum length of the exit name depends on the environment in which the exit is running. MQ_EXIT_NAME_LENGTH gives the maximum length for the environment in which the application is running. MQ_MAX_EXIT_NAME_LENGTH gives the maximum for all supported environments.

On Multiplatforms, if more than one message exit has been defined for the channel, the list of names is returned in an MQCFSL structure instead of an MQCFST structure.

On z/OS, an MQCFSL structure is always used.

MsgsReceived (MQCFIN64)

The number of messages received by the client since it last connected (parameter identifier: MQIACH_MSGS_RECEIVED / MQIACH_MSGS_RCVD).

MsgRetryCount (MQCFIN)

Message retry count (parameter identifier: MQIACH_MR_COUNT).

MsgRetryExit (MQCFST)

Message retry exit name (parameter identifier: MQCACH_MR_EXIT_NAME).

The maximum length of the exit name depends on the environment in which the exit is running. MQ_EXIT_NAME_LENGTH gives the maximum length for the environment in which the application is running. MQ_MAX_EXIT_NAME_LENGTH gives the maximum for all supported environments.

MsgRetryInterval (MQCFIN)

Message retry interval (parameter identifier: MQIACH_MR_INTERVAL).

MsgRetryUserData (MQCFST)

Message retry exit user data (parameter identifier: MQCACH_MR_EXIT_USER_DATA).

The maximum length of the string is MQ_EXIT_DATA_LENGTH.

MsgsSent (MQCFIN64)

The number of messages sent by the client since it last connected (parameter identifier: MQIACH_MSGS_SENT).

MsgUserData (MQCFST)

Message exit user data (parameter identifier: MQCACH_MSG_EXIT_USER_DATA).

The maximum length of the string is MQ_EXIT_DATA_LENGTH.

On Multiplatforms, if more than one message exit has been defined for the channel, the list of names is returned in an MQCFSL structure instead of an MQCFST structure.

On z/OS, an MQCFSL structure is always used.

NetworkPriority (MQCFIN)

Network priority (parameter identifier: MQIACH_NETWORK_PRIORITY).

NonPersistentMsgSpeed (MQCFIN)

Speed at which non-persistent messages are to be sent (parameter identifier: MQIACH_NPM_SPEED). The value can be:

MQNPMS_NORMAL

Normal speed.

MQNPMS_FAST

Fast speed.

Password (MQCFST)

Password (parameter identifier: MQCACH_PASSWORD).

If a nonblank password is defined, it is returned as asterisks. Otherwise, it is returned as blanks.

The maximum length of the string is MQ_PASSWORD_LENGTH. However, only the first 10 characters are used.

PropertyControl (MQCFIN)

Property control attribute (parameter identifier MQIA_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). The value can be any of the following values:

MQPROP_COMPATIBILITY

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

MQPROP_NONE

All properties of the message, except those properties 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.

MQPROP_ALL

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

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

PutAuthority (MQCFIN)

Put authority (parameter identifier: MQIACH_PUT_AUTHORITY). The value can be any of the following values:

MQPA_DEFAULT

Default user identifier is used.

MQPA_CONTEXT

Context user identifier is used.

QMgrName (MQCFST)

Queue manager name (parameter identifier: MQCA_Q_MGR_NAME).

The maximum length of the string is MQ_Q_MGR_NAME_LENGTH.

QSGDisposition (MQCFIN)

QSG disposition (parameter identifier: MQIA_QSG_DISP). Specifies the disposition of the object (that is, where it is defined and how it behaves). This parameter is valid only on z/OS. The value can be any of the following values:

MQQSGD_COPY

The object is defined as MQQSGD_COPY.

MQQSGD_GROUP

The object is defined as MQQSGD_GROUP.

MQQSGD_Q_MGR

The object is defined as MQQSGD_Q_MGR.

ReceiveExit (MQCFST)

Receive exit name (parameter identifier: MQCACH_RCV_EXIT_NAME).

The maximum length of the exit name depends on the environment in which the exit is running. MQ_EXIT_NAME_LENGTH gives the maximum length for the environment in which the application is running. MQ_MAX_EXIT_NAME_LENGTH gives the maximum for all supported environments.

On Multiplatforms, if more than one receive exit has been defined for the channel, the list of names is returned in an MQCFSL structure instead of an MQCFST structure.

On z/OS, an MQCFSL structure is always used.

ReceiveUserData (MQCFST)

Receive exit user data (parameter identifier: MQCACH_RCV_EXIT_USER_DATA).

The maximum length of the string is MQ_EXIT_DATA_LENGTH.

On Multiplatforms, if more than one receive exit user data string has been defined for the channel, the list of strings is returned in an MQCFSL structure instead of an MQCFST structure.

On z/OS, an MQCFSL structure is always used.

ResetSeq (MQCFIN)

Pending reset sequence number (parameter identifier: MQIACH_RESET_REQUESTED).

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.

Possible return values include MQCHRR_RESET_NOT_REQUESTED.

This parameter is not applicable on z/OS.

SecurityExit (MQCFST)

Security exit name (parameter identifier: MQCACH_SEC_EXIT_NAME).

The maximum length of the exit name depends on the environment in which the exit is running. MQ_EXIT_NAME_LENGTH gives the maximum length for the environment in which the application is running. MQ_MAX_EXIT_NAME_LENGTH gives the maximum for all supported environments.

SecurityUserData (MQCFST)

Security exit user data (parameter identifier: MQCACH_SEC_EXIT_USER_DATA).

The maximum length of the string is MQ_EXIT_DATA_LENGTH.

SendExit (MQCFST)

Send exit name (parameter identifier: MQCACH_SEND_EXIT_NAME).

The maximum length of the exit name depends on the environment in which the exit is running. MQ_EXIT_NAME_LENGTH gives the maximum length for the environment in which the application is running. MQ_MAX_EXIT_NAME_LENGTH gives the maximum for all supported environments.

On Multiplatforms, if more than one send exit has been defined for the channel, the list of names is returned in an MQCFSL structure instead of an MQCFST structure.

On z/OS, an MQCFSL structure is always used.

SendUserData (MQCFST)

Send exit user data (parameter identifier: MQCACH_SEND_EXIT_USER_DATA).

The maximum length of the string is MQ_EXIT_DATA_LENGTH.

On Multiplatforms, if more than one send exit user data string has been defined for the channel, the list of strings is returned in an MQCFSL structure instead of an MQCFST structure.

On z/OS, an MQCFSL structure is always used.

SeqNumberWrap (MQCFIN)

Sequence wrap number (parameter identifier: MQIACH_SEQUENCE_NUMBER_WRAP).

SharingConversations (MQCFIN)

Number of sharing conversations (parameter identifier: MQIACH_SHARING_CONVERSATIONS).

This parameter is returned only for TCP/IP client-connection and server-connection channels.

ShortRetryCount (MQCFIN)

Short retry count (parameter identifier: MQIACH_SHORT_RETRY).

ShortRetryInterval (MQCFIN)

Short timer (parameter identifier: MQIACH_SHORT_TIMER).

SPLProtection (MQCFIN)

SPLProtection (parameter identifier: MQIACH_SPL_PROTECTION). This parameter applies to z/OS only, from IBM MQ Version 9.1.3 onwards.

Security policy protection parameter. Specifies what happens to messages across the channel when Advanced Message Security is active and an applicable policy exists.

This parameter is valid for channel types MQCHT_SENDER, MQCHT_SERVER, MQCHT_RECEIVER, and MQCHT_REQUESTER only.

Possible values are:

MQSPL_PASSTHRU

Pass through, unchanged, any messages sent or received by the message channel agent for this channel.

This value is valid only for ChannelType values of MQCHT_SENDER, MQCHT_SERVER, MQCHT_RECEIVER, or MQCHT_REQUESTER, and is the default value.

MQSPL_REMOVE

Remove any AMS protection from messages retrieved from the transmission queue by the message channel agent, and send the messages to the partner.

When the MCA gets a message from the transmission queue, if an AMS policy is defined for the transmission queue, it is applied to remove any AMS protection from the message prior to sending the message across the channel. If an AMS policy is not defined for the transmission queue, the message is sent as is.

This value is valid only for ChannelType values of MQCHT_SENDER or MQCHT_SERVER.

MQSPL_AS_POLICY

Based on the policy defined for the target queue, apply AMS protection to inbound messages prior to putting them on to the target queue.

When the message channel agent receives an inbound message, if an AMS policy is defined for the target queue, AMS protection is applied to the message prior to the message being put to the target queue. If an AMS policy is not defined for the target queue, the message is put to the target queue as is.

This value is valid only for ChannelType values of MQCHT_RECEIVER or MQCHT_REQUESTER.

SSLCipherSpec (MQCFST)

CipherSpec (parameter identifier: MQCACH_SSL_CIPHER_SPEC).

The length of the string is MQ_SSL_CIPHER_SPEC_LENGTH.

SSLCipherSuite (MQCFST)

CipherSuite (parameter identifier: MQCACH_SSL_CIPHER_SUITE).

The length of the string is MQ_SSL_CIPHER_SUITE_LENGTH.

SSLClientAuth (MQCFIN)

Client authentication (parameter identifier: MQIACH_SSL_CLIENT_AUTH). The value can be

MQSCA_REQUIRED

Client authentication required

MQSCA_OPTIONAL

Client authentication is optional.

The following value is also valid for Channels of type MQCHT_MQTT:

MQSCA_NEVER_REQUIRED

Client authentication is never required, and must not be provided.

Defines whether IBM MQ requires a certificate from the TLS client.

SSLPeerName (MQCFST)

Peer name (parameter identifier: MQCACH_SSL_PEER_NAME). Note: An alternative way of restricting connections into channels by matching against the TLS Subject Distinguished Name, is to use channel authentication records. With channel authentication records, different TLS Subject Distinguished Name patterns can be applied to the same channel. If both SSLPEER on the channel and a channel authentication record are used to apply to the same channel, the inbound certificate must match both patterns in order to connect. For more information, see Channel authentication records.

The length of the string is MQ_SSL_PEER_NAME_LENGTH. On z/OS, it is MQ_SSL_SHORT_PEER_NAME_LENGTH.

Specifies the filter to use to compare with the Distinguished Name of the certificate from the peer queue manager or client at the other end of the channel. (A Distinguished Name is the identifier of the TLS certificate.) If the Distinguished Name in the certificate received from the peer does not match the SSLPEER filter, the channel does not start.

TpName (MQCFST)

Transaction program name (parameter identifier: MQCACH_TP_NAME).

The maximum length of the string is MQ_TP_NAME_LENGTH.

TransportType (MQCFIN)

Transmission protocol type (parameter identifier: MQIACH_XMIT_PROTOCOL_TYPE). The value might be:

MQXPT_LU62

LU 6.2.

MQXPT_TCP

TCP.

MQXPT_NETBIOS

NetBIOS.

MQXPT_SPX

SPX.

MQXPT_DECNET

DECnet.

UseDLQ (MQCFIN)

Whether the dead-letter queue (or undelivered message queue) should be used when messages cannot be delivered by channels (parameter identifier: MQIA_USE_DEAD_LETTER_Q). The value might be:

MQUSEDLQ_NO

Messages that cannot be delivered by a channel will be treated as a failure and either the channel will discard them, or the channel will end, in accordance with the setting of NPMSPEED.

MQUSEDLQ_YES

If the queue manager DEADQ attribute provides the name of a dead-letter queue then it will be used, otherwise the behavior will be as for MQUSEDLQ_NO.

UserIdentifier (MQCFST)

Task user identifier (parameter identifier: MQCACH_USER_ID).

The maximum length of the string is MQ_USER_ID_LENGTH. However, only the first 10 characters are used.

XmitQName (MQCFST)

Transmission queue name (parameter identifier: MQCACH_XMIT_Q_NAME).

The maximum length of the string is MQ_Q_NAME_LENGTH.

Parent topic: Definitions of the Programmable Command Formats