MQTTプラグイン

概要

設定パラメータを使用すると、MQTTプラグインの動作をカスタマイズできます。

これらは agent 2 の設定ファイルではなく、専用の設定ファイル（例: mqtt.conf）に指定することを推奨します。その後、Include ディレクティブを使用して、このファイルを Zabbix agent 2 の設定に含めます。

すべてのパラメータは、パラメータが必須であると明示されていない限り、任意です。

このページの構成は次のとおりです。

  • パラメータ概要（パラメータの詳細を確認するには、その名前をクリックしてください）
  • パラメータ詳細
Parameter Description
Plugins.MQTT.Default.Password MQTT への接続に使用するデフォルトのパスワードを指定します。
Plugins.MQTT.Default.TLSCAFile ピア証明書検証用の最上位 CA 証明書を含むファイルの完全なパス名を指定します。
Plugins.MQTT.Default.TLSCertFile エージェント証明書または証明書チェーンを含むファイルの完全なパス名を指定します。
Plugins.MQTT.Default.TLSKeyFile MQTT の秘密鍵を含むファイルの完全なパス名を指定します。
Plugins.MQTT.Default.Topic MQTT サブスクリプション用のデフォルトトピックを指定します。
Plugins.MQTT.Default.Url デフォルトの MQTT ブローカー接続文字列を指定します。
Plugins.MQTT.Default.User MQTT への接続に使用するデフォルトのユーザー名を指定します。
Plugins.MQTT.Sessions.<SessionName>.Password MQTT への接続に使用する、名前付きセッションのパスワードを指定します。
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile 名前付きセッションのピア証明書検証用の最上位 CA 証明書を含むファイルの完全なパス名を指定します。
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile 名前付きセッションのエージェント証明書または証明書チェーンを含むファイルの完全なパス名を指定します。
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile 名前付きセッションの MQTT 秘密鍵を含むファイルの完全なパス名を指定します。
Plugins.MQTT.Sessions.<SessionName>.Topic MQTT サブスクリプション用の名前付きセッションのトピックを指定します。
Plugins.MQTT.Sessions.<SessionName>.Url 名前付きセッションの MQTT ブローカー接続文字列を指定します。
Plugins.MQTT.Sessions.<SessionName>.User MQTT への接続に使用する、名前付きセッションのユーザー名を指定します。

注意:

  • デフォルト値は、配布される設定ファイル内の値ではなく、プロセスのデフォルト値を反映しています。
  • 値は environment variables をサポートします。
  • Zabbix がサポートする設定ファイルのエンコーディングは UTF-8 のみで、BOM は含まれていない必要があります。
  • \# で始まるコメントは、行頭でのみサポートされます。

パラメーター詳細

Plugins.MQTT.Default.Password

MQTT に接続するためのデフォルトパスワードを指定します。
アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。

Plugins.MQTT.Default.TLSCAFile

Zabbix agent 2 と MQTT ブローカー間の暗号化通信におけるピア証明書検証のため、最上位 CA 証明書を含むファイルの完全なパス名を指定します。
名前付きセッションで値が指定されていない場合に使用されます。

Plugins.MQTT.Default.TLSCertFile

Zabbix agent 2 と MQTT ブローカー間の暗号化通信に使用する、エージェント証明書または証明書チェーンを含むファイルの完全なパス名を指定します。
名前付きセッションで値が指定されていない場合に使用されます。

Plugins.MQTT.Default.TLSKeyFile

Zabbix エージェント 2 と MQTT ブローカー間の暗号化通信に使用する MQTT の秘密鍵を含むファイルの完全なパス名を指定します。
名前付きセッションで値が指定されていない場合に使用されます。

Plugins.MQTT.Default.Topic

MQTTサブスクリプションのデフォルトトピックを指定します。
アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
トピックにはワイルドカード（"+"、"#"）を含めることができます。

例: 

path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url

デフォルトの MQTT ブローカー接続文字列を指定します。
アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
クエリパラメータを含めないでください。
URL 形式に一致している必要があります。
サポートされるスキーム: tcp (デフォルト), ws, tls
スキームは省略できます。
ポートは省略できます (default=1883)

デフォルト: tcp://localhost:1883

例:

tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User

MQTT に接続するためのデフォルトのユーザー名を指定します。
アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。

Plugins.MQTT.Sessions.<SessionName>.Password

MQTT に接続するための、指定したセッションのパスワードを設定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MQTT.Sessions.<SessionName>.TLSCAFile

指定したセッションのピア証明書検証に使用する、最上位CA証明書を含むファイルのフルパス名を指定します。これは、Zabbix エージェント 2 と MQTT ブローカー間の暗号化通信で使用されます。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MQTT.Sessions.<SessionName>.TLSCertFile

指定したセッションで使用する、エージェント証明書または証明書チェーンを含むファイルのフルパスを指定します。これは、Zabbix エージェント 2 と MQTT ブローカー間の暗号化通信に使用されます。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile

Zabbix エージェント 2 と MQTT ブローカー間の暗号化通信に使用する、指定したセッション用の MQTT 秘密鍵を含むファイルの完全なパス名を指定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MQTT.Sessions.<SessionName>.Topic

MQTTサブスクリプション用の名前付きセッショントピックを指定します。
<SessionName> - アイテムキーで使用するセッションの名前を定義します。
トピックにはワイルドカード（"+"、"#"）を含めることができます。

例: 

path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url

指定されたセッションの MQTT ブローカー接続文字列を指定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。
クエリパラメータを含めないでください。
URL 形式に一致している必要があります。
サポートされるスキーム: tcp (デフォルト), ws, tls
スキームは省略できます。
ポートは省略できます (デフォルト=1883)

デフォルト: tcp://localhost:1883

例:

tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User

MQTT に接続するための、指定したセッションのユーザー名を設定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

リクエスト実行タイムアウト（リクエストを終了する前に完了を待機する時間）を設定する必要がある場合は、アイテム設定フォームを使用します。

参照