MSSQLプラグイン

概要

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

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

MSSQLプラグインはロード可能なプラグインであり、MSSQL plugin repository にて利用可能で、詳細も記載されています。

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

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

• パラメータ概要（パラメータの詳細を表示するには、その名前をクリックします）
• パラメータ詳細

注意事項:

• デフォルト値は、配布される設定ファイル内の値ではなく、プロセスのデフォルト値を反映しています。
• 値には環境変数を使用できます。
• Zabbix がサポートする設定ファイルの文字エンコーディングは UTF-8 のみで、BOM は含められません。
• "\#" で始まるコメントは、行頭でのみサポートされます。

パラメーターの詳細

Plugins.MSSQL.CustomQueriesDir

プラグインが実行できるカスタムクエリを含むユーザー定義の .sql ファイルが格納されたディレクトリへのパスを指定します。
プラグインは、起動時に設定されたディレクトリ内の利用可能なすべての .sql ファイルを読み込みます。 つまり、カスタムクエリファイルへの変更は、プラグインを再起動するまで反映されません。 プラグインは Zabbix エージェント 2 とともに起動および停止します。

デフォルト:
/usr/local/share/zabbix/custom-queries/mssql - Unix システムの場合,
*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL - Windows システムの場合 (* は ProgramFiles 環境変数のドライブ名)

Plugins.MSSQL.CustomQueriesEnabled

mssql.custom.query アイテムキーの実行を有効にします。
無効の場合、カスタムクエリディレクトリのパスからクエリは読み込まれません。

デフォルト: false
範囲: true/false

Plugins.MSSQL.Default.CACertPath

MSSQLサーバーの証明書を発行した認証局（CA）の公開鍵証明書へのデフォルトのファイルパスを指定します。
証明書はPEM形式である必要があります。

Plugins.MSSQL.Default.Database

既定のデータベース名を指定します。

Plugins.MSSQL.Default.Encrypt

デフォルトの暗号化レベルを指定します。

範囲:
true - プラグインとサーバー間で送信されるデータは暗号化されます;
false - プラグインとサーバー間で送信されるデータは、ログインパケット以外では暗号化されません;
strict - プラグインとサーバー間で送信されるデータは、TDS8 を使用して E2E 暗号化されます;
disable - プラグインとサーバー間で送信されるデータは暗号化されません。

Plugins.MSSQL.Default.HostNameInCertificate

既定で MSSQL サーバー証明書のコモンネーム (CN) を指定します。

Plugins.MSSQL.Default.Password

保護された MSSQL サーバーのデフォルトパスワードを指定します。

Plugins.MSSQL.Default.TLSMinVersion

デフォルトで最小の TLS バージョンを指定します。

範囲: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

既定では、サーバー証明書を検証せずに信頼します。

範囲: true, false

Plugins.MSSQL.Default.Uri

MSSQLサーバーに接続するためのデフォルトURIを指定します。
埋め込み資格情報は無視されます。
サポートされているスキーマは sqlserver:// のみです。
スキーマは省略できます。

デフォルト: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

保護された MSSQL サーバーのデフォルトユーザー名を指定します。

Plugins.MSSQL.KeepAlive

未使用のプラグイン接続が閉じられるまでの最大待機時間（秒）を指定します。

デフォルト: 300
範囲: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

MSSQLサーバーの証明書を発行した認証局（CA）の公開鍵証明書への、指定したセッションのファイルパスを指定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。
証明書は PEM 形式である必要があります。

Plugins.MSSQL.Sessions.<SessionName>.Database

指定したセッションのデータベース名を設定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

名前付きセッションの暗号化レベルを指定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

範囲:
true - プラグインとサーバー間のデータ送信は暗号化されます;
false - プラグインとサーバー間のデータ送信は、ログインパケット以外は暗号化されません;
strict - プラグインとサーバー間のデータ送信は、TDS8 を使用して E2E 暗号化されます;
disable - プラグインとサーバー間のデータ送信は暗号化されません。

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

名前付きセッションに対する MSSQL サーバー証明書の共通名 (CN) を指定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MSSQL.Sessions.<SessionName>.Password

保護された MSSQL サーバーの、指定したセッションのパスワードを設定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

指定したセッションの最小 TLS バージョンを設定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

範囲: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

指定したセッションのサーバー証明書を検証せずに信頼します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

範囲: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

MSSQLサーバーに接続するための、名前付きセッションのURIを指定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。
埋め込み資格情報は無視されます。
サポートされているスキーマは sqlserver:// のみです。
スキーマは省略できます。

デフォルト: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

保護された MSSQL サーバーの、指定したセッションのユーザー名を設定します。
<SessionName> - アイテムキーで使用するセッション名を定義します。

Plugins.MSSQL.System.Path

MSSQLプラグインの実行ファイルへのパスを指定します。
MSSQLプラグインのグローバル設定です。すべての接続に適用されます。

例: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql

Plugins.MSSQL.Timeout

最初の接続時およびセッション内の後続の操作で、サーバーからの応答を待機する時間を秒単位で設定します。

デフォルト: global timeout
範囲: 1-30

オプション

関連項目

• 一般的な Zabbix エージェント 2 の設定パラメーターの説明: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
• プラグイン の設定手順