設定パラメータ: Zabbixブリッジアダプター

概要

設定パラメータを使用すると、Zabbixブリッジアダプターの動作をカスタマイズできます。

パラメータ値は設定ファイル(zabbix_bridge_adapter.conf)で指定します。 パラメータが必須であることが明示されていない限り、すべてのパラメータは任意です。

このページは次の構成になっています。

  • パラメータの概要(パラメータの詳細を確認するには、その名前をクリックしてください)
  • パラメータの詳細
パラメータ 説明
AllowedAPIMethods ブリッジアダプター経由で呼び出すことができるZabbix APIメソッドを指定します。
DataDir ブリッジアダプターの状態ファイルと暗号化キーを作成および保存するディレクトリを指定します。
DebugLevel デバッグレベルを設定します。
Include 設定ファイルに含めるディレクトリまたは個別のファイルを指定します。
ListenHealthPort 受信HTTPヘルスチェック接続を待ち受けるポートを指定します。
ListenIP Zabbixサーバーからの受信HTTP(S)接続を待ち受けるIPアドレスまたはホスト名を指定します。
ListenPort Zabbixサーバーからの受信HTTP(S)接続を待ち受けるポートを指定します。
LogFile ブリッジアダプターのログファイルを指定します。
LogFileSize ログファイルの最大サイズ(MB)を設定します。
LogType ログ出力タイプを指定します。
PidFile PIDファイルを指定します。
ServerId Zabbixサーバーの一意の識別子を指定します。必須。
TLSConfig.AllowedCN 許可するクライアントのCommon Nameをカンマ区切りで指定します(mTLSのみ)。
TLSConfig.CAFile mTLSモードでクライアント証明書の検証に使用する最上位CA証明書を含むファイルの完全パスを指定します。
TLSConfig.CertFile 証明書または証明書チェーンを含むファイルの完全パスを指定します。
TLSConfig.KeyFile 秘密鍵を含むファイルの完全パスを指定します。
TLSConfig.Mode ListenPortで受信接続に使用するTLSモードを設定します。
ZabbixAPITLSCAFile Zabbix API証明書の検証にブリッジアダプターが使用する最上位CA証明書を含むファイルの完全パス名を指定します。
ZabbixAPITLSConnect Zabbix APIへの送信接続に使用するTLSモードを設定します。
ZabbixAPIURL Zabbix APIエンドポイントのURLを指定します。必須。
ZabbixBridgeURL Zabbix Bridge設定の取得に使用するZabbix Bridge URLを指定します(ブリッジアダプターの起動時に取得されます)。

次の点に注意してください。

  • デフォルト値は、提供されている設定ファイルの値ではなく、プロセスのデフォルト値を反映しています。
  • 値では環境変数を使用できます。
  • Zabbixがサポートする設定ファイルは、BOMなしのUTF-8エンコーディングのみです。
  • #で始まるコメントは、行の先頭にある場合のみサポートされます。

パラメータの詳細

AllowedAPIMethods

bridge adapter を介して呼び出すことができる Zabbix API メソッドを指定します。
複数のメソッドを指定する場合は、パラメータをメソッドごとに1行ずつ繰り返します。

各パラメータ値には、完全一致するメソッド名(例: problem.get)、API 名全体のみを置き換えるワイルドカードパターン(例: *.get)、またはメソッド名全体を置き換えるワイルドカードパターン(例: problem.*)のいずれかを指定する必要があります。

その他の値は無効であり、bridge adapter の起動を妨げます。 これには、単独のワイルドカード(*)、部分的なワイルドカードパターン(host* または host*.*)、空の値(AllowedAPIMethods=)が含まれます。

例:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=problem.*
AllowedAPIMethods=*.get

Zabbix モバイルアプリに必要なメソッドの最小セット:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=device.onboard
AllowedAPIMethods=device.offboard
AllowedAPIMethods=user.get
AllowedAPIMethods=role.get
AllowedAPIMethods=problem.get
AllowedAPIMethods=event.get
AllowedAPIMethods=event.acknowledge
AllowedAPIMethods=trigger.get
AllowedAPIMethods=alert.get
AllowedAPIMethods=host.get
AllowedAPIMethods=hostgroup.get

デフォルト: 未設定(すべての Zabbix API メソッドが拒否されます)

DataDir

ブリッジアダプターの状態ファイルと暗号化キーを作成および保存するディレクトリを指定します。
ディレクトリは存在し、0700 の権限が設定されている必要があります。また、ディレクトリに保存されるすべてのファイルには 0600 の権限が設定されている必要があります。

デフォルト: /var/lib/zabbix-bridge-adapter

DebugLevel

デバッグレベルを設定します。

  • 0 - Zabbixプロセスの開始および停止に関する基本情報
  • 1 - 重大な情報
  • 2 - エラー情報
  • 3 - 警告
  • 4 - デバッグ用(大量の情報を出力)
  • 5 - 拡張デバッグ(さらに多くの情報を出力)

デフォルト: 3
範囲: 0-5

Include

設定ファイルに含めるディレクトリまたは個別のファイルを指定します。
Zabbixのインストール時、このパラメータは、コンパイル時に変更しない限り、/etc/zabbixに設定されます。

Includeパラメータの一般的なルール:

  • パスは、zabbix_bridge_adapter.confファイルの場所を基準にした相対パスにできます。
  • 1つの設定ファイルに複数のIncludeパラメータを指定できます。
  • ZabbixはIncludeパラメータを読み取るとすぐに処理するため、設定ファイルの末尾に配置することを検討してください。

インクルードするファイルのルール:

  • 各ファイルは読み取り可能でなければなりません。
  • 各ファイルの構文は正しくなければなりません。正しくない場合、コンポーネントは起動しません。

ディレクトリまたはファイルパターンをインクルードする場合のルール:

  • インクルードの順序を想定しないでください(ファイルはアルファベット順にインクルードされるとは限りません)。
  • 同じパラメータを複数のインクルードファイルで定義しないでください(例: 一般的な設定を特定の設定で上書きする場合)。どの値が使用されるかを予測できないためです。
  • 一部のテキストエディタが自動的に作成するバックアップコピーに注意してください(例: include/my_specific.confを編集すると、include/my_specific.conf.BAKが作成される場合があります)。この場合、両方のファイルがインクルードされます。

ディレクトリから関連するファイルのみをインクルードするには、パターンマッチングにワイルドカード(*)を使用します。

例:

Include=/absolute/path/to/config/files/*.conf
ListenHealthPort

受信するHTTPヘルスチェック接続をリッスンするポートを指定します。
/health および /ready エンドポイントを提供します。
指定しない場合、ヘルスサービスは開始されません。

デフォルト: 8081
範囲: 1024-32767

ListenIP

Zabbixサーバーからの受信HTTP(S)接続をリッスンするIPアドレスまたはホスト名を指定します。
指定しない場合、ブリッジアダプターはローカルシステムで利用可能なすべてのIPアドレスをリッスンします。

ListenPort

Zabbixサーバーからの受信HTTP(S)接続をリッスンするポートを指定します。

デフォルト: 10054
範囲: 1024-32767

LogFile

ブリッジアダプターのログファイルを指定します。

必須: LogType が file に設定されている場合は はい、それ以外の場合はいいえ

デフォルト: /tmp/zabbix_bridge_adapter.log

LogFileSize

ログファイルの最大サイズ(MB)を設定します。
0 - 自動ログローテーションを無効にします。

デフォルト: 1
範囲: 0-1024

LogType

ログ出力タイプを指定します。

  • file - LogFile パラメータで指定したファイルにログを書き込みます。
  • system - syslog にログを書き込みます。
  • console - 標準出力にログを書き込みます。

デフォルト: file

PidFile

PIDファイルを指定します。

デフォルト: /tmp/zabbix_bridge_adapter.pid

ServerId

Zabbixサーバーの一意の識別子を指定します。
ZabbixのWebインターフェースのレポート > システム情報で確認できます。

必須: はい

TLSConfig.AllowedCN

許可するクライアントのCommon Nameのカンマ区切りリストを指定します(mTLSのみ)。
指定しない場合、ブリッジアダプターはクライアントのCommon Nameを確認しません。

TLSConfig.CAFile

mTLS モードでクライアント証明書の検証に使用する、最上位 CA 証明書を含むファイルへのフルパスを指定します。

TLSConfig.CertFile

証明書または証明書チェーンを含むファイルのフルパスを指定します。

TLSConfig.KeyFile

秘密鍵を含むファイルのフルパスを指定します。

TLSConfig.Mode

ListenPortで受信接続のTLSモードを設定します。

  • none - 暗号化なしで接続を受け入れます。
  • tls - v1.2以上を使用する標準TLSです。
  • mtls - 相互認証によってTLSを拡張します。

デフォルト: none

関連項目: ZabbixサーバーからZabbixブリッジアダプターへのTLS

ZabbixAPITLSCAFile

ブリッジアダプターが Zabbix API の証明書を検証するために使用する、最上位 CA 証明書を含むファイルの完全なパス名を指定します。

必須: ZabbixAPITLSConnect が verify_ca または verify_full に設定されている場合は はい。

ZabbixAPITLSConnect

Zabbix APIへの送信接続に使用するTLSモードを設定します。

  • disabled - プレーンHTTPを使用します。ZabbixAPIURL には http:// を使用する必要があります。
  • required - 証明書の検証なしでHTTPSを使用します(テスト専用)。
  • verify_ca - HTTPSを使用し、Zabbix APIの証明書を検証します。
  • verify_full - HTTPSを使用し、Zabbix APIの証明書とホスト名を検証します。

空の値または未設定の場合は、required として扱われます。

デフォルト: required

関連項目: ZabbixブリッジアダプターからZabbix APIへのTLS

ZabbixAPIURL

Zabbix APIエンドポイントのURLを指定します。

必須: はい

例:

ZabbixAPIURL=https://example.com/zabbix/api_jsonrpc.php
ZabbixBridgeURL

Zabbix Bridgeの設定を取得するためのZabbix Bridge URLを指定します(ブリッジアダプターの起動時に取得されます)。

デフォルト: ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration