5 Zabbix エージェント (Windows)

概要

Windows Zabbixエージェントの設定ファイル（zabbix_agentd.conf）でサポートされているパラメータをこのセクションに一覧表示します。

パラメータは追加情報なしでリストされています。 パラメータをクリックすると詳細が表示されます。

パラメータが必須であると明示的に記載されていない限り、すべてのパラメータは必須ではありません。

注意:

• デフォルト値はデーモンのデフォルト値を反映しており、配布されている設定ファイルの値ではありません。
• 値は環境変数をサポートします。
• ZabbixはUTF-8エンコーディング（BOMなし）のみの設定ファイルをサポートします。
• "#"で始まるコメントは行頭のみサポートされます。

パラメータの詳細

Alias

アイテムキーのエイリアスを設定します。 長くて複雑なアイテムキーを、短くて簡単なものに置き換えるために使用できます。
複数のAliasパラメータを指定できます。 同じAliasキーの複数のパラメータは許可されていません。
異なるAliasキーが同じアイテムキーを参照することができます。
エイリアスはHostMetadataItemで使用できますが、HostnameItemやPerfCounterパラメータでは使用できません。

例1: サーバーからページファイルの使用率（パーセンテージ）を取得する。

Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]

この場合、短縮キーpg_usageを使用してデータを取得できます。

例2: デフォルトおよびカスタムパラメータでCPU負荷を取得する。

Alias=cpu.load:system.cpu.load
       Alias=cpu.load[*]:system.cpu.load[*]

これにより、cpu.loadキーを使用してデフォルトパラメータでCPU負荷を取得したり、cpu.load[percpu,avg15]を使用してCPU負荷の特定データを取得したりできます。

例3: 同じディスカバリアイテムを処理する複数のローレベルディスカバリルールを実行する。

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

これで、vfs.fs.discoveryを使用して、各ルールごとに異なるパラメータ（例：vfs.fs.discovery[foo]、vfs.fs.discovery[bar]など）で複数のディスカバリルールを設定できます。

AllowKey

パターンに一致するアイテムキーの実行を許可します。 キーのパターンはワイルドカード式であり、"*" 文字を使用して任意の文字列に一致させることができます。
DenyKeyと組み合わせて複数のキー一致ルールを定義できます。 パラメータは、記述された順に1つずつ処理されます。 参考: エージェントチェックの制限

BufferSend

N秒を超えてバッファ内にデータを保持しません。

デフォルト: 5
範囲: 1-3600

BufferSize

メモリバッファ内の値の最大数。 バッファがいっぱいになると、エージェントは収集したすべてのデータをZabbixサーバーまたはプロキシに送信します。

デフォルト: 100
範囲: 2-65535

DebugLevel

デバッグレベルを指定します。
0 - Zabbix プロセスの起動と停止に関する基本情報
1 - 重要な情報
2 - エラー情報
3 - 警告
4 - デバッグ用（多くの情報を生成します）
5 - 拡張デバッグ（さらに多くの情報を生成します）

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

DenyKey

パターンに一致するアイテムキーの実行を拒否します。 キーのパターンはワイルドカード式で、「*」文字を使用して任意の文字列に一致させることができます。
AllowKeyと組み合わせて複数のキー一致ルールを定義できます。 パラメータは、記述順に1つずつ処理されます。 参考: エージェントチェックの制限

EnableRemoteCommands

Zabbixサーバーからのリモートコマンドを許可するかどうか。 このパラメータは非推奨です。代わりにAllowKey=system.run[*]またはDenyKey=system.run[*]を使用してください。
値に応じてAllowKey/DenyKeyパラメータの内部エイリアスです。
0 - DenyKey=system.run[*]
1 - AllowKey=system.run[*]

デフォルト: 0
値: 0 - 許可しない, 1 - 許可する

HeartbeatFrequency

ハートビートメッセージの頻度（秒単位）。 アクティブチェックの可用性を監視するために使用されます。
0 - ハートビートメッセージを無効にします。

デフォルト: 60
範囲: 0-3600

HostInterface

ホストの自動登録プロセス中に使用されるホストインターフェース（IPアドレスまたはDNS名）を定義するオプションパラメーターです。 この値は新しく作成されたホストのインターフェースに設定され、IPまたはDNSアドレスのいずれかを明示的に設定できます。 詳細はDNSをデフォルトインターフェースとして使用するを参照してください。

定義されていない場合は、HostInterfaceItemから値が取得されます。

値が255文字を超える場合、エージェントはエラーを出して起動しません。

範囲: 0～255文字

HostInterfaceItem

ホストの自動登録プロセス中にホストインターフェース（IPアドレスまたはDNS名）を決定するために使用されるアイテムを定義するオプションパラメーターです。 この値は、HostInterfaceが定義されていない場合にのみ使用されます。 詳細については、デフォルトインターフェースとしてDNSを使用するを参照してください。

自動登録リクエスト中に、指定されたアイテムによって返される値が255文字の制限を超えている場合、エージェントは警告メッセージをログに記録します。

system.run[]アイテムは、AllowKey/DenyKey設定に関係なくサポートされます。

HostMetadata

ホストの自動登録プロセス（アクティブエージェント）中にホストを識別または区別するために使用されるメタデータを定義するオプションパラメータです。 HostMetadataを使用すると、ホスト名以外でホストを区別できます。

定義されていない場合は、HostMetadataItemから値が取得されます。

指定された値が2034バイトを超える場合や、UTF-8以外の文字列の場合、エージェントはエラーを出して起動しません。 パラメータがIPアドレスまたはDNS名を期待する場合、有効なUTF-8であっても有効なIPまたはDNS名でない値は無効として拒否され、報告されます。

複数行のメタデータはサポートされていません。出力は最初の改行で切り捨てられます。

範囲: 0-2034バイト

HostMetadataItem

Zabbixエージェントアイテムを定義するオプションパラメータで、ホストメタデータの取得に使用されます。 このオプションは、HostMetadataが定義されていない場合にのみ使用されます。

HostMetadataItemの値は、各自動登録試行時に取得され、ホストの自動登録プロセス（アクティブエージェント）でのみ使用されます。 HostMetadataItemを使用すると、ホスト名以外でもホストを区別できます。

ユーザーパラメータ、パフォーマンスカウンタ、エイリアスがサポートされています。 system.run[]アイテムは、AllowKey/DenyKeyの設定に関係なくサポートされます。

自動登録リクエスト時に、指定されたアイテムによって返される値が65535 UTF-8コードポイントの制限を超える場合、エージェントは警告メッセージをログに記録します。 アイテムによって返される値はUTF-8文字列でなければならず、そうでない場合は無視されます。 パラメータがIPアドレスまたはDNS名を期待する場合、有効なUTF-8であっても有効なIPまたはDNS名でない値は拒否され、無効として報告されます。

複数行のメタデータはサポートされていません — 出力は最初の改行で切り捨てられます。

Hostname

カンマ区切りで指定された、ユニークで大文字小文字を区別するホスト名のリスト。 アクティブチェックに必要であり、サーバーで設定されたホスト名と一致する必要があります。 未定義の場合はHostnameItemから値が取得されます。
使用可能な文字: 英数字、'.'、' '、'_'、'-' 最大長: ホスト名ごとに128文字、1行全体で2048文字。

デフォルト: HostnameItemで設定

HostnameItem

ホスト名の取得に使用するZabbixエージェントアイテムを定義するオプションパラメータです。 このオプションは、Hostnameが定義されていない場合にのみ使用されます。 ユーザーパラメータ、パフォーマンスカウンタ、エイリアスはサポートされていませんが、system.run[]アイテムはAllowKey/DenyKeyの値に関係なくサポートされています。
より詳細な説明も参照してください。

デフォルト: system.hostname

Include

個別のファイルやディレクトリ内のすべてのファイルを、設定ファイルに含めることができます（ZabbixエージェントがWindows MSIインストーラーパッケージを使用してインストールされた場合はデフォルトでC:\Program Files\Zabbix Agentにあります。Zabbixエージェントがzipアーカイブとしてインストールされた場合は、インストール時に指定したフォルダにあります）。 含めるすべてのファイルは正しい構文でなければならず、そうでない場合はエージェントが起動しません。
指定したディレクトリ内の関連ファイルのみを含めるために、アスタリスクワイルドカード文字によるパターンマッチングがサポートされています。
制限事項については特記事項を参照してください。

例:

Include=C:\Program Files\Zabbix Agent\zabbix_agentd.d\*.conf

ListenBacklog

TCP キュー内の保留中の接続の最大数。
デフォルト値はシステムに依存するハードコードされた定数です。
サポートされる最大値はシステムに依存し、値が大きすぎる場合は'実装で指定された最大値'で自動的に切り捨てられる場合があります。

デフォルト: SOMAXCONN
範囲: 0 - INT_MAX

ListenIP

エージェントが待受するIPアドレスのカンマ区切りリスト

デフォルト: 0.0.0.0

ListenPort

エージェントは、サーバーからの接続をこのポートで待受します。

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

LogFile

エージェントのログファイル名。

デフォルト: c:\zabbix_agentd.log
必須: LogTypeがfileに設定されている場合は必須、それ以外は不要

LogFileSize

ログファイルの最大サイズ（MB）
0 - 自動ログローテーションを無効にします。
注: ログファイルのサイズ制限に達し、何らかの理由でファイルローテーションが失敗した場合、既存のログファイルは切り捨てられ、新たに開始されます。

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

LogRemoteCommands

実行されたシェルコマンドを警告としてログに記録するかどうかを設定します。 コマンドはリモートで実行された場合のみログに記録されます。 system.run[]がHostMetadataItem、HostInterfaceItem、HostnameItemパラメータによってローカルで起動された場合は、ログエントリは作成されません。

デフォルト: 0
値: 0 - 無効, 1 - 有効

LogType

ログ出力の種類:
file - LogFile パラメータで指定されたファイルにログを書き込みます。
system - Windows イベントログにログを書き込みます。
console - 標準出力にログを書き込みます。

デフォルト: file

MaxLinesPerSecond

'log'、'logrt'、'eventlog'のアクティブチェックを処理する際に、エージェントがZabbixサーバーまたはプロキシに1秒あたりに送信する新しい行の最大数です。 指定された値は、'log'、'logrt'、'eventlog'アイテムキーで指定された'maxlines'パラメータによって上書きされます。
注意: Zabbixは、MaxLinesPerSecondで設定された値の10倍の新しい行を処理して、ログアイテムで必要な文字列を検索します。

デフォルト: 20
範囲: 1-1000

PerfCounter

指定された期間<period>（秒単位）におけるシステムパフォーマンスカウンター<perf_counter_path>の平均値である新しいパラメータ<parameter_name>を定義します。
構文: <parameter_name>,"<perf_counter_path>",<period>

例えば、過去1分間のプロセッサ割り込み数の平均値を取得したい場合は、次のように新しいパラメータ"interrupts"を定義できます:

PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60

パフォーマンスカウンターパスの周囲に二重引用符が必要であることに注意してください。 パラメータ名（interrupts）は、アイテム作成時のアイテムキーとして使用します。 平均値を計算するためのサンプルは毎秒取得されます。
Windowsで利用可能なすべてのパフォーマンスカウンターのリストを取得するには、"typeperf -qx"を実行してください。

PerfCounterEn

指定された時間間隔<period>（秒単位）で、システムパフォーマンスカウンタ<perf_counter_path>の平均値となる新しいパラメータ<parameter_name>を定義します。 PerfCounterと比較して、perfcounterパスは英語でなければなりません。 Windows Server 2008/Vista以降でのみサポートされています。
構文: <parameter_name>,"<perf_counter_path>",<period>

たとえば、過去1分間のプロセッサ割り込み数の平均値を取得したい場合は、次のように新しいパラメータ"interrupts"を定義できます:

PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60

パフォーマンスカウンタパスの周囲に二重引用符が必要であることに注意してください。 パラメータ名（interrupts）は、アイテム作成時のアイテムキーとして使用します。 平均値を計算するためのサンプルは、毎秒取得されます。
英語の文字列のリストは、次のレジストリキーを参照してください: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009。

RefreshActiveChecks

アクティブチェックのリストをリフレッシュする間隔(秒)。 アクティブチェックのリフレッシュに失敗した場合、次のリフレッシュは60秒後に試行されます。

デフォルト: 5
範囲: 1-86400

Server

ZabbixサーバーまたはZabbixプロキシのIPアドレス（カンマ区切り、CIDR表記も可）またはDNS名のリスト。 ここに記載されたホストからの接続のみ受け付けます。 IPv6サポートが有効な場合、'127.0.0.1'、'::127.0.0.1'、'::ffff:127.0.0.1'は同等に扱われ、'::/0'はすべてのIPv4またはIPv6アドレスを許可します。 '0.0.0.0/0'はすべてのIPv4アドレスを許可するために使用できます。 「IPv4互換IPv6アドレス」（0000::/96プレフィックス）はサポートされていますが、RFC4291で非推奨となっていますのでご注意ください。 スペースも許可されます。

例:

Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

必須: StartAgentsが明示的に0に設定されていない場合は必須

ServerActive

アクティブチェックを取得するためのZabbixサーバー/プロキシのアドレスまたはクラスタ構成。 サーバー/プロキシのアドレスは、IPアドレスまたはDNS名と、コロンで区切られたオプションのポートです。
クラスタ構成は、セミコロンで区切られた1つ以上のサーバーアドレスです。 複数のZabbixサーバー/クラスタおよびZabbixプロキシをカンマで区切って指定できます。 各Zabbixサーバー/クラスタから複数のZabbixプロキシを指定すべきではありません。 Zabbixプロキシが指定されている場合、そのプロキシのZabbixサーバー/クラスタは指定しないでください。
複数のカンマ区切りのアドレスを指定することで、複数の独立したZabbixサーバーを並列で使用できます。 スペースも許可されます。
ポートが指定されていない場合は、デフォルトのポートが使用されます。
IPv6アドレスでホストのポートを指定する場合は、角括弧で囲む必要があります。 ポートが指定されていない場合、IPv6アドレスの角括弧は省略可能です。
このパラメータが指定されていない場合、アクティブチェックは無効になります。

Zabbixプロキシの例:

ServerActive=127.0.0.1:10051

複数サーバーの例:

ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]

高可用性の例:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3

2つのクラスタと1つのサーバーによる高可用性の例:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain

範囲: (*)

SourceIP

以下のための送信元IPアドレス:

• ZabbixサーバーまたはZabbixプロキシへの外部接続
• 一部のアイテム(web.page.get、net.tcp.portなど)を実行する際の接続

StartAgents

パッシブチェックを処理するzabbix_agentdの事前フォークインスタンスの数。 0に設定すると、パッシブチェックが無効になり、エージェントはTCPポートで待ち受けしません。

デフォルト: 10
範囲: 0-100 (*)

Timeout

Zabbixプロキシまたはサーバーとの接続確立およびデータ交換の待機時間（秒単位）を指定します。

このパラメータは、以下を含むさまざまな通信操作の期間を定義します。

• Zabbixサーバーからの応答を待つ
• アイテム設定リクエストやアクティブチェックでのアイテムデータなど、Zabbixサーバーへのリクエスト送信
• logfileまたはWindowsイベントログ監視によるログデータの取得
• ハートビートメッセージの送信
• vfs.*チェックの最大実行時間
• Zabbixエージェントモジュールで使用
• バージョン7.0より前のサーバーまたはプロキシがタイムアウトなしでチェックを送信する場合のフォールバックとして使用

このタイムアウトは、フロントエンドでタイムアウト設定が可能なエージェントチェック（グローバル、プロキシ、アイテム単位）には使用されません。

デフォルト: 3
範囲: 1-30

TLSAccept

受け入れる着信接続。 パッシブチェックで使用されます。 複数の値をカンマで区切って指定できます。
unencrypted - 暗号化なしの接続を受け入れる（デフォルト）
psk - TLSと事前共有鍵（PSK）による接続を受け入れる
cert - TLSと証明書による接続を受け入れる

必須: TLS証明書またはPSKパラメータが定義されている場合は必須（unencrypted接続でも）。それ以外は不要

TLSCAFile

Zabbix コンポーネント間の暗号化通信に使用される、ピア証明書検証用の最上位 CA 証明書を含むファイルのフルパス名

TLSCertFile

Zabbix コンポーネントとの暗号化通信に使用されるエージェント証明書または証明書チェーンを含むファイルのフルパス名

TLSConnect

エージェントがZabbixサーバーまたはプロキシにどのように接続するか。 アクティブチェックで使用されます。 1つの値のみ指定できます:
unencrypted - 暗号化せずに接続（デフォルト）
psk - TLSおよび事前共有鍵（PSK）を使用して接続
cert - TLSおよび証明書を使用して接続

必須: TLS証明書またはPSKパラメータが定義されている場合は必須（unencrypted接続でも）; それ以外は不要

TLSCRLFile

失効した証明書を含むファイルのフルパス名です。 このパラメータは、Zabbixコンポーネント間の暗号化通信に使用されます。

TLSKeyFile

Zabbix コンポーネント間の暗号化通信に使用されるエージェント秘密鍵を含むファイルのフルパス名

TLSPSKFile

Zabbix サーバーとの暗号化通信に使用されるエージェントの事前共有キーを含むファイルのフルパス名

TLSPSKIdentity

Zabbixサーバーとの暗号化通信に使用される、事前共有キーのID文字列

TLSServerCertIssuer

許可されたサーバー（プロキシ）証明書の発行者

TLSServerCertSubject

許可されたサーバー（プロキシ）証明書のサブジェクト

UnsafeUserParameters

ユーザー定義パラメータへの引数としてすべての文字の使用を許可します。 次の文字は許可されません: \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @
さらに、改行文字も許可されません。

デフォルト: 0
値: 0 - 許可しない、1 - 許可する

UserParameter

監視するユーザー定義パラメータ。 ユーザー定義パラメータは複数指定できます。
フォーマット: UserParameter=<キー>,<シェルコマンド>
シェルコマンドは空文字列やEOLのみを返してはいけません。 UserParameterDirパラメータが指定されている場合、シェルコマンドは相対パスでも指定できます。

例:

UserParameter=system.test,dir /b | find /c /v ""
       UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

UserParameterコマンドのデフォルトの検索パスです。 使用する場合、エージェントはコマンドを実行する前にここで指定された作業ディレクトリに変更します。 これにより、UserParameterコマンドはフルパスの代わりに相対的な./プレフィックスを持つことができます。 1つのエントリのみ許可されます。

例:

UserParameterDir=C:\opt\myscripts