8 MSSQLプラグイン

概要

このセクションでは、MSSQL Zabbix エージェント 2 プラグインの設定ファイル (mssql.conf) でサポートされるパラメータを一覧表示します。

MSSQL プラグインはロード可能なプラグインであり、MSSQL plugin repository で利用可能で、詳細が完全に説明されています。

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

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

オプション

Parameter Description
-V --version プラグインのバージョンとライセンス情報を表示します。
-h --help ヘルプ情報を表示します（省略形）。

パラメータ

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no Unix システムでは /usr/local/share/zabbix/custom-queries/mssql

Windows システムでは *:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL。ここで * は ProgramFiles 環境変数のドライブ名です		 プラグインが実行できるカスタムクエリを含む、ユーザー定義の .sql ファイルが格納されたディレクトリへのファイルパスを指定します。プラグインは起動時に、設定されたディレクトリ内の利用可能なすべての .sql ファイルを読み込みます。つまり、カスタムクエリファイルへの変更は、プラグインを再起動するまで反映されません。プラグインは Zabbix エージェント 2 とともに起動および停止します。
Plugins.MSSQL.CustomQueriesEnabled no false 設定すると、mssql.custom.query アイテムキーの実行を有効にします。無効の場合、カスタムクエリディレクトリのパスからクエリは読み込まれません。
Plugins.MSSQL.Default.CACertPath no MSSQL サーバーの証明書を発行した認証局 (CA) の公開鍵証明書へのデフォルトのファイルパスです。証明書は PEM 形式である必要があります。
Plugins.MSSQL.Default.Database no 接続先のデフォルトデータベース名です。
Plugins.MSSQL.Default.Encrypt no デフォルトの接続暗号化タイプを指定します。指定可能な値は次のとおりです:
true - プラグインとサーバー間のデータ送信は暗号化されます;
false - プラグインとサーバー間のデータ送信は、ログインパケット以外は暗号化されません;
strict - プラグインとサーバー間のデータ送信は、TDS8 を使用して E2E で暗号化されます;
disable - プラグインとサーバー間のデータ送信は暗号化されません。
Plugins.MSSQL.Default.HostNameInCertificate no MSSQL サーバー証明書の共通名 (CN) です。
Plugins.MSSQL.Default.Password no 保護された MSSQL サーバーに送信するデフォルトのパスワードです。
Plugins.MSSQL.Default.TLSMinVersion no デフォルトで使用する最小 TLS バージョンです。指定可能な値は 1.0、1.1、1.2、1.3 です。
Plugins.MSSQL.Default.TrustServerCertificate no プラグインがサーバー証明書を検証せずに信頼するかどうかを指定します。指定可能な値: true、false。
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 接続先のデフォルト URI です。サポートされるスキーマは sqlserver:// のみです。スキーマは省略できます。埋め込み資格情報は無視されます。
Plugins.MSSQL.Default.User no 保護された MSSQL サーバーに送信するデフォルトのユーザー名です。
Plugins.MSSQL.KeepAlive no 60-900 300 未使用のプラグイン接続が閉じられるまでの最大待機時間（秒）です。
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no 指定したセッションの MSSQL サーバー証明書を発行した認証局 (CA) の公開鍵証明書へのファイルパスです。証明書は PEM 形式である必要があります。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Database no 指定したセッションの接続先データベース名です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no 指定したセッションの接続暗号化タイプを指定します。指定可能な値は次のとおりです:
true - プラグインとサーバー間のデータ送信は暗号化されます;
false - プラグインとサーバー間のデータ送信は、ログインパケット以外は暗号化されません;
strict - プラグインとサーバー間のデータ送信は、TDS8 を使用して E2E で暗号化されます;
disable - プラグインとサーバー間のデータ送信は暗号化されません。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no 指定したセッションの MSSQL サーバー証明書の共通名 (CN) です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Password no 指定したセッションの保護された MSSQL サーバーに送信するパスワードです。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no 指定したセッションで使用する最小 TLS バージョンです。指定可能な値は 1.0、1.1、1.2、1.3 です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no プラグインが指定したセッションのサーバー証明書を検証せずに信頼するかどうかを指定します。指定可能な値: true、false。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 指定したセッションの接続先 URI です。サポートされるスキーマは sqlserver:// のみです。スキーマは省略できます。埋め込み資格情報は無視されます。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.User no 指定したセッションの保護された MSSQL サーバーに送信するユーザー名です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.System.Path no MSSQL プラグイン実行ファイルへのパスです。
MSSQL プラグインのグローバル設定です。すべての接続に適用されます。
使用例: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout サーバーが応答するまで待機する時間（秒）です。初回接続時およびセッション内の後続操作時に適用されます。

関連情報: