Telemetry channel properties

Telemetry channel properties

Each telemetry channel attribute has a brief description which we must understand before we can configure the channel. MQ Telemetry only supports the TCP/IP protocol.

Right-click any telemetry object, then click Properties to view and edit the telemetry channel's properties.

The following table lists the attributes that we can set on the Telemetry channel properties dialog (Note 1).

Attribute Meaning

Channel name Read-only. This is the name of the telemetry channel definition.

Channel type Read-only. This is the type of channel, in this case, MQTT.

Overall channel status Read-only. This is the current status of the telemetry channel.

Xmit protocol Read-only. The transmission protocol of the channel. Only TCP/IP is supported.

Port This is the port number that the MQXR service accepts client connections on.
The default port number for a telemetry channel is 1883; and the default port number for a telemetry channel secured using TLS is 8883.

Local address (optional) Type the IP address that the telemetry channel listens on. Use this option when a server has multiple IP addresses.

Backlog (optional) The number of outstanding connection requests that the telemetry channel can support at any one time. When the backlog limit is reached, any further clients trying to connect will be refused connection until the current backlog is processed.
The value is in the range 0 - 999999999. The default value is 4096.

MCA user ID (optional)
See Note 2
The user ID for the message channel agent. It is the user identifier (up to 12 characters) to be used by the MCA for authorization to access IBM MQ resources. If this property is specified, the user name supplied by the client is not used for IBM MQ authorization.

Use client ID (optional)
See Note 2
Decide whether we want to use the MQTT client ID for the new connection as the IBM MQ user ID for that connection. If this property is specified, the user name supplied by the client is ignored.

SSL CipherSuite (optional) If you choose to use this property, the CipherSuite must be available at the client end of the telemetry channel. Leaving this option blank makes both ends of the telemetry channel negotiate a CipherSuite that they both understand.

SSL Authentication (optional) Determines whether the client is treated anonymously. SSL authentication defines whether the telemetry channel must receive and authenticate a TLS certificate from a client.

SSL Key repository (optional) The store for digital certificates and their associated private keys. If you do not specify a key file, TLS is not used.

SSL Passphrase (optional) The password for the key repository. If no passphrase is entered, then unencrypted connections must be used.

JAAS config file (read-only) The file path of the JAAS configuration.

JAAS config name (optional) The name of the configuration in the jaas.config file that we want to implement.

Note:

When you edit the attributes of a telemetry channel, we must restart the channel for the changes to apply.
Do not specify both MCA user ID and Use client ID properties. If you specify both, the telemetry channel will fail when it tries to start.
If neither the MCA user ID and Use client ID properties are set, the user name and password from the client are used and the user name is authenticated by JAAS using the password.

Parent topic: MQ Telemetry reference

Related tasks

Configure MQ Telemetry using IBM MQ Explorer
Administer MQ Telemetry using IBM MQ Explorer

Last updated: 2020-10-04

Attribute	Meaning
Channel name	Read-only. This is the name of the telemetry channel definition.
Channel type	Read-only. This is the type of channel, in this case, MQTT.
Overall channel status	Read-only. This is the current status of the telemetry channel.
Xmit protocol	Read-only. The transmission protocol of the channel. Only TCP/IP is supported.
Port	This is the port number that the MQXR service accepts client connections on. The default port number for a telemetry channel is 1883; and the default port number for a telemetry channel secured using TLS is 8883.
Local address (optional)	Type the IP address that the telemetry channel listens on. Use this option when a server has multiple IP addresses.
Backlog (optional)	The number of outstanding connection requests that the telemetry channel can support at any one time. When the backlog limit is reached, any further clients trying to connect will be refused connection until the current backlog is processed. The value is in the range 0 - 999999999. The default value is 4096.
MCA user ID (optional) See Note 2	The user ID for the message channel agent. It is the user identifier (up to 12 characters) to be used by the MCA for authorization to access IBM MQ resources. If this property is specified, the user name supplied by the client is not used for IBM MQ authorization.
Use client ID (optional) See Note 2	Decide whether we want to use the MQTT client ID for the new connection as the IBM MQ user ID for that connection. If this property is specified, the user name supplied by the client is ignored.
SSL CipherSuite (optional)	If you choose to use this property, the CipherSuite must be available at the client end of the telemetry channel. Leaving this option blank makes both ends of the telemetry channel negotiate a CipherSuite that they both understand.
SSL Authentication (optional)	Determines whether the client is treated anonymously. SSL authentication defines whether the telemetry channel must receive and authenticate a TLS certificate from a client.
SSL Key repository (optional)	The store for digital certificates and their associated private keys. If you do not specify a key file, TLS is not used.
SSL Passphrase (optional)	The password for the key repository. If no passphrase is entered, then unencrypted connections must be used.
JAAS config file (read-only)	The file path of the JAAS configuration.
JAAS config name (optional)	The name of the configuration in the jaas.config file that we want to implement.