0
edits
Changes
no edit summary
For in-depth MQTT configuration examples, refer to this page: '''[[Monitoring via MQTT]]'''
For in-depth MQTT configuration examples, refer to this page: '''[[Monitoring via MQTT]]'''
{{Template: Networking_rutxxx_manual_fw_disclosure
| fw_version = RUT9XX_R_00.06.06
}}
==MQTT Broker==
==MQTT Broker==
<tr>
<tr>
<td>Enable</td>
<td>Enable</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Toggles MQTT Broker ON or OFF</td>
<td>Toggles MQTT Broker ON or OFF</td>
</tr>
</tr>
<tr>
<tr>
<td>Local Port</td>
<td>Local Port</td>
<td>integer [0..65535]; Default: "<b>1883</b>"</td>
<td>integer [0..65535]; Default: "1883"</td>
<td>Specifies the local port that the MQTT broker will listen to</td>
<td>Specifies the local port that the MQTT broker will listen to</td>
</tr>
</tr>
<tr>
<tr>
<td>Enable Remote Access</td>
<td>Enable Remote Access</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>If enabled, MQTT Broker will be reachable by remote user (from WAN)</td>
<td>If enabled, MQTT Broker will be reachable by remote user (from WAN)</td>
</tr>
</tr>
<tr>
<tr>
<td>Use TLS/SSL</td>
<td>Use TLS/SSL</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Toggles the use of TLS/SSL certificates ON or OFF</td>
<td>Toggles the use of TLS/SSL certificates ON or OFF</td>
</tr>
</tr>
<tr>
<tr>
<td>CA File</td>
<td>CA File</td>
<td>.ca file; Default: " "</td>
<td>.ca file; default: '''none'''</td>
<td>'''Certificate authority''' is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate</td>
<td>'''Certificate authority''' is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate</td>
</tr>
</tr>
<tr>
<tr>
<td>CERT File</td>
<td>CERT File</td>
<td>.crt file; Default: " "</td>
<td>.crt file; default: '''none'''</td>
<td>Certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity</td>
<td>Certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity</td>
</tr>
</tr>
<tr>
<tr>
<td>Key File</td>
<td>Key File</td>
<td>.key file; Default: " "</td>
<td>.key file; default: '''none'''</td>
<td>Specifies the local port that the MQTT broker will listen to</td>
<td>Private key for client to establish connection</td>
</tr>
</tr>
<tr>
<tr>
</tr>
</tr>
<tr>
<tr>
<td>Enable</td>
<td>Use TLS/SSL</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Toggles MQTT Bridge ON or OFF</td>
<td>Toggles MQTT Bridge ON or OFF</td>
</tr>
</tr>
<tr>
<tr>
<td>Connection Name</td>
<td>Connection Name</td>
<td>string; Default: " "</td>
<td>string; default: '''none'''</td>
<td>Name of the Bridge connection. Although this is used for easier management purposes, this field is mandatory</td>
<td>Name of the Bridge connection. Although this is used for easier management purposes, this field is mandatory</td>
</tr>
</tr>
<tr>
<tr>
<td>Remote Address</td>
<td>Remote Address</td>
<td>ip; Default: " "</td>
<td>ip; default: '''none'''</td>
<td>Remote Broker’s address</td>
<td>Remote Broker’s address</td>
</tr>
</tr>
<tr>
<tr>
<td>Use Remote TLS/SSL</td>
<td>Use Remote TLS/SSL</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Enables the use of TSL/SSL certificates of the remote broker. If this is checked, you will be prompted to upload TLS/SSL certificates. More information can be found in the [[#Security|Security]] section of this chapter</td>
<td>Enables the use of TSL/SSL certificates of the remote broker. If this is checked, you will be prompted to upload TLS/SSL certificates. More information can be found in the [[#Security|Security]] section of this chapter</td>
</tr>
</tr>
<tr>
<tr>
<td>Use Remote Bridge Login</td>
<td>Use Remote Bridge Login</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Enables the use of Remote login data. If this is checked, you will be prompted to enter a remote client ID, username and password</td>
<td>Enables the use of Remote login data. If this is checked, you will be prompted to enter a remote client ID, username and password</td>
</tr>
</tr>
<tr>
<tr>
<td>Topic</td>
<td>Topic</td>
<td>string; Default: " "</td>
<td>string; default: '''none'''</td>
<td>Specifies the names of the Topics that your Broker will subscribe to</td>
<td>Specifies the names of the Topics that your Broker will subscribe to</td>
</tr>
</tr>
<tr>
<tr>
<td>Try Private</td>
<td>Try Private</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Check if the remote Broker is another instance of a daemon</td>
<td>Check if the remote Broker is another instance of a daemon</td>
</tr>
</tr>
<tr>
<tr>
<td>Clean Session</td>
<td>Clean Session</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Check to discard session state after connecting or disconnecting</td>
<td>Check to discard session state after connecting or disconnecting</td>
</tr>
</tr>
The last section of MQTT Broker parameters is called '''Miscellaneous'''. It contains parameters that are related to neither Security nor Bridge.
The last section of MQTT Broker parameters is called '''Miscellaneous'''. It contains parameters that are related to neither Security nor Bridge.
[[Image:Services mqtt broker settings misc.PNG]]
[[Image:Services mqtt broker settings misc.PNG| border| class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>ACL File</td>
<td>ACL File</td>
<td>.ACL file; Default: " "</td>
<td>.ACL file; default: '''none'''</td>
<td>The contents of this file are used to control client access to topics of the broker</td>
<td>The contents of this file are used to control client access to topics of the broker</td>
</tr>
</tr>
<tr>
<tr>
<td>Password File</td>
<td>Password File</td>
<td>password file; Default: " "</td>
<td>password file; default: '''none'''</td>
<td>The Password file stores user names and corresponding passwords, used for authentication</td>
<td>The Password file stores user names and corresponding passwords, used for authentication. The file can be produced by mosquitto_passwd on the ssh command line, see https://mosquitto.org/man/mosquitto_passwd-1.html</td>
</tr>
</tr>
<tr>
<tr>
<td>Persistence</td>
<td>Persistence</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>If enabled, connection, subscription and message data will be written to the disk. Otherwise, the data is stored in the router’s memory only</td>
<td>If enabled, connection, subscription and message data will be written to the disk. Otherwise, the data is stored in the router’s memory only</td>
</tr>
</tr>
<tr>
<tr>
<td>Allow Anonymous</td>
<td>Allow Anonymous</td>
<td>yes | no; Default: '''yes'''</td>
<td>yes | no; default: '''yes'''</td>
<td>If enabled, the Broker allows anonymous access</td>
<td>If enabled, the Broker allows anonymous access</td>
</tr>
</tr>
An '''MQTT Publisher''' is a client that sends messages to the Broker, who then forwards these messages to the Subscriber.
An '''MQTT Publisher''' is a client that sends messages to the Broker, who then forwards these messages to the Subscriber.
[[Image:Services mqtt publisher.PNG]]
[[Image:Networking_rut955_manual_mqtt_publisher_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Enable</td>
<td>Enable</td>
<td>yes | no; Default: '''no'''</td>
<td>yes | no; default: '''no'''</td>
<td>Toggles the MQTT Publisher ON or OFF</td>
<td>Toggles the MQTT Publisher ON or OFF</td>
</tr>
</tr>
<tr>
<tr>
<td>Hostname</td>
<td>Hostname</td>
<td>host | ip; Default: " "</td>
<td>host | ip; default: '''none'''</td>
<td>Broker’s IP address or hostname</td>
<td>Broker’s IP address or hostname</td>
</tr>
</tr>
<tr>
<tr>
<td>Port</td>
<td>Port</td>
<td>integer [0..65535]; Default: " "</td>
<td>integer [0..65535]; default: '''1883'''</td>
<td>Specifies the port used for connecting to the Broker</td>
<td>Specifies the port used for connecting to the Broker</td>
</tr>
</tr>
<tr>
<tr>
<td>Username</td>
<td>Username</td>
<td>string; Default: " "</td>
<td>string; default: '''none'''</td>
<td>User name used for authentication when connecting to the Broker</td>
<td>User name used for authentication when connecting to the Broker</td>
</tr>
</tr>
<tr>
<tr>
<td>Password</td>
<td>Password</td>
<td>string; Default: " "</td>
<td>string; default: '''none'''</td>
<td>Password used for authentication when connecting to the Broker</td>
<td>Password used for authentication when connecting to the Broker</td>
</tr>
<tr>
<td>TLS</td>
<td>yes | no; default: '''no'''</td>
<td>Toggles the TLS authentication between ON or OFF.</td>
</tr>
<tr>
<td>Allow insecure connection</td>
<td>yes | no; default: '''no'''</td>
<td>If enabled, router will be allowed to not verify server's authenticity.</td>
</tr>
<tr>
<td>CA file</td>
<td>.ca file; default: '''none'''</td>
<td>'''Certificate authority''' is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate.</td>
</tr>
<tr>
<td>Certificate file</td>
<td>.crt file; default: '''none'''</td>
<td>Certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity.</td>
</tr>
<tr>
<td>Key file</td>
<td>.key file; default: '''none'''</td>
<td>Private key for client to establish connection.</td>
</tr>
</tr>
</table>
</table>
[[Category:RUT900 Services section]]
[[Category:RUT900 Services section]]
