MQTT
You can configure MQTT as a source or a target. The parameters are described in the following tables:
For message headers, see MQTT Message Headers.
MQTT Source Parameters
The following table describes the parameters for configuring MQTT as a source.
| Field | Description |
|---|---|
|
MQTT Server URIs |
The comma-separated list of MQTT server URIs, such as |
|
MQTT Version |
(Optional) The MQTT version. The default is MQTT v5.0. |
|
Username |
(Optional) The username for authentication with the MQTT broker. |
|
Password |
(Optional) The password for authentication with the MQTT broker. |
|
Enable Clean Session |
(Optional) Enable an MQTT Clean Session when selected. This option is selected (enabled) by default. For more information about MQTT Clean Sessions, see MQTT Sessions. |
|
Session Expiry Interval |
(Optional) The number of seconds a session survives after its client becomes disconnected. The minimum value is 0. For more information about MQTT Session Expiry Intervals, see MQTT Clean Start and Session Expiry Interval. |
|
Enable Automatic Reconnect |
(Optional) Enable automatic reconnection when selected. The option is selected (enabled) by default. |
|
Automatic Reconnect Delay |
(Optional) The maximum number of seconds to wait before attempting to reconnect. The number of seconds can be 0 or more. The default is 30. |
|
Connection Timeout |
(Optional) The number of seconds for the connection timeout. The number of seconds can be 0 or more. The default is 30. |
|
Keep Alive Interval |
(Optional) The number of seconds for the MQTT Keep Alive interval. The number of seconds can be 0 or more. The default is 60. For more information about MQTT Keep Alive, see MQTT Keep Alive Parameter. |
|
SSL Configuration |
(Optional) Enable or disable Secure Sockets Layer (SSL) configuration. The default is Disable SSL Configuration. If SSL configuration is enabled, additional parameters are required. For more information, see MQTT SSL Configuration Parameters. |
|
Will Configuration |
(Optional) Enable or disable MQTT Last Will configuration. The default is Disable Will Configuration. If Last Will configuration is enabled, additional parameters are required. For more information, see MQTT Last Will Configuration Parameters. |
|
Destination |
The MQTT topic name. This field supports multiple topics where each topic is separated by a comma, wildcards, and shared subscriptions (MQTT v5 only). For more information about MQTT topics, see MQTT Topics and Wildcards. |
|
Client ID |
(Optional) The client identifier for the publisher connection. |
|
QoS |
(Optional) The quality of service for published messages. The default value is 1. |
|
Enable DLT |
(Optional) The option to enable Dead-Letter topics (DLT) for failed consumer messages. If the DLT Name is not configured, failed consumer messages are forwarded to the dlt/{source-topic-name} topic. For more information about Dead-Letter topics, see Dead-Letter Topic Processing. |
|
DLT Name |
(Optional) The name of the Dead-Letter topic. If DLT is enabled, failed consumer messages are forwarded to the topic that is configured with the DLT name. |
MQTT Target Parameters
The following table describes the parameters for configuring MQTT as a target.
| Field | Description |
|---|---|
|
MQTT Server URIs |
The comma-separated list of MQTT server URIs, such as |
|
MQTT Version |
(Optional) The MQTT version. The default is MQTT v5.0. |
|
Username |
(Optional) The username for authentication with the MQTT broker. |
|
Password |
(Optional) The password for authentication with the MQTT broker. |
|
Enable Clean Session |
(Optional) Enable an MQTT Clean Session when selected. This option is selected (enabled) by default. For more information about MQTT Clean Sessions, see MQTT Sessions. |
|
Session Expiry Interval |
(Optional) The number of seconds a session survives after its client becomes disconnected. The minimum value is 0. For more information about MQTT Session Expiry Intervals, see MQTT Clean Start and Session Expiry Interval. |
|
Enable Automatic Reconnect |
(Optional) Enable automatic reconnection when selected. The option is selected (enabled) by default. |
|
Automatic Reconnect Delay |
(Optional) The maximum number of seconds to wait before attempting to reconnect. The number of seconds can be 0 or more. The default is 30. |
|
Connection Timeout |
(Optional) The number of seconds for the connection timeout. The number of seconds can be 0 or more. The default is 30. |
|
Keep Alive Interval |
(Optional) The number of seconds for the MQTT Keep Alive interval. The number of seconds can be 0 or more. The default is 60. For more information about MQTT Keep Alive, see MQTT Keep Alive Parameter. |
|
SSL Configuration |
(Optional) Enable or disable Secure Sockets Layer (SSL) configuration. The default is Disable SSL Configuration. If SSL configuration is enabled, additional parameters are required. For more information, see MQTT SSL Configuration Parameters. |
|
Will Configuration |
(Optional) Enable or disable MQTT Last Will configuration. The default is Disable Will Configuration. If Last Will configuration is enabled, additional parameters are required. For more information, see MQTT Last Will Configuration Parameters. |
|
Destination |
The MQTT topic name. This field supports multiple topics where each topic is separated by a comma, wildcards, and shared subscriptions (MQTT v5 only). For more information about MQTT topics, see MQTT Topics and Wildcards. |
|
Client ID |
(Optional) The client identifier for the publisher connection. |
|
QoS |
(Optional) The quality of service for published messages. The default value is 1. |
|
Retained |
(Optional) The option to retain published messages. The option is disabled by default. For more information about MQTT retained messages, see MQTT Retained Messages. |
|
Async Publish |
(Optional) The option to publish asynchronously. The option is disabled by default. |
MQTT SSL Configuration Parameters
| Field | Description |
|---|---|
|
Certificate Authority (CA) certificate |
The Certificate Authority (CA) certificate. |
|
Client Certificate |
The client certificate. |
|
Client Private Key |
The client private key. |
|
Client Private Key Password |
The client private key password. |
|
Server Hostname Verification |
The option to enable server hostname verification. The option is disabled by default. |
MQTT Last Will Configuration Parameters
| Field | Description |
|---|---|
|
Last Will Topic |
The MQTT Last Will topic to publish to. For more information about MQTT Last Will or Will Message, see MQTT Will Message. |
|
Last Will QoS |
The quality of service for the MQTT Last Will. The level of the quality of service can be 0, 1, or 2. The default is 0. |
|
Last Will Retain |
The option to retain the MQTT Will Message. The option is disabled by default. |
|
Last Will Message |
The payload for the MQTT Will Message. |
|
Will Message Delay Interval |
The number of seconds for the MQTT Will Message delay interval. |
|
Will Message Expiry Interval |
The number of seconds for the MQTT Will Message expiry interval. |
|
Will Message Content Type |
The Content Type of the MQTT Will Message. |
|
Response Topic |
The topic name for the MQTT response message. For more information about MQTT response messages, see MQTT Request and Response. |
|
Correlation Data |
The MQTT Correlation Data. For more information about MQTT Correlation Data, see MQTT Request and Response. |