mosquittoの設定パラメータ一覧


https://mosquitto.org/man/mosquitto-conf-5.html

<table id="__asciidoctor-preview-468__" class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">パラメータ名</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">説明</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">デフォルト値</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">connection &lt;name&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">リモートブローカのクライアントIDとして使用される名前を指定。
クライアントIDは"name.hostname"の形式になる。
HostnameはこのPCのホスト名になる。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">address　&lt;host&gt;[:&lt;port&gt;]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続先のホストのアドレスとブリッジに使用するポートを指定。
接続は複数設定することが可能。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">portのデフォルトは1883。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bridge_attempt_unsubscribe [ true | false ]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">trueの場合、リモートブローカーにサブスクライブ解除要求を送信する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bridge_protocol_version &lt;version&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このブリッジで使用するMQTTプロトコルのバージョンを設定する。
mqttv31またはmqttv311のいずれかになる。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">mqttv31</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">cleansession [ true | false ]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">trueの場合、リモートブローカ上のサブスクライブとメッセージは、接続が切断されるとクリーンアップされる。
デフォルト値はfalse。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">keepalive_interval &lt;seconds&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">キープアライブの間隔を指定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">60</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">idle_timeout &lt;seconds&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">"start type"が"lazy"を使用しているブリッジがアイドル状態になってから停止するまでの時間を指定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">60</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">local_clientid &lt;id&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローカルブローカー上で使用するクライアントIDを指定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">local</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">local_password &lt;password&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローカルブローカーに接続する際のパスワードを指定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">local_username &lt;username&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローカルブローカーに接続する際のユーザ名を指定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">notifications [ true | false ]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ブリッジ接続状態を通知する設定。
Trueの場合、ローカルおよびリモートのブローカーに指定されたトピックでブリッジ接続の接続状態を通知する。
メッセージが1の場合、接続がアクティブで、0の場合は接続できていなことを示す。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">notification_topic &lt;topic&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ブリッジの接続状態を通知するトピックを指定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">"sys$/broker/ connection /&lt;clientid&gt;/state"</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remote_clientid &lt;id&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">リモートブローカのクライアントIDを指定。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">クライアントidは"name.hostname"の形式になる。
hostnameはこのpcのホスト名になる。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remote_password &lt;value&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ブリッジ接続する際のパスワードを指定。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remote_username &lt;name&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ブリッジ接続する際のユーザ名を指定。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">restart_timeout &lt;value&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">"start type"が"automatic" を使用しているブリッジが再接続を試みるまで待機する時間を設定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">round_robin [ true | false ]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">"address"で複数のアドレスが指定されていた場合のブリッジ接続失敗時の動作を指定。
Falseなら最初のアドレスがメインブリッジ接続として、扱われる。
</p><p class="tableblock">メインブリッジの接続に失敗すると、他のセカンダリアドレスへのブリッジ接続を順次試行する。
</p><p class="tableblock">セカンダリブリッジに接続されいる間、ブリッジは正常に終了するまで、定期的にメインブリッジに再接続を試みる。
Trueの場合、すべてのアドレスが同等に扱われる。
</p><p class="tableblock">接続に失敗すると、次のアドレスへの接続を試行し、成功した場合は失敗するまでは対象のアドレスへの接続を維持する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">start_type [ automatic | lazy | once ]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ブリッジの開始タイプを指定する。
</p><p class="tableblock">・ automatic
</p><p class="tableblock">ブローカの起動時にブリッジ接続が自動的に開始され、
接続が失敗した場合は短い遅延（30秒）後に再接続を行う。
</p><p class="tableblock">・ lazy
</p><p class="tableblock">キューに入れられたメッセージの数が"threshold "オプションで、
設定された数を超えると自動的に接続を開始する。
</p><p class="tableblock">・ once
</p><p class="tableblock">ブローカーの起動時に自動的に接続する、接続が失敗した場合には再接続しない。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">automatic</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">threshold &lt;count&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">"start type"が"lazy"を使用しているブリッジを接続を開始する際の、キューのメッセージの数の閾値を設定する。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">topic &lt;pattern&gt; [[[ out | in | both ] qos-level] local-prefix remote-prefix]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2つのブローカー間で共有されるトピックのパターンを定義する。
</p><p class="tableblock">● pattern
</p><p class="tableblock">共有するトピックのパターン文字列を指定する。
</p><p class="tableblock">● [ out | in | both ]
</p><p class="tableblock">メッセージを共有する際の方向を示す。
</p><p class="tableblock">・ out : ローカルブローカーからリモートブローカーにメッセージをエクスポートする
</p><p class="tableblock">・ in : リモートブローカーからローカルブローカーにメッセージをインポートする
</p><p class="tableblock">・ both : ローカルブローカーとリモートブローカーでメッセージを双方向で共有する
</p><p class="tableblock">● qos-level
</p><p class="tableblock">対象のトピックのQoSのレベル
</p><p class="tableblock">● local-prefix
</p><p class="tableblock">ローカルブローカーで扱うローカー間の共有トピックの"pattern"の前につく先頭文字列。
※ "pattern"が"A", "local-prefix" "/a/b/c/" の場合、共有するトピックは、"/a/b/c/A"となる。
</p><p class="tableblock">● remote-prefix
</p><p class="tableblock">リモートブローカーで扱うローカー間の共有トピックの"pattern"の前につく先頭文字列。
※ "pattern"が"A", "remote-prefix" "/a/b/c/" の場合、共有するトピックは、"/a/b/c/A"となる。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">try_private [ true | false ]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">trueの場合、ブリッジは、通常のクライアントではなくブリッジであることをリモートブローカに示すように試みる。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
</tr>
</tbody>
</table>