{"id":31772,"date":"2021-04-27T18:14:02","date_gmt":"2021-04-27T23:14:02","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=31772"},"modified":"2023-06-26T10:22:11","modified_gmt":"2023-06-26T15:22:11","slug":"mqttbroker","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/mqttbroker\/","title":{"rendered":"MQTT broker"},"content":{"rendered":"

Description: MQTT broker settings : ARRAY<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/span><\/td>\nType<\/strong><\/span><\/td>\nDescription<\/strong><\/span><\/td>\n<\/tr>\n
__v<\/td>\nUINT<\/td>\nVersion of model [1]<\/td>\n<\/tr>\n
bridge<\/a><\/td>\nOBJECT<\/td>\nA MQTT bridge lets you connect two MQTT brokers together. They are generally used for sharing messages between systems, for example to connect edge MQTT brokers to a central or remote MQTT network. The Mosquitto broker (server) can be configured to work as an MQTT bridge<\/td>\n<\/tr>\n
\u00a0 \u00a0authMethod<\/td>\nSTRING<\/td>\nAuthentication method for MQTT bridge [no Auth]<\/td>\n<\/tr>\n
\u00a0 \u00a0certificate<\/td>\nSTRING<\/td>\nImported local RSA certificate contents (PEM)<\/td>\n<\/tr>\n
\u00a0 \u00a0cleanSession<\/td>\nBOOL<\/td>\nEnable or disable feature where all subscriptions and messages are cleaned up if the connection drops [false]<\/td>\n<\/tr>\n
\u00a0 \u00a0clientId<\/td>\nSTRING<\/td>\nUnique identifier name of the MQTT broker<\/td>\n<\/tr>\n
\u00a0 \u00a0enabled<\/td>\nBOOL<\/td>\nEnable or disable the MQTT broker to act as a bridge [false\/disabled]<\/td>\n<\/tr>\n
\u00a0 \u00a0identity<\/td>\nSTRING<\/td>\nIdentity for a Pre-Shared Key as part of the psk authentication method (optional)<\/td>\n<\/tr>\n
\u00a0 \u00a0notifications<\/td>\nBOOL<\/td>\nEnables or disables notifications to local and remote brokers regarding the state of the bridge connection [true\/enabled]<\/td>\n<\/tr>\n
\u00a0 \u00a0password<\/td>\nSTRING<\/td>\nPassword for userPass authentication method (optional)<\/td>\n<\/tr>\n
\u00a0 \u00a0privateKey<\/td>\nSTRING<\/td>\nRSA Private key (PEM) for Imported Certificate authentication method<\/td>\n<\/tr>\n
\u00a0 \u00a0protocolVersion<\/td>\nSTRING<\/td>\nVersion of the MQTT protocol [mqttv31]<\/td>\n<\/tr>\n
\u00a0 \u00a0psk<\/td>\nSTRING<\/td>\nUser defined Pre-Shared Key for the psk authentication method (optional)<\/td>\n<\/tr>\n
\u00a0 \u00a0secondaryAddress<\/td>\nSTRING<\/td>\nBackup or secondary address of the server for MQTT broker (optional)<\/td>\n<\/tr>\n
\u00a0 \u00a0secondaryPort<\/td>\nSTRING<\/td>\nBackup or secondary port for MQTT broker (optional)<\/td>\n<\/tr>\n
\u00a0 \u00a0serverAddress<\/td>\nSTRING<\/td>\nPrimary server address for the MQTT broker<\/td>\n<\/tr>\n
\u00a0 \u00a0serverPort<\/td>\nSTRING<\/td>\nPrimary server port for the MQTT broker<\/td>\n<\/tr>\n
\u00a0 \u00a0tlsEnabled<\/td>\nBOOL<\/td>\nEnable or disable SSL\/TLS support during connection [false\/disabled]<\/td>\n<\/tr>\n
\u00a0 \u00a0topics<\/td>\nARRAY<\/td>\nTopics that the MQTT broker uses\u00a0to filter messages for the connected client<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 direction<\/td>\nSTRING<\/td>\nThe direction that the messages will be shared in [out]<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 localPrefix<\/td>\nSTRING<\/td>\nThe local prefix used to remap subtrees of topics [test#]<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 pattern<\/td>\nSTRING<\/td>\nA topic pattern to be shared between the two brokers [#]<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 qosLevel<\/td>\nSTRING<\/td>\nThe guality of service level which defines the publish\/subscribe QoS level used for a topic [0]<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 remotePrefix<\/td>\nSTRING<\/td>\nThe remote prefix is used to remap subtrees of topics<\/td>\n<\/tr>\n
\u00a0 \u00a0tryPrivate<\/td>\nBOOL<\/td>\nEnabled or disable the bridge to indicate the remote broker that it is a bridge, not an ordinary client [true\/enabled]<\/td>\n<\/tr>\n
\u00a0 \u00a0username<\/td>\nSTRING<\/td>\nUsername for the userPass authentication method (optional)<\/td>\n<\/tr>\n
\u00a0 \u00a0verifyHostname<\/td>\nBOOL<\/td>\nEnable or disable the bridge to verify the hostname provided in the remote certificate matches the host\/address being connected to [false\/disabled]<\/td>\n<\/tr>\n
\u00a0 \u00a0tlsVersion<\/td>\nSTRING<\/td>\nThe minimum version of the TLS protocol to be used for the MQTT Bridge. Possible values are tlsv1.3, tlsv1.2 and tlsv1.1 (default:tlsv1.2)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Description: MQTT broker settings : ARRAY Element Type Description __v UINT Version of model [1] bridge OBJECT A MQTT bridge lets you connect two MQTT brokers together. They are generally used for sharing messages between systems, for example to connect edge MQTT brokers to a central or remote MQTT network. The Mosquitto broker (server) can […]<\/p>\n","protected":false},"author":1478,"featured_media":0,"parent":13129,"menu_order":36,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-31772","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/31772","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1478"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=31772"}],"version-history":[{"count":8,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/31772\/revisions"}],"predecessor-version":[{"id":33437,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/31772\/revisions\/33437"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=31772"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}