MSSQLプラグイン

概要

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

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

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

特に明記されていない限り、すべてのパラメータは任意です。

注意:

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

Parameter details

Plugins.MSSQL.CustomQueriesDir

Specify path to the directory containing user-defined .sql files with custom queries that the plugin can execute.
The plugin loads all available .sql files in the configured directory at startup. This means that any changes to the custom query files will not be reflected until the plugin is restarted. The plugin is started and stopped together with Zabbix agent 2.

Defaults:
/usr/local/share/zabbix/custom-queries/mssql - for Unix systems,
*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL - for Windows systems (where * is the drive name from the ProgramFiles environment variable)

Plugins.MSSQL.CustomQueriesEnabled

Enable execution of the mssql.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false Range: true/false

Plugins.MSSQL.Default.CACertPath

Specify the default file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server.
The certificate must be in PEM format.

Plugins.MSSQL.Default.Database

Specify the default database name.

Plugins.MSSQL.Default.Encrypt

Specify the level of default encryption.

Range:
true - data sending between plugin and server is encrypted;
false - data sending between plugin and server is not encrypted beyond the login packet;
strict - data sending between plugin and server is encrypted E2E using TDS8;
disable - data sending between plugin and server is not encrypted.

Plugins.MSSQL.Default.HostNameInCertificate

Specify the common name (CN) of the MSSQL server certificate by default.

Plugins.MSSQL.Default.Password

Specify the default password for a protected MSSQL server.

Plugins.MSSQL.Default.TLSMinVersion

Specify the minimum TLS version by default.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Trust the server certificate without validating it by default.

Range: true, false

Plugins.MSSQL.Default.Uri

Specify the default URI for connecting to MSSQL server.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Specify the default username for a protected MSSQL server.

Plugins.MSSQL.KeepAlive

Specify the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300 Range: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Specify the named session file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server.
<SessionName> - define name of a session for using in item keys.
The certificate must be in PEM format.

Plugins.MSSQL.Sessions.<SessionName>.Database

Specify the named session database name.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Specify the level of named session encryption.
<SessionName> - define name of a session for using in item keys.

Range:
true - data sending between plugin and server is encrypted;
false - data sending between plugin and server is not encrypted beyond the login packet;
strict - data sending between plugin and server is encrypted E2E using TDS8;
disable - data sending between plugin and server is not encrypted.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Specify the common name (CN) of the MSSQL server certificate for named session.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Password

Specify the named session password for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Specify the named session minimum TLS version.
<SessionName> - define name of a session for using in item keys.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Trust the named session server certificate without validating it.
<SessionName> - define name of a session for using in item keys.

Range: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to MSSQL server.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Specify the named session username for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.System.Path

Specify path to the MSSQL plugin executable.
Global setting for the MSSQL plugin. Applied to all connections.

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

Plugins.MSSQL.Timeout

Set the duration, in seconds, to wait for a server to respond when first connecting and on follow-up operations in the session.

Default: default timeout Range: 1-30

オプション

Parameter Description
-V --version プラグインのバージョンとライセンス情報を表示します。
-h --help ヘルプ情報を表示します（省略形）。
-t, --test <item key> テスト用にプラグインを起動します（プラグイン設定は無視されます）。

パラメーター

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /usr/local/share/zabbix/custom-queries/mssql for Unix systems

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL for Windows systems, where * is the drive name from the ProgramFiles environment variable		 プラグインが実行できるカスタムクエリを含むユーザー定義の .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 最初の接続時およびセッション内の後続操作で、サーバーの応答を待つ時間（秒）です。

関連情報: