Skip to end of metadata
Go to start of metadata

The MQTT Remote Agent module provides a configuration section to the Ignition Gateway.  These can be seen in the Configure section of the Ignition Gateway web UI in the left panel.

Once in the configuration section there are two tabs: General and Servers.  Each of these tabs is described in detail in the following sections.


The first tab contains general settings which allows one to enable/disable the module and configure IDs. 


  • Enabled
    • Whether or not the MQTT Remote Agent module is enabled and connecting to configured MQTT Servers.
  • MQTT Remote Agent ID
    • The MQTT Remote Agent ID which uniquely identifies this MQTT Remote Agent within the system.
  • Primary Controller ID
    • The Primary Controller ID to allow connecting clients to ensure they remain connected to this Controller application (optional).


The second tab is a list of MQTT Servers that MQTT Remote Agent should connect to.  By default, the MQTT Remote Agent is configured to connect to the local MQTT Distributor based MQTT Server.  It is set up to connect to localhost, port 1883, using the default username/password pair of admin/changeme.  Out of the box the MQTT Remote Agent will work with MQTT Distributor and its default configuration.  The connection status of each server can be seen in the 'Status' column.  Clicking on the 'Create new MQTT Server' link will bring up the following form for adding a new MQTT Server setting.

Additional or alternative MQTT Servers can be configured.  Often times more than one will be configured to handle fail-over in redundant or geographically distributed systems.  The configuration options for servers are listed below.


  • Name
    • This is the friendly name of the MQTT Server used to easily identify it
  • 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,, etc
      • port - The port the MQTT Server is listening on.  Generally this is 1883 if using TCP or 8883 if using SSL
  • 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.

Advanced Settings

  • Client ID
    • Optional MQTT client ID to use.  If specified this will be used in the MQTT connect packet when connecting to the server.  If left blank, a random client ID will be created.
  • Keep Alive
    • The MQTT client keep alive time (in seconds).

Clicking on the 'Create new MQTT Server...' link will bring up the following form to add a new Server.

  • No labels