Documentation
Table of Contents
8 MSSQLプラグイン
概要
このセクションでは、MSSQL Zabbix エージェント 2 プラグインの設定ファイル (mssql.conf) でサポートされているパラメータの一覧を示します。
MSSQL プラグインは読み込み可能なプラグインであり、MSSQL プラグイン リポジトリ で利用可能で、詳細な説明も記載されています。
以下の点にご注意ください。
- デフォルト値は出荷時設定ファイルの値ではなく、プロセスのデフォルト値です。
- 値は 環境変数 をサポートしています。
- Zabbix は BOM なしの UTF-8 エンコードの設定ファイルのみをサポートしています。
- "#" で始まるコメントは、行の先頭でのみサポートされます。
パラメータ
| パラメータ | 必須 | 範囲 | デフォルト | 説明 |
|---|---|---|---|---|
| Plugins.MSSQL.CustomQueriesDir | no | empty | プラグインが実行できるカスタムクエリを含むユーザー定義の .sql ファイルを含むディレクトリへのファイルパスを指定します。プラグインは起動時に、設定されたディレクトリにある利用可能なすべての .sql ファイルを読み込みます。つまり、カスタムクエリファイルへの変更は、プラグインを再起動するまで反映されません。プラグインは、Zabbix エージェント 2 と同時に起動および停止されます。 | |
| 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 | グローバルタイムアウト | セッション中の初回接続時および後続の操作時にサーバーからの応答を待機する時間（秒単位） |
参照:
- Zabbixエージェント2の一般的な設定パラメータの説明: Zabbixエージェント2 (UNIX) / Zabbixエージェント2 (Windows)
- プラグインの設定手順