Item prototypeオブジェクト

次のオブジェクトは、itemprototypeAPIに直接関連しています。

アイテムプロトタイプ

アイテムプロトタイプオブジェクトには、次のプロパティがあります。

プロパティ 型 説明
itemid ID アイテムプロトタイプのID。

プロパティの動作:
- 読み取り専用
- 更新操作では必須
delay string アイテムプロトタイプの更新間隔。

秒数（例: 1、60、300）、時間のサフィックス付きの値（例: 30s、1m、2h、1d）、またはオプションで1つ以上のカスタム間隔を指定できます。すべてセミコロンで区切ります。カスタム間隔には、フレキシブル間隔とスケジュール間隔を混在させることができます。

ユーザーマクロおよびLLDマクロを使用できます。使用する場合、値は単一のマクロでなければなりません。複数のマクロ、またはマクロとテキストの組み合わせはサポートされません。フレキシブル間隔は、スラッシュで区切った2つのマクロとして記述できます（例: {$FLEX_INTERVAL}/{$FLEX_PERIOD}）。

例:
1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}

プロパティの動作:
- type が「Zabbix agent」(0)、「Simple check」(3)、「Zabbix internal」(5)、「External check」(10)、「Database monitor」(11)、「IPMI agent」(12)、「SSH agent」(13)、「TELNET agent」(14)、「Calculated」(15)、「JMX agent」(16)、「HTTP agent」(19)、「SNMP agent」(20)、「Script」(21)、「Browser」(22) に設定されている場合、または type が「Zabbix agent (active)」(7) に設定され、key_ に「mqtt.get」が含まれていない場合は必須
hostid ID アイテムプロトタイプが属するホストのID。

プロパティの動作:
- 固定
- 作成操作では必須
interfaceid ID アイテムプロトタイプのホストインターフェースのID。

プロパティの動作:
- アイテムプロトタイプがホストに属し、type が「Zabbix agent」、「IPMI agent」、「JMX agent」、「SNMP trap」、または「SNMP agent」に設定されている場合は必須
- アイテムプロトタイプがホストに属し、type が「Simple check」、「External check」、「SSH agent」、「TELNET agent」、または「HTTP agent」に設定されている場合はサポート
key_ string アイテムプロトタイプのキー。

プロパティの動作:
- 作成操作では必須
- 継承されたオブジェクトでは読み取り専用
name string アイテムプロトタイプの名前。
ユーザーマクロをサポートします。

プロパティの動作:
- 作成操作では必須
- 継承されたオブジェクトでは読み取り専用
type integer アイテムプロトタイプのタイプ。

指定可能な値:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
10 - External check;
11 - Database monitor;
12 - IPMI agent;
13 - SSH agent;
14 - TELNET agent;
15 - Calculated;
16 - JMX agent;
17 - SNMP trap;
18 - Dependent item;
19 - HTTP agent;
20 - SNMP agent;
21 - Script;
22 - Browser。

プロパティの動作:
- 作成操作では必須
- 継承されたオブジェクトでは読み取り専用
url string URL文字列。
LLDマクロ、ユーザーマクロ、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}をサポートします。

プロパティの動作:
- type が「HTTP agent」に設定されている場合は必須
- 継承されたオブジェクトでは読み取り専用
value_type integer アイテムプロトタイプの情報のタイプ。

指定可能な値:
0 - numeric float;
1 - character;
2 - log;
3 - numeric unsigned;
4 - text;
5 - binary。

プロパティの動作:
- 作成操作では必須
- 継承されたオブジェクトでは読み取り専用
allow_traps integer トラッパーアイテムと同様に値を格納することを許可します。

0 - (デフォルト) 受信データの受け入れを許可しない;
1 - 受信データの受け入れを許可する。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
authtype integer 認証方式。

type が「SSH agent」に設定されている場合の指定可能な値:
0 - (デフォルト) パスワード;
1 - 公開鍵。

type が「HTTP agent」に設定されている場合の指定可能な値:
0 - (デフォルト) なし;
1 - basic;
2 - NTLM;
3 - Kerberos;
4 - Digest。

プロパティの動作:
- type が「SSH agent」または「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用（type が「HTTP agent」に設定されている場合）
description string アイテムプロトタイプの説明。
flags integer アイテムプロトタイプの生成元。

指定可能な値:
2 - アイテムプロトタイプ;
6 - 検出されたアイテムプロトタイプ

プロパティの動作:
- 読み取り専用
follow_redirects integer データのポーリング中にレスポンスのリダイレクトに従うかどうか。

指定可能な値:
0 - リダイレクトに従わない;
1 - (デフォルト) リダイレクトに従う。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
headers array HTTPリクエストの実行時に送信されるヘッダーの配列。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
history string 履歴データを保存する期間の時間単位。
ユーザーマクロおよびLLDマクロも使用できます。

デフォルト: 31d。
http_proxy string HTTP(S)プロキ接続文字列。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
ipmi_sensor string IPMIセンサー。

プロパティの動作:
- type が「IPMI agent」に設定され、key_ が「ipmi.get」に設定されていない場合は必須
- type が「IPMI agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
jmx_endpoint string JMXエージェントのカスタム接続文字列。

デフォルト: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

プロパティの動作:
- type が「JMX agent」に設定されている場合はサポート
logtimefmt string ログエントリの時刻形式。

プロパティの動作:
- value_type が「log」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
master_itemid ID マスターアイテムのID。

プロパティの動作:
- type が「Dependent item」に設定されている場合は必須
- 継承されたオブジェクトでは読み取り専用
output_format integer レスポンスをJSONに変換するかどうか。

指定可能な値:
0 - (デフォルト) 未加工のまま保存;
1 - JSONに変換。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
params string アイテムプロトタイプのタイプに応じた追加パラメータ:
- SSH agentおよびTELNET agentのアイテムプロトタイプで実行されるスクリプト;
- データベースモニターのアイテムプロトタイプで使用されるSQLクエリ;
- 計算アイテムプロトタイプで使用される数式;
- スクリプトおよびブラウザーのアイテムプロトタイプで使用されるスクリプト。

プロパティの動作:
- type が「Database monitor」、「SSH agent」、「TELNET agent」、「Calculated」、「Script」、または「Browser」に設定されている場合は必須
- 継承されたオブジェクトでは読み取り専用（type が「Script」または「Browser」に設定されている場合）
parameters object/array type が「Script」または「Browser」に設定されている場合の追加パラメータ。name および value プロパティを持つオブジェクトの配列で、name は一意でなければなりません。

プロパティの動作:
- type が「Script」または「Browser」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
password string 認証用パスワード。

プロパティの動作:
- type が「JMX agent」に設定され、username が設定されている場合は必須
- type が「Simple check」、「SSH agent」、「TELNET agent」、「Database monitor」、または「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用（type が「HTTP agent」に設定されている場合）
post_type integer posts プロパティに保存されるPOSTデータ本文のタイプ。

指定可能な値:
0 - (デフォルト) 未加工データ。
2 - JSONデータ。
3 - XMLデータ。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
posts string HTTP(S)リクエスト本文のデータ。

プロパティの動作:
- type が「HTTP agent」に設定され、post_type が「JSON data」または「XML data」に設定されている場合は必須
- type が「HTTP agent」に設定され、post_type が「Raw data」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
privatekey string 秘密鍵ファイルの名前。

プロパティの動作:
- type が「SSH agent」に設定され、authtype が「public key」に設定されている場合は必須
publickey string 公開鍵ファイルの名前。

プロパティの動作:
- type が「SSH agent」に設定され、authtype が「public key」に設定されている場合は必須
query_fields array HTTPリクエストの実行時に送信されるクエリフィールドの配列。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
request_method integer リクエストメソッドのタイプ。

指定可能な値:
0 - (デフォルト) GET;
1 - POST;
2 - PUT;
3 - HEAD。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
retrieve_mode integer 保存するレスポンスの部分。

request_method が「GET」、「POST」、または「PUT」に設定されている場合の指定可能な値:
0 - (デフォルト) 本文;
1 - ヘッダー;
2 - 本文とヘッダーの両方を保存。

request_method が「HEAD」に設定されている場合の指定可能な値:
1 - ヘッダー。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
snmp_oid string SNMP OID。

プロパティの動作:
- type が「SNMP agent」に設定されている場合は必須
- 継承されたオブジェクトでは読み取り専用
ssl_cert_file string 公開SSL鍵ファイルのパス。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
ssl_key_file string 秘密SSL鍵ファイルのパス。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
ssl_key_password string SSL鍵ファイルのパスワード。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
status integer アイテムプロトタイプのステータス。

指定可能な値:
0 - (デフォルト) 有効なアイテムプロトタイプ;
1 - 無効なアイテムプロトタイプ;
3 - サポートされていないアイテムプロトタイプ。
status_codes string 必要なHTTPステータスコードの範囲。コンマで区切ります。
コンマ区切りリストの一部として、ユーザーマクロまたはLLDマクロもサポートします。

例: 200,200-{$M},{$M},200-400

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
templateid ID 親テンプレートのアイテムプロトタイプのID。

プロパティの動作:
- 読み取り専用
timeout string アイテムデータのポーリングリクエストのタイムアウト。
秒数（例: 1、60）、または時間のサフィックス付きの値（例: 30s、1m）を指定できます。ユーザーマクロおよびLLDマクロも使用できます。

指定可能な値の範囲: 1-600s。

デフォルト: "" - プロキシまたはグローバル設定を使用。

プロパティの動作:
- type が「Zabbix agent」(0)、「Simple check」(3) に設定され、key_ が「vmware.」および「icmpping」で始まらない場合、「Zabbix agent (active)」(7)、「External check」(10)、「Database monitor」(11)、「SSH agent」(13)、「TELNET agent」(14)、「HTTP agent」(19)、「SNMP agent」(20) に設定され、snmp_oid が「walk[」または「get[」で始まる場合、「Script」(21)、または「Browser」(22) に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
trapper_hosts string 許可されたホスト。

プロパティの動作:
- type が「Zabbix trapper」に設定されている場合、または type が「HTTP agent」に設定され、allow_traps が「Allow to accept incoming data」に設定されている場合はサポート
trends string トレンドデータを保存する期間の時間単位。
ユーザーマクロおよびLLDマクロも使用できます。

デフォルト: 365d。

プロパティの動作:
- value_type が「numeric float」または「numeric unsigned」に設定されている場合はサポート
units string 値の単位。

プロパティの動作:
- value_type が「numeric float」または「numeric unsigned」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
username string 認証用ユーザー名。

プロパティの動作:
- type が「SSH agent」または「TELNET agent」に設定されている場合、または type が「JMX agent」に設定され、password が設定されている場合は必須
- type が「Simple check」、「Database monitor」、または「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用（type が「HTTP agent」に設定されている場合）
uuid string インポートしたアイテムプロトタイプを既存のアイテムプロトタイプにリンクするために使用する一意の識別子。指定されていない場合は自動生成されます。

プロパティの動作:
- アイテムプロトタイプがテンプレートに属している場合はサポート
valuemapid ID 関連付けられた値のマップのID。

プロパティの動作:
- value_type が「numeric float」、「character」、または「numeric unsigned」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
verify_host integer 接続先のホスト名が、ホストの証明書に記載された名前と一致することを検証するかどうか。

指定可能な値:
0 - (デフォルト) 検証しない;
1 - 検証する。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
verify_peer integer ホストの証明書が正当なものであることを検証するかどうか。

指定可能な値:
0 - (デフォルト) 検証しない;
1 - 検証する。

プロパティの動作:
- type が「HTTP agent」に設定されている場合はサポート
- 継承されたオブジェクトでは読み取り専用
discover integer アイテムプロトタイプの検出ステータス。

指定可能な値:
0 - (デフォルト) 新しいアイテムを検出する;
1 - 新しいアイテムを検出せず、既存のアイテムを失われたものとしてマークする。

HTTPヘッダー

ヘッダーオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
name string HTTPヘッダー名。

プロパティの動作:
- 必須
value string ヘッダー値。

プロパティの動作:
- 必須

HTTPクエリフィールド

クエリフィールドオブジェクトは、URLパラメータを指定するために使用される名前と値を定義します。
このオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
name string パラメータの名前。

プロパティの動作:
- 必須
value string パラメータの値。

プロパティの動作:
- 必須

アイテムプロトタイプタグ

アイテムプロトタイプタグオブジェクトには、次のプロパティがあります。

Property Type Description
tag string アイテムプロトタイプタグ名。

Property behavior:
- required
value string アイテムプロトタイプタグの値。

アイテムプロトタイプの前処理

アイテムプロトタイプの前処理オブジェクトには、次のプロパティがあります。

プロパティ タイプ 説明
type integer 前処理オプションのタイプ。

指定可能な値:
1 - カスタム乗数;
2 - 右側トリム;
3 - 左側トリム;
4 - トリム;
5 - 正規表現;
6 - ブール値から10進数;
7 - 8進数から10進数;
8 - 16進数から10進数;
9 - 単純変化;
10 - 1秒あたりの変化;
11 - XML XPath;
12 - JSONPath;
13 - 範囲内;
14 - 正規表現に一致;
15 - 正規表現に一致しない;
16 - JSONのエラーをチェック;
17 - XMLのエラーをチェック;
18 - 正規表現を使用してエラーをチェック;
19 - 変更されていない値を破棄;
20 - ハートビート付きで変更されていない値を破棄;
21 - JavaScript;
22 - Prometheusパターン;
23 - PrometheusからJSON;
24 - CSVからJSON;
25 - 置換;
26 - サポートされていない値をチェック;
27 - XMLからJSON;
28 - SNMP walk値;
29 - SNMP walkからJSON;
30 - SNMP get値。

プロパティの動作:
- 必須
params string 前処理オプションで使用する追加パラメータ。
複数のパラメータは改行 (\n) 文字で区切ります。

type が「サポートされていない値をチェック」に設定されている場合、パラメータは <scope>[\n<pattern>] 構文に従います。ここで、pattern は正規表現、scope は次のいずれかです:
-1 - 任意のエラーに一致;
\ 0 - エラーメッセージが pattern に一致するかをチェック;
\ 1 - エラーメッセージが pattern に一致しないかをチェック。

プロパティの動作:
- type が「カスタム乗数」(1)、「右側トリム」(2)、「左側トリム」(3)、「トリム」(4)、「正規表現」(5)、「XML XPath」(11)、「JSONPath」(12)、「範囲内」(13)、「正規表現に一致」(14)、「正規表現に一致しない」(15)、「JSONのエラーをチェック」(16)、「XMLのエラーをチェック」(17)、「正規表現を使用してエラーをチェック」(18)、「ハートビート付きで変更されていない値を破棄」(20)、「JavaScript」(21)、「Prometheusパターン」(22)、「PrometheusからJSON」(23)、「CSVからJSON」(24)、「置換」(25)、「サポートされていない値をチェック」(26)、「SNMP walk値」(28)、「SNMP walkからJSON」(29)、または「SNMP get値」(30) に設定されている場合は 必須
error_handler integer 前処理ステップが失敗した場合に使用するアクションタイプ。

指定可能な値:
0 - エラーメッセージはZabbixサーバーによって設定される;
1 - 値を破棄;
2 - カスタム値を設定;
3 - カスタムエラーメッセージを設定。

type が「サポートされていない値をチェック」に設定されている場合の指定可能な値:
1 - 値を破棄;
2 - カスタム値を設定;
3 - カスタムエラーメッセージを設定。

プロパティの動作:
- type が「カスタム乗数」(1)、「正規表現」(5)、「ブール値から10進数」(6)、「8進数から10進数」(7)、「16進数から10進数」(8)、「単純変化」(9)、「1秒あたりの変化」(10)、「XML XPath」(11)、「JSONPath」(12)、「範囲内」(13)、「正規表現に一致」(14)、「正規表現に一致しない」(15)、「JSONのエラーをチェック」(16)、「XMLのエラーをチェック」(17)、「正規表現を使用してエラーをチェック」(18)、「Prometheusパターン」(22)、「PrometheusからJSON」(23)、「CSVからJSON」(24)、「サポートされていない値をチェック」(26)、「XMLからJSON」(27)、「SNMP walk値」(28)、「SNMP walkからJSON」(29)、または「SNMP get値」(30) に設定されている場合は 必須
error_handler_params string エラーハンドラーのパラメータ。

プロパティの動作:
- error_handler が「カスタム値を設定」または「カスタムエラーメッセージを設定」に設定されている場合は 必須

各前処理タイプでサポートされるパラメータとエラーハンドラーは次のとおりです。

前処理タイプ 名前 パラメータ1 パラメータ2 パラメータ3 サポートされるエラーハンドラー
1 カスタム乗数 number1, 6 0, 1, 2, 3
2 右側トリム 文字のリスト2
3 左側トリム 文字のリスト2
4 トリム 文字のリスト2
5 正規表現 パターン3 出力2 0, 1, 2, 3
6 ブール値から10進数 0, 1, 2, 3
7 8進数から10進数 0, 1, 2, 3
8 16進数から10進数 0, 1, 2, 3
9 単純変化 0, 1, 2, 3
10 1秒あたりの変化 0, 1, 2, 3
11 XML XPath パス4 0, 1, 2, 3
12 JSONPath パス4 0, 1, 2, 3
13 範囲内 最小値1, 6 最大値1, 6 0, 1, 2, 3
14 正規表現に一致 パターン3 0, 1, 2, 3
15 正規表現に一致しない パターン3 0, 1, 2, 3
16 JSONのエラーをチェック パス4 0, 1, 2, 3
17 XMLのエラーをチェック パス4 0, 1, 2, 3
18 正規表現を使用してエラーをチェック パターン3 出力2 0, 1, 2, 3
19 変更されていない値を破棄
20 ハートビート付きで変更されていない値を破棄 秒5, 6
21 JavaScript スクリプト2
22 Prometheusパターン パターン6, 7 value、label、function 出力8, 9 0, 1, 2, 3
23 PrometheusからJSON パターン6, 7 0, 1, 2, 3
24 CSVからJSON 文字2 文字2 0,1 0, 1, 2, 3
25 置換 検索文字列2 置換文字列2
26 サポートされていない値をチェック スコープ1 パターン3, 6 1, 2, 3
27 XMLからJSON 0, 1, 2, 3
28 SNMP walk値 OID2 形式:
0 - 変更なし
1 - Hex-STRINGからUTF-8
2 - Hex-STRINGからMAC
3 - BITSから整数		 0, 1, 2, 3
29 SNMP walkからJSON10 フィールド名2 OIDプレフィックス2 形式:
0 - 変更なし
1 - Hex-STRINGからUTF-8
2 - Hex-STRINGからMAC
3 - BITSから整数		 0, 1, 2, 3
30 SNMP get値 形式:
1 - Hex-STRINGからUTF-8
2 - Hex-STRINGからMAC
3 - BITSから整数		 0, 1, 2, 3

1 整数または浮動小数点数
2 文字列
3 正規表現
4 JSONPathまたはXML XPath
5 正の整数（時間のサフィックス（例: 30s、1m、2h、1d）をサポート）
6 ユーザーマクロ、LLDマクロ
7 次の構文に従うPrometheusパターン: <metric name>{<label name>="<label value>", ...} == <value>。Prometheusパターンの各コンポーネント（メトリクス、ラベル名、ラベル値、メトリクス値）には、ユーザーマクロまたはLLDマクロを指定できます。
8 2番目のパラメータで label が選択されている場合のPrometheus出力。構文は <label name>（ユーザーマクロまたはLLDマクロを指定可能）です。
9 2番目のパラメータで function が選択されている場合の集計関数のいずれか: sum、min、max、avg、count。
10 改行文字で区切られた複数の「フィールド名、OIDプレフィックス、形式レコード」をサポートします。