...
- Name
- This is the friendly name of the MQTT Server used to easily identify it.
- Enabled
- Whether or not connections to this MQTT Server are enabled.
- URL
- This is the URL of the MQTT server. Its format is as follows: [protocol]://[location]:[port]. Each of these are shown below.
- protocol - Either tcp or ssl
- location - The server location. e.g. localhost, myserver.chariot.io, mydomain.com, etc
- port - The port the MQTT Server is listening on. Generally this is 1883 if using TCP or 8883 if using SSL
- Server Type
- This is the type of MQTT Server to connect to.
- Chariot - If connecting to a Cirrus Link Chariot on-premise or Chariot cloud based MQTT Server
- MQTT Distributor - If connecting to a Ignition MQTT Distributor server
- Third Party - If connecting to a third party 3.1.1 compliant MQTT Server
- Username
- Optional MQTT username to use in the MQTT connect packet. This is required if the MQTT Server to connect to requires it.
- Password
- Optional MQTT password to use in the MQTT connect packet. This is required if the MQTT Server to connect to requires it.
- Certificates
- The server certificates to use if required. These are generally only required when connecting using TLS and the MQTT server does not have a genuine certificate issued by a trusted certificate authority.
- CA certificate must always end in 'ca.pem'
- If using client side certificates (i.e. a public/private keypair and CA cert), make sure the following naming conventions are followed.
- Edge/Device certificate must end in 'cert.pem'
- Edge/Device private key must end in 'private.key'CA certificate must end in 'ca.pem'
Advanced Settings
- Client ID
- Optional MQTT client ID to use. If specified this will be used in the MQTT Engine connect packet when connecting to the server. If left blank, a random client ID will be create of the form 'IgnitionTarget-xxxxxxxx-xxxx-xxxx'.
- Keep Alive
- The MQTT client keep alive time (in seconds).
- Filtered Namespaces
- A comma separated list of namespaces that will be filtered/disabled for connections to this MQTT Server.
...
{"serverDuration": 161, "requestCorrelationId": "caac6116a7fe7365"}