Inquire Channel (MQTT)

Required parameters

ChannelName (MQCFST)

Channel name (parameter identifier: MQCACH_CHANNEL_NAME).

Generic channel names are supported. A generic name is a character string followed by an asterisk (*), for example ABC*, and it selects all channels having names that start with the selected character string. An asterisk on its own matches all possible names.

The maximum length of the string is MQ_CHANNEL_NAME_LENGTH.

ChannelType (MQCFIN)

Channel type (parameter identifier: MQIACH_CHANNEL_TYPE).

If this parameter is present, eligible channels are limited to the specified type. Any attribute selector specified in the ChannelAttrs list which is only valid for channels of a different type or types is ignored; no error is raised.

If this parameter is not present (or if MQCHT_ALL is specified), channels of all types are eligible. Each attribute specified must be a valid channel attribute selector (that is, it must be one from the following list), but it might not be applicable to all (or any) of the channels returned. Channel attribute selectors that are valid but not applicable to the channel are ignored, no error messages occur, and no attribute is returned.

The value must be:

MQCHT_MQTT

Telemetry channel.

Optional parameters

ChannelAttrs (MQCFIL)

Channel attributes (parameter identifier: MQIACF_CHANNEL_ATTRS).

The attribute list can specify the following value on its own - default value used if the parameter is not specified:

MQIACF_ALL

All attributes.

or a combination of the following parameters:

MQCA_SSL_KEY_REPOSITORY

SSL Key Repository

MQCACH_CHANNEL_NAME

Channel name. You cannot use this attribute as a filter keyword.

MQCACH_JAAS_CONFIG

The file path of the JAAS configuration

MQCACH_LOCAL_ADDRESS

Local communications address for the channel

MQCACH_MCA_USER_ID

MCA user identifier.

MQCACH_SSL_CIPHER_SPEC

SSL cipher spec.

MQCACH_SSL_KEY_PASSPHRASE

SSL key passphrase.

MQIACH_BACKLOG

The number of concurrent connection requests that the channel supports.

MQIACH_CHANNEL_TYPE

Channel type

MQIACH_PORT

Port number to use when TransportType is set to TCP.

MQIACH_SSL_CLIENT_AUTH

SSL client authentication.

MQIACH_USE_CLIENT_ID

Specify whether to use the clientID of a new connection as the userID for that connection

MQIACH_XMIT_PROTOCOL_TYPE

Transport (transmission protocol) type

Error codes

This command might return the following error codes in the response format header, in addition to the values shown in Error codes applicable to all commands.