Connections > Connection properties > MQTT connection properties

MQTT connection properties

When you set up an MQ Telemetry Transport (MQTT) connection, you must configure the connection properties.
The following table describes the MQTT connection properties:
Connection Name
Name of the connection.
The name is not case sensitive and must be unique within the domain. You can change this property after you create the connection. The name cannot exceed 128 characters, contain spaces, or contain the following special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
Optional. Description that you can use to identity the connection.
The description cannot exceed 4,000 characters.
The MQTT connection type.
If you do not see the connection type, go to the Add-On Connectors page to install the connector.
Runtime Environment
Name of the runtime environment where you want to run the tasks.
Broker URI
The connection URL of the MQTT broker. If specified, this value overrides the URL specified in the main portion of the URL.
Sample URL: tcp://<IP Address>:<port>
Client Id
Client identifier of your MQTT client.
If this value is left blank, the MQTT server assigns a unique value.
This property value must be unique for each MQTT client connecting to a specific MQTT server. Sharing projects without changing the Client ID can lead to connection issues, including disconnections and missing updates.
Username to use when connecting to the broker.
Password to use when connecting to the broker.
Connection Timeout
Maximum time interval the client will wait for the connection to the MQTT server to be established.
Default timeout is 30 seconds.
A value of 0 disables timeout processing. That is, the client waits until the network connection is made successfully or fails.
Enable this option to use SSL for secure transmission.
If you enable the SSL authentication, ensure to provide both keystore and truststore details for using the MQTT connection in a streaming ingestion task.
Keystore Filename
Contains the keys and certificates required for secure communication.
Keystore Password
Password for the keystore filename.
Keystore Type
Type of keystore to use.
Keystore type defines the storage and data format of the keystore information and the algorithms used to protect private keys in the keystore.
Use one of the following types:
  • - JKS. Stores private keys and certificates.
  • - PKCS12. Stores private keys, secret keys. and certificates.
Truststore Filename
File name of the truststore file.
Truststore Password
Password for the truststore file name.
Truststore Type
Type of truststore to use.
Use one of the following types:
  • - JKS
  • - PKCS 12
TLS Protocol
Transport protocols to use.
Use one of the following types:
  • - SSL
  • - SSLv3
  • - TLS
  • - TLSv1
  • - TLSv1.1
  • - TLSv1.2