Configure MQTT Broker Settings

If you want to use an MQTT broker to connect to devices, you must configure the settings.

Before you begin

Install Site Administration Addon.

Procedure

  1. In the Site Administration Console page, select Server settings, and then select Mqtt settings.
  2. In the Select tenant to configure drop-down list box, select the tenant, and then select Continue.
    The Account Settings workspace appears.
  3. Enter values as specified in the following table, and then select Update.
    Field Name Description
    Cloud url Enter the IP address or the URL of the MQTT broker that you want to use.
    Pull interval Enter the time interval, in milliseconds, at which the Operations Hub MQTT client will connect to send or receive data. By default, it is set to 500 milliseconds.
    Use password Specify if the MQTT broker requires a user name and password to connect. By default, the value in this field is False.
    Password If you selected True in the Use Password field, enter the password in this field. The default password for the installed MQTT broker is mqttpassword.
    Note: It is highly recommended to create a new password if using MQTT in a production environment. The Mosquitto password file is located here: C:\Program Files\GE\Operations Hub\mosquitto.
    To create a new password file, run the following command:
    mosquitto_passwd -c passwordfile mqttuser
    Visit https://mosquitto.org/man/mosquitto_passwd-1.html for command related information.

    Visit https://mosquitto.org/man/mosquitto-conf-5.html for information on Mosquitto configuration.
    User If you have selected true in the Use password field, enter the user name in this field. The default user for the installed MQTT broker is mqttuser.
    Qos Specify the quality of service (QoS) of the MQTT broker by entering one of the following values:
    • 0: Indicates that the message is delivered at most once or it is not delivered at all.
    • 1: Indicates that the message is always delivered at least once.
    • 2: Indicates that the message is delivered once.
    Port The port number of the MQTT broker. By default, the value in this field is 1883, which is the standard MQTT port number.

Results

The MQTT broker settings are configured.