Documentation
Table of Contents
> LLD ruleオブジェクト
次のオブジェクトは、discoveryruleAPIに直接関連しています。
LLD rule
LLDルールオブジェクトには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| itemid | string | (読取専用) LLDルールのID |
| delay (必須) |
string | LLDルールの更新間隔。 接尾辞があり、フレキシブルインターバルかスケジューリング間隔のいずれかで構成される1つ以上のカスタム間隔がある場合とない場合の秒または時間単位をシリアル化された文字列として受け入れます。ユーザーマクロも受け入れます。 フレキシブルインターバルはスラッシュで区切られた2つのマクロとして記述できます。間隔はセミコロンで区切られます。 Zabbixトラッパー、依存アイテム、および mqtt.getキーを使用するZabbixエージェント（アクティブ）の場合は必須ではありません |
| hostid (必須) |
string | LLDルールが属するホストのID |
| interfaceid (必須) |
string | LLDルールのホストインターフェースID。 ホストLLDルールにのみ使用されます。 Zabbixエージェント（アクティブ）、Zabbix内部、Zabbixトラッパー、依存、データベースモニター、およびスクリプトLLDルールには不要です。 HTTPエージェントLLDルールの場合はオプションになります。 |
| key_ (必須) |
string | LLDルールキー |
| name (必須) |
string | LLDルール名 |
| type (必須) |
integer | LLDルールのタイプ。 利用可能な値: 0 - Zabbixエージェント 2 - Zabbixトラッパー 3 - シンプルチェック 5 - Zabbixインターナル 7 - Zabbixエージェント(アクティブ) 10 - 外部チェック 11 - データベースモニター 12 - IPMIエージェント 13 - SSHエージェント 14 - TELNETエージェント 16 - JMXエージェント 18 - 依存アイテム 19 - HTTPエージェント 20 - SNMPエージェント 21 - スクリプト |
| url (必須) |
string | HTTPエージェントLLDルールに必要なURL文字列。 ユーザーマクロ{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}をサポートします。 |
| allow_traps | integer | HTTPエージェントLLDルールフィールド。 トラッパーアイテムタイプと同様に値の入力を許可します。 0 - (デフォルト)受信データの受け入れを許可しません。 1 - 受信データの受け入れを許可します。 |
| authtype | integer | SSHエージェントまたはHTTPエージェントのLLDルールで使用されます。 SSHエージェント認証方法の可能な値: 0 - (デフォルト)パスワード 1 - 公開鍵 HTTPエージェント認証方式の可能な値: 0 - (デフォルト)なし 1 - basic 2 - NTLM |
| error | string | (読取専用)LLDルールの更新に問題がある場合のエラーテキスト |
| follow_redirects | integer | HTTPエージェントLLDルールフィールド。 データのプール中に応答リダイレクトを追跡します。 0 - リダイレクトを追跡しません 1 - (デフォルト)リダイレクトを追跡します。 |
| headers | object | HTTPエージェントLLDルールフィールド。 HTTP(S)リクエストヘッダーを持つオブジェクト。ヘッダー名はキーとして使用され、ヘッダー値は値として使用されます。 例: {"User-Agent": "Zabbix"} |
| http_proxy | string | HTTPエージェントLLDルールフィールド。 HTTP(s)プロキシ接続文字列。 |
| ipmi_sensor | string | IPMIセンサー。 IPMILLDルールでのみ使用されます。 |
| jmx_endpoint | string | JMXエージェントのカスタム接続文字列 デフォルト値: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| lifetime | string | 検出されなくなったアイテムが削除されるまでの期間。 秒、接尾辞付きの時間単位、およびユーザーマクロを受け入れます。 デフォルト: 30d |
| master_itemid | integer | マスターアイテムID 最大3つの従属アイテムの再帰と999の従属アイテム最大数が許可されます。 ディスカバリルールを別のディスカバリルールのマスターアイテムにすることはできません。 従属アイテムに必須です。 |
| output_format | integer | HTTPエージェントLLDルールフィールド。 応答をJSONに変換する必要があります。 0 - (デフォルト)そのまま保存します。 1 - JSONに変換します。 |
| params | string | LLDルールのタイプに応じた追加パラメーター: - SSHおよびTelnetLLDルール用に実行されたスクリプト - データベースモニターLLDルール用のSQLクエリ - 計算されたLLDルール用の式 |
| parameters | array | スクリプトタイプLLDルールの追加パラメーター。 'name'および'value'プロパティを持つオブジェクトの配列。nameは一意である必要があります。 |
| password | string | 認証用のパスワード。シンプルチェック、SSH、Telnet、データベースモニター、JMXおよびHTTPエージェントLLDルールで使用されます。 |
| post_type | integer | HTTPエージェントLLDルールフィールド。 postsプロパティに保存されている投稿データ本文のタイプ。 0 - (デフォルト)そのままのデータ 2 - JSONデータ 3 - XMLデータ |
| posts | string | HTTPエージェントLLDルールフィールド。 HTTP(s)リクエストの本文データ。post_typeとともに使用されます。 |
| privatekey | string | 秘密鍵ファイルの名前 |
| publickey | string | 公開鍵ファイルの名前。 |
| query_fields | array | HTTPエージェントLLDルールフィールド。 クエリパラメータ。 'key'：'value'のペアを持つオブジェクトの配列。valueは空の文字列にすることができます。 |
| request_method | integer | HTTPエージェントLLDルールフィールド。 リクエストメソッドのタイプ。 0 - (デフォルト)GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | integer | HTTPエージェントLLDルールフィールド。応答のどの部分を保存するか。 0 - (デフォルト)本文 1 - ヘッダー 2 - 本文とヘッダーの両方が保存されます request_method HEADの場合、許可される値は1つだけです。 |
| snmp_oid | string | SNMP OID. |
| ssl_cert_file | string | HTTPエージェントLLDルールフィールド。 SSL公開鍵ファイルパス |
| ssl_key_file | string | HTTPエージェントLLDルールフィールド。 SSL秘密鍵ファイルパス |
| ssl_key_password | string | HTTPエージェントLLDルールフィールド。 SSLキーファイルのパスワード。 |
| state | integer | (読取専用)LLDルールの状態 利用可能な値: 0 - (デフォルト)通常 1 - サポートされていません |
| status | integer | LLDルールのステータス 可能な値: 0 - (デフォルト)有効なLLDルール 1 - 無効なLLDルール |
| status_codes | string | HTTPエージェントLLDルールフィールド。 必要なHTTPステータスコードの範囲をコンマで区切ります。 カンマ区切りリストの一部としてユーザーマクロもサポートします。 例:200,200-{$M},{$M},200-400 |
| templateid | string | （読取専用）親テンプレートLLDルールのID |
| timeout | string | アイテムデータのポーリング要求のタイムアウト。 HTTPエージェントおよびスクリプトLLDルールに使用されます。 ユーザーマクロをサポートします。 デフォルト:3s 最大値:60s |
| trapper_hosts | string | 許可されたホスト。 トラッパーLLDルールまたはHTTPエージェントLLDルールによって使用されます。 |
| username | string | 認証用のユーザー名。 シンプルチェック、SSH、Telnet、データベースモニター、JMXおよびHTTPエージェントLLDルールで使用されます。 SSHおよびTelnetLLDルールで必要です。 |
| uuid | string | インポートされたLLDルールを既存のルールにリンクするために使用されるユニバーサル一意識別子。 テンプレートのLLDルールにのみ使用されます。 指定されていない場合は自動生成されます。 更新操作の場合、このフィールドは読取専用です。 |
| verify_host | integer | HTTPエージェントLLDルールフィールド。 URLの検証ホスト名は、ホスト証明書の共通名フィールドまたはサブジェクト代替名フィールドにあります。 0 - (デフォルト)検証しない 1 - 検証する |
| verify_peer | integer | HTTPエージェントLLDルールフィールド。 検証は本物のホスト証明書です。 0 - (デフォルト)検証しない 1 - 検証する |
LLDルールフィルター
LLDルールフィルターオブジェクトは、検出されたオブジェクトをフィルター処理するために使用できる一連の条件を定義します。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| conditions (必須) |
array | 結果のフィルタリングに使用する一連のフィルター条件 |
| evaltype (必須) |
integer | フィルタ条件の評価方法 可能な値: 0 - and/or 1 - and 2 - or 3 - カスタム式 |
| eval_formula | string | (読取専用) フィルタ条件の評価に使用される生成された式。 式にはformulaidによって特定のフィルター条件を参照するIDが含まれています。eval_formulaの値は、カスタム式を持つフィルターのformulaの値と同じです。 |
| formula | string | カスタム式を使用してフィルターの条件を評価するために使用されるユーザー定義の式。 式には、そのformulaidによって特定のフィルター条件を参照するIDが含まれている必要があります。 式で使用されるIDは、フィルター条件で定義されたIDと完全に一致する必要があります。条件を未使用のままにしたり省略したりすることはできません。カスタム式フィルターで使用します。 |
LLDルールフィルター条件
LLDルールフィルター条件オブジェクトは、LLDマクロの値に対して実行する個別のチェックを定義します。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| macro (必須) |
string | チェックを実行するLLDマクロ |
| value (必須) |
string | 比較する値 |
| formulaid | string | カスタム式から条件を参照するために使用される任意のID。 大文字のみを含めることができます。 IDは、フィルター条件を変更するときにユーザーが定義する必要がありますが、後で要求すると新たに生成されます。 |
| operator | integer | 条件演算子。 可能な値: 8 - (デフォルト)正規表現に一致 9 - 正規表現に不一致 12 - 存在する 13 - 存在しない |
さまざまなタイプの式でフィルターを使用する方法をよりよく理解するにはdiscoveryrule.get と discoveryrule.createメソッドページの例を参照してください。
LLDマクロパス
LLDマクロパスには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| lld_macro (必須) |
string | LLDマクロ |
| path (必須) |
string | 対応するマクロに割り当てられる値のセレクター |
LLDルールの事前処理
LLDルールの事前処理オブジェクトには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| type (必須) |
integer | 事前処理オプションタイプ 利用可能な値: 5 - 正規表現の一致 11 - XML XPath 12 - JSONPath 15 - 正規表現の不一致 16 - JSONのエラーチェック 17 - XMLのエラーチェック 20 - ハートビートで変更せずに破棄 23 - プロメテウスからJSON 24 - CSVからJSON 25 - 置換 27 - XMLからJSON |
| params (必須) |
string | 事前処理オプションで使用される追加のパラメーター。 複数のパラメータはLF (\n)文字で区切られます。 |
| error_handler (必須) |
integer | 事前処理ステップが失敗した場合に使用されるアクションタイプ。 利用可能な値: 0 - エラーメッセージはZabbixサーバーによって設定されます 1 - 値を破棄 2 - カスタム値を設定< br>3 - カスタムエラーメッセージを設定 |
| error_handler_params (必須) |
string | エラーハンドラパラメーター。 error_handlerとともに使用されます。error_handlerが0または1の場合は空白にする必要があります。error_handlerが2の場合は空白にすることもできます。error_handlerが3の場合は必須です。 |
次のパラメータとエラーハンドラは、各事前処理タイプでサポートされています。
| 事前処理タイプ | 名前 | パラメーター1 | パラメーター2 | パラメーター3 | サポートされているエラーハンドラ |
|---|---|---|---|---|---|
| 5 | 正規表現 | pattern1 | output2 | 0, 1, 2, 3 | |
| 11 | XML XPath | path3 | 0, 1, 2, 3 | ||
| 12 | JSON Path | path3 | 0, 1, 2, 3 | ||
| 15 | 正規表現と不一致 | pattern1 | 0, 1, 2, 3 | ||
| 16 | JSONエラーチェック | path3 | 0, 1, 2, 3 | ||
| 17 | XMLエラーチェック | path3 | 0, 1, 2, 3 | ||
| 20 | ハートビートで変更せずに破棄 | seconds4, 5, 6 | |||
| 23 | プロメテウスからJSONへ | pattern5, 7 | 0, 1, 2, 3 | ||
| 24 | CSV から JSONへ | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | 置換 | search string2 | replacement2 | ||
| 27 | XML から JSONへ | 0, 1, 2, 3 | |||
1 正規表現
2 string
3 JSONPath または XML XPath
4 正の整数 (時間接尾辞をサポート 例: 30s, 1m, 2h, 1d)
5 user macro
6 LLD macro
7 構文に従ったプロメテウスの出力:<metric name>{<label name>="<label value>", ...} == <value>. Each Prometheus pattern component (metric, label name, label value and metric value) can be user macro.
8 構文に従ったプロメテウスの出力: <label name>.
LLDルールのオーバーライド
LLDルールオーバーライドオブジェクトは、さまざまなプロトタイプオブジェクトのプロパティをオーバーライドするために使用される一連のルール（フィルター、条件、および操作）を定義します。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name (必須) |
string | 一意なオーバーライド名 |
| step (必須) |
integer | オーバーライドの一意なオーダーナンバー |
| stop | integer | 一致する場合は次のオーバーライドの処理を停止します。 可能な値: 0 - (デフォルト)オーバーライドの処理を停止しません 1 - フィルターが一致する場合はオーバーライドの処理を停止します |
| filter | object | オーバーライドフィルター |
| operations | array | オーバーライドの操作 |
LLD ルールオーバーライドフィルター
LLDルールオーバーライドフィルターオブジェクトは、検出されたオブジェクトと一致する場合にオーバーライドが適用される一連の条件を定義します。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| evaltype (必須) |
integer | フィルタ条件の評価方法を上書きします。 利用可能な値: 0 - and/or 1 - and 2 - or 3 - カスタム式 |
| conditions (必須) |
array | 検出されたオブジェクトの照合に使用するオーバーライドフィルター条件のセット。 |
| eval_formula | string | (読取専用) オーバーライドフィルター条件の評価に使用される生成された式。 式には、そのformulaidによって特定のオーバーライドフィルター条件を参照するIDが含まれています。 eval_formulaの値は、カスタム式を持つフィルターのformulaの値と同じです。 |
| formula | string | カスタム式を使用してオーバーライドフィルターの条件を評価するために使用されるユーザー定義式。 式には、そのformulaidによって特定のオーバーライドフィルター条件を参照するIDが含まれている必要があります。 式で使用されるIDは、オーバーライドフィルター条件で定義されたIDと完全に一致する必要があります。条件を未使用のままにしたり省略したりすることはできません。カスタム式オーバーライドフィルターに必要です。 |
LLDルールオーバーライドフィルター条件
LLDルールオーバーライドフィルター条件オブジェクトは、LLDマクロの値に対して実行する個別のチェックを定義します。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| macro (必須) |
string | チェックを実行するLLDマクロ |
| value (必須) |
string | 比較する値 |
| formulaid | string | カスタム式から条件を参照するために使用される任意の一意のID。 大文字のみを含めることができます。 IDは、フィルター条件を変更するときにユーザーが定義する必要がありますが、後で要求すると新たに生成されます。 |
| operator | integer | 条件演算子 可能な値: 8 - (デフォルト)正規表現に一致 9 - 正規表現と不一致 12 - 存在する 13 -存在しない |
LLDルールオーバーライド操作
LLDルールのオーバーライド操作は、プロトタイプオブジェクトに対して実行する条件とアクションの組み合わせです。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| operationobject (必須) |
integer | アクションを実行するために検出されたオブジェクトのタイプ。 可能な値: 0 - アイテムのプロトタイプ 1 - トリガーのプロトタイプ 2 - グラフのプロトタイプ 3 - ホストのプロトタイプ |
| operator | integer | 条件演算子をオーバーライドします。 可能な値: 0 - (デフォルト)等しい 1 - 等しくない 2 - 含む 3 - 含まない 8 - 一致する 9 - 一致しない |
| value | string | 選択したオブジェクトに応じて、アイテム、トリガー、グラフ、またはホストのプロトタイプ名に一致するパターン。 |
| opstatus | object | アイテム、トリガー、およびホストのプロトタイプオブジェクトの操作ステータスオブジェクトをオーバーライドします。 |
| opdiscover | object | オーバーライド操作の検出ステータスオブジェクト（すべてのオブジェクトタイプ） |
| opperiod | object | アイテムプロトタイプオブジェクトの操作期間（更新間隔）オブジェクトを上書きします。 |
| ophistory | object | アイテムプロトタイプオブジェクトの操作履歴オブジェクトを上書きします。 |
| optrends | object | アイテムプロトタイプオブジェクトの操作トレンドオブジェクトをオーバーライドします。 |
| opseverity | object | トリガープロトタイプオブジェクトの操作深刻度オブジェクトをオーバーライドします。 |
| optag | array | トリガーおよびホストのプロトタイプオブジェクトの操作タグオブジェクトをオーバーライドします。 |
| optemplate | array | ホストプロトタイプオブジェクトの操作テンプレートオブジェクトをオーバーライドします。 |
| opinventory | object | ホストプロトタイプオブジェクトの操作インベントリオブジェクトを上書きします。 |
LLD ルールオーバーライド操作ステータス
LLDルールは、検出されたオブジェクトに設定されている操作ステータスを上書きします。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| status (必須) |
integer | 選択したオブジェクトのステータスを上書きします。 利用可能な値: 0 - 作成を有効に 1 - 作成を無効に |
LLDルールオーバーライド操作ディスカバリ
LLDルールは、検出されたオブジェクトに設定されている操作のディスカバリステータスを上書きします。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| discover (必須) |
integer | 選択したオブジェクトのディスカバリステータスを上書きします。 利用可能な値: 0 - オブジェクトの検出を続行します 1 - 新しいオブジェクトは検出されず、既存のオブジェクトは失われたものとしてマークされます 。 |
LLDルールオーバーライド動作期間
LLDルールオーバーライド操作期間は、検出されたアイテムに設定される更新間隔値（カスタム間隔をサポート）です。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| delay (必須) |
string | アイテムのプロトタイプの更新間隔を上書きします。 接尾辞（30s,1m,2h,1d）が付いた秒または時間単位およびフレキシブルなスケジューリング間隔とユーザーマクロまたはLLDマクロを受け入れます。 複数の間隔はセミコロンで区切られます。 |
LLDルール操作履歴上書き
LLDルールは、検出されたアイテムに設定されている操作履歴値を上書きします。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| history (必須) |
string | 履歴データを保存する期間の時間単位であるアイテムプロトタイプの履歴を上書きします。 ユーザーマクロとLLDマクロも受け入れます。 |
LLDルールによるオペレーショントレンドの上書き
LLDルールは、検出されたアイテムに設定されているオペレーショントレンド値をオーバーライドします。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| trends (必須) |
string | トレンドデータを保存する期間の時間単位であるアイテムプロトタイプのトレンドをオーバーライドします。 ユーザーマクロとLLDマクロも受け入れます。 |
LLDルールはオペレーションの深刻度をオーバーライドします
LLDルールは、検出されたトリガーに設定されているオペレーションの深刻度の値をオーバーライドします。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| severity (必須) |
integer | トリガープロトタイプの重大度を上書きします。 可能な値は次のとおりです:0 - (デフォルト)未分類 1 - 情報 2 - 警告 3 - 軽度の障害<br >4 - 重度の障害 5 - 致命的な障害 |
LLDルールオーバーライドオペレーションタグ
LLDルールオーバーライド操作タグオブジェクトには、検出されたオブジェクトに設定されているタグ名と値が含まれています。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| tag (必須) |
string | 新しいタグ名 |
| value | string | 新しいタグ値 |
LLDルールオーバーライドオペレーションテンプレート
LLDルールは、検出されたホストにリンクされている操作テンプレートオブジェクトをオーバーライドします。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| templateid (必須) |
string | ホストプロトタイプのリンクされたテンプレートのテンプレートをオーバーライドします。 |
LLDルールによるオペレーションインベントリ上書き
LLDルールは検出されたホストに設定されている操作インベントリモード値を上書きします。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| inventory_mode (必須) |
integer | ホストプロトタイプインベントリモードをオーバーライドします。 利用可能な値: -1 - 無効 0 - (デフォルト) 手動 1 - 自動 |