You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

3 テンプレート

概要

テンプレートは、多くの関連オブジェクトやオブジェクトの関係とともにエクスポートされます。

テンプレートのエクスポートには以下が含まれます:

  • リンクされたテンプレートグループ
  • ホストプロトタイプの設定で使用されている場合)リンクされたホストグループ
  • テンプレートデータ
  • 他のテンプレートへのリンク
  • テンプレートグループへのリンク
  • 直接リンクされたアイテム
  • 直接リンクされたトリガー
  • 直接リンクされたグラフ
  • 直接リンクされたダッシュボード
  • すべてのプロトタイプを含む直接リンクされたディスカバリルール
  • 直接リンクされたWebシナリオ
  • 値のマッピング

エクスポート

テンプレートをエクスポートするには、以下の手順を実行します。

  1. データ収集テンプレート に移動します。
  2. エクスポートするテンプレートのチェックボックスをオンにします。
  3. リストの下にある エクスポート をクリックします。

選択したフォーマットに応じて、テンプレートはデフォルト名のローカルファイルにエクスポートされます。

  • zabbix_export_templates.yaml - YAMLエクスポートの場合(エクスポートのデフォルトオプション);
  • zabbix_export_templates.xml - XMLエクスポートの場合;
  • zabbix_export_templates.json - JSONエクスポートの場合。

インポート

テンプレートをインポートするには、以下の手順を実行します。

  1. データ収集テンプレート に移動します。
  2. 右上の インポート をクリックします。
  3. インポートファイルを選択します。
  4. 設定フォームの右下にある インポート をクリックします。

詳細オプション チェックボックスをオンにすると、インポート可能なすべての要素の詳細リストが表示されます。必要に応じて各インポートルールをオンまたはオフにします。

すべて 行のチェックボックスをクリックすると、その下のすべての要素がオンまたはオフになります。

インポートルール:

ルール 説明
既存のものを更新 既存の要素はインポートファイルのデータで更新されます。そうでない場合は更新されません。
新規作成 新しい要素はインポートファイルのデータで作成されます。そうでない場合は作成されません。
存在しないものを削除 インポートファイルに存在しない既存の要素は削除されます。そうでない場合は削除されません。
テンプレートリンク存在しないものを削除 をオンにすると、インポートファイルに存在しない現在のテンプレートリンクが解除されます。リンク解除されたテンプレートから継承されたエンティティ(アイテム、トリガー、グラフなど)は(各エンティティについて 存在しないものを削除 オプションが選択されていない限り)削除されません。

次の画面では、インポートされるテンプレートの内容を確認できます。 新しいテンプレートの場合、すべての要素が緑色で表示されます。 既存のテンプレートを更新する場合、新しいテンプレート要素は緑色で強調表示され、削除されたテンプレート要素は赤色で強調表示され、変更されていない要素はグレーの背景で表示されます。

左側のメニューを使用して、変更リストをナビゲートできます。 更新済み セクションは、既存のテンプレート要素に加えられたすべての変更を強調表示します。 追加済み セクションには、新しいテンプレート要素が一覧表示されます。 各セクションの要素は要素タイプごとにグループ化されており、グレーの矢印をクリックすると要素グループを展開または折りたたむことができます。

テンプレートの変更内容を確認し、インポート をクリックしてテンプレートのインポートを実行します。 インポートの成功または失敗のメッセージがフロントエンドに表示されます。

エクスポート形式

テンプレートをエクスポートすると、Zabbixは構造化されたYAML、JSON、またはXML形式を生成します。 エクスポートには、テンプレートのメタデータ、アイテム、マクロ、トリガー、ダッシュボードなどのテンプレート要素が含まれます。

各要素は特定の目的を持ち、ネストされた要素を含む場合があります。

以下のセクションでは、エクスポート形式の各要素について説明します。 例では、Linux by Zabbix agent テンプレートを使用しています。

省略記号 (...) は、簡潔にするために省略された要素を示します。 (see table below) の注記は、後のセクションで要素がより詳細に説明されている場合に使用されます。

テンプレートメタデータ

zabbix_export:
         version: '8.0'
         template_groups:
           - uuid: 846977d1dfed4968bc5f8bdb363285bc
             name: 'Templates/Operating systems'
         templates: (see table below)
         triggers: (see table below)
         graphs: (see table below)
要素 説明
version string (必須) エクスポートバージョン。
template_groups (必須) テンプレートグループのルート要素。
uuid string (必須) このテンプレートグループの一意の識別子。
name string (必須) テンプレートグループ名。
host_groups ホストプロトタイプで使用されるホストグループのルート要素。
uuid string (必須) このホストグループの一意の識別子。
name string (必須) ホストグループ名。
templates テンプレートのルート要素。
triggers テンプレートトリガー要素のルート要素。テンプレートアイテムトリガーと同じです。
graphs テンプレートグラフ要素のルート要素。ホストグラフと同じです。

テンプレート

zabbix_export:
         (...)
         templates:
           - uuid: f8f7908280354f2abeed07dc788c3747
             template: 'Linux by Zabbix agent'
             name: 'Linux by Zabbix agent'
             description: |
               これは公式のLinuxテンプレートです。Zabbix agent 8.0以降が必要です。(...)
             wizard_ready: 'YES'
             readme: |
               ## 概要
               
               これは公式のLinuxテンプレートです。Zabbix agent 8.0以降が必要です。(...)
             vendor:
               name: Zabbix
               version: 8.0-2
             groups:
               - name: 'Templates/Operating systems'
             items: (下記の表を参照)
             discovery_rules: (下記の表を参照)
             tags:
               - tag: class
                 value: os
               - tag: target
                 value: linux
             macros:
               - macro: '{$AGENT.TIMEOUT}'
                 value: 3m
                 description: 'エージェントが利用できないと見なされるまでのタイムアウト。Zabbixサーバー/プロキシから到達可能なエージェント(パッシブモード)でのみ動作します。'
                 config: (下記の表を参照)
               - macro: '{$CPU.UTIL.CRIT}'
                 value: '90'
                 description: 'CPU使用率のクリティカルしきい値(%で指定)。'
                 config: (下記の表を参照)
               (...)
             dashboards: (下記の表を参照)
             valuemaps: (下記の表を参照)
           (...)
要素 説明
uuid string (必須) このテンプレートの一意の識別子。
template string (必須) 一意のテンプレート名。
name string 表示用テンプレート名。
description text テンプレートの説明。
wizard_ready text ホストウィザードでテンプレートを選択可能にするかどうか。
指定可能な値:1 NO (0, デフォルト), YES (1)。
参考: テンプレートオブジェクト (wizard_ready)。
readme text ホストウィザードで表示するテンプレート固有の設定手順。Markdown形式をサポート。
vendor テンプレートベンダーのルート要素(エクスポートされたテンプレートにベンダーデータが含まれている場合に存在)。
name string (必須) テンプレートベンダー名。
version string (必須) テンプレートバージョン。
標準テンプレートの場合、バージョンはZabbixのメジャーバージョン、区切り文字("-")、リビジョン番号(テンプレートの新バージョンごとに増加し、Zabbixのメジャーバージョンごとにリセット)で表示されます。例: 7.0-0, 7.0-3, 8.0-0, 8.0-3。
templates リンクされたテンプレートのルート要素。
name string (必須) テンプレート名。
groups テンプレートグループのルート要素。
name string (必須) テンプレートグループ名。
items テンプレートアイテムのルート要素。
discovery_rules テンプレートのローレベルディスカバリールールのルート要素。
httptests テンプレートWebシナリオのルート要素。
tags テンプレートタグのルート要素。
tag string (必須) タグ名。
value string タグ値。
macros テンプレートユーザーマクロのルート要素。
macro string (必須) ユーザーマクロ名。
type string ユーザーマクロの型。
指定可能な値:1 TEXT (0, デフォルト), SECRET_TEXT (1), VAULT (2)。
参考: ユーザーマクロオブジェクト (type)。
value string ユーザーマクロ値。
description string ユーザーマクロの説明。
config テンプレートマクロ設定のルート要素。ホストウィザードでのマクロの表示方法を制御。
dashboards テンプレートダッシュボードのルート要素。
valuemaps テンプレート値のマッピングのルート要素。

テンプレートアイテム

zabbix_export:
         (...)
         templates:
           (...)
             items:
               - uuid: f94f9f4699e94c369e6c98b2a2f485ce
                 name: 'Zabbix agent ping'
                 key: agent.ping
                 description: 'このアイテムに対してエージェントは常に"1"を返します。`nodata()`と組み合わせて可用性チェックに使用できます。'
                 valuemap:
                   name: 'Zabbix agent ping status'
                 tags:
                   - tag: component
                     value: system
               (...)
               - uuid: 58818005e76d46dda14d6592f601ab00
                 name: 'Number of installed packages'
                 key: system.sw.packages.get
                 delay: 1h
                 preprocessing: (下記の表を参照)
                 tags:
                   - tag: component
                     value: os
                 triggers: (下記の表を参照)
               - uuid: 403cebed115441369e94d35d070ca7b8
                 name: 'Memory utilization'
                 type: DEPENDENT
                 key: vm.memory.utilization
                 value_type: FLOAT
                 units: '%'
                 description: '使用メモリの割合は`100-pavailable`として計算されます。'
                 preprocessing: (下記の表を参照)
                 master_item:
                   key: 'vm.memory.size[pavailable]'
                 tags:
                   - tag: component
                     value: memory
                 triggers: (下記の表を参照)
               (...)
要素 説明
uuid string (必須) このアイテムの一意の識別子。
name string (必須) アイテム名。
type string アイテムタイプ。
指定可能な値:1 ZABBIX_PASSIVE (0, デフォルト), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), CALCULATED (15), JMX (16), SNMP_TRAP (17), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22)。
snmp_oid string (SNMP_AGENTアイテムの場合は必須) SNMPオブジェクトID。
key string (必須) アイテムキー。
delay string アイテムの更新間隔。
デフォルト: 1m。TRAPアイテムの場合は常に0になります。
history string 履歴データを保存する期間(時間のサフィックスユーザーマクロ、またはLLDマクロを使用可能)。
デフォルト: 31d。
trends string トレンドデータを保存する期間(時間のサフィックスユーザーマクロ、またはLLDマクロを使用可能)。
デフォルト: 365d。
status string アイテムのステータス。
指定可能な値:1 ENABLED (0, デフォルト), DISABLED (1)。
value_type string 受信値の型。
指定可能な値:1 FLOAT (0), CHAR (1), LOG (2), UNSIGNED (3, デフォルト), TEXT (4), BINARY (5)。
allowed_hosts string アイテムにデータを送信できるホストのIPアドレス(カンマ区切り)のリスト。
TRAPおよびHTTP_AGENTアイテムでサポート。
units string 受信値の単位(bps, Bなど)。
params text アイテムのタイプに応じた追加パラメータ(SSHおよびTELNETアイテムの場合は実行スクリプト、ODBCアイテムの場合はSQLクエリ、CALCULATEDアイテムの場合は式、ITEM_TYPE_SCRIPTおよびITEM_TYPE_BROWSERアイテムの場合はスクリプト)。
ipmi_sensor string IPMIセンサー。
IPMIアイテムでサポート。
authtype string 認証タイプ。
SSHおよびHTTP_AGENTアイテムでサポート。
SSHアイテムの場合の指定可能な値:1 PASSWORD (0, デフォルト), PUBLIC_KEY (1)。
HTTP_AGENTアイテムの場合の指定可能な値:1 NONE (0, デフォルト), BASIC (1), NTLM (2)。
username string (SSHおよびTELNETアイテムの場合は必須) 認証用ユーザー名。
SIMPLE、ODBC、JMX、HTTP_AGENTアイテムでサポート。
JMXアイテムで使用する場合は、password(下記参照)も指定するか、両方の要素を空白にしてください。
password string (SSHおよびTELNETアイテムの場合は必須) 認証用パスワード。
SIMPLE、ODBC、JMX、HTTP_AGENTアイテムでサポート。
JMXアイテムで使用する場合は、username(上記参照)も指定するか、両方の要素を空白にしてください。
publickey string (SSHアイテムの場合は必須) 公開鍵ファイル名。
privatekey string (SSHアイテムの場合は必須) 秘密鍵ファイル名。
description text アイテムの説明。
inventory_link string アイテムによって入力されるホストインベントリフィールド。
指定可能な値:1 NONE (0), ALIAS (4)など(ホストインベントリでサポートされているフィールドを参照)。
valuemap アイテム値マップのルート要素。
name string (必須) アイテムで使用する値マップ名。
logtimefmt string ログエントリ内の時刻のフォーマット。
LOG値タイプのアイテムでサポート。
preprocessing アイテム値の事前処理のルート要素。
step テンプレートアイテム値の事前処理ステップのルート要素。
jmx_endpoint string JMXエンドポイント。
JMXアイテムでサポート。
master_item (DEPENDENTアイテムの場合は必須) 従属アイテムのマスターアイテムのルート要素。
key string (必須) 従属アイテムのマスターアイテムキー。
timeout string アイテムデータのポーリングリクエストのタイムアウト。
タイムアウトリストのアイテムタイプでサポート。
url string (HTTP_AGENTアイテムの場合は必須) URL文字列。
query_fields クエリパラメータのルート要素。
HTTP_AGENTアイテムでサポート。
name string (HTTP_AGENTアイテムの場合は必須) クエリパラメータ名。
value string クエリパラメータ値。
HTTP_AGENTアイテムでサポート。
parameters ユーザー定義パラメータのルート要素。
ITEM_TYPE_SCRIPTおよびITEM_TYPE_BROWSERアイテムでサポート。
name string (ITEM_TYPE_SCRIPTおよびITEM_TYPE_BROWSERアイテムの場合は必須) ユーザー定義パラメータ名。
value string ユーザー定義パラメータ値。
ITEM_TYPE_SCRIPTおよびITEM_TYPE_BROWSERアイテムでサポート。
posts string HTTP(S)リクエストボディデータ。
HTTP_AGENTアイテムでサポート。
status_codes string 必要なHTTPステータスコードの範囲(カンマ区切り)。
HTTP_AGENTアイテムでサポート。
follow_redirects string データポーリング時にレスポンスリダイレクトを追従するかどうか。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 NO (0), YES (1, デフォルト)。
post_type string ポストデータボディのタイプ。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 RAW (0, デフォルト), JSON (2), XML (3)。
http_proxy string HTTP(S)プロキシ接続文字列。
HTTP_AGENTアイテムでサポート。
headers HTTP(S)リクエストヘッダーのルート要素。
HTTP_AGENTアイテムでサポート。
name string (HTTP_AGENTアイテムの場合は必須) ヘッダー名。
value string (HTTP_AGENTアイテムの場合は必須) ヘッダー値。
retrieve_mode string レスポンスのどの部分を保存するか。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 BODY (0, デフォルト), HEADERS (1), BOTH (2)。
request_method string リクエストメソッドタイプ。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 GET (0, デフォルト), POST (1), PUT (2), HEAD (3)。
output_format string レスポンスの処理方法。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 RAW (0, デフォルト), JSON (1)。
allow_traps string trapperアイテムと同様に値を入力できるようにするかどうか。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 NO (0, デフォルト), YES (1)。
ssl_cert_file string 公開SSLキーのファイルパス。
HTTP_AGENTアイテムでサポート。
ssl_key_file string 秘密SSLキーのファイルパス。
HTTP_AGENTアイテムでサポート。
ssl_key_password string SSLキーのパスワード。
HTTP_AGENTアイテムでサポート。
verify_peer string ホストの証明書が正当かどうかを検証するかどうか。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 NO (0, デフォルト), YES (1)。
verify_host string 接続先のホスト名が証明書のものと一致するかどうかを検証するかどうか。
HTTP_AGENTアイテムでサポート。
指定可能な値:1 NO (0, デフォルト), YES (1)。
tags アイテムタグのルート要素。
tag string (必須) タグ名。
value string タグ値。
triggers テンプレートアイテムトリガーのルート要素。

関連項目: アイテムオブジェクト (同名のプロパティを参照)。

テンプレートアイテムの値の事前処理ステップ
zabbix_export:
         (...)
         templates:
           (...)
             items:
               (...)
               - uuid: 58818005e76d46dda14d6592f601ab00
                 (...)
                 preprocessing:
                   - type: JSONPATH
                     parameters:
                       - $.length()
                   - type: DISCARD_UNCHANGED_HEARTBEAT
                     parameters:
                       - 12h
                 (...)
要素 説明
type string (必須) アイテム値の事前処理ステップのタイプ。
指定可能な値:1 MULTIPLIER (1), RTRIM (2), LTRIM (3), TRIM (4), REGEX (5), BOOL_TO_DECIMAL (6), OCTAL_TO_DECIMAL (7), HEX_TO_DECIMAL (8), SIMPLE_CHANGE (9, 計算式: 受信値 - 前回値), CHANGE_PER_SECOND (10, 計算式: (受信値 - 前回値)/(現在時刻 - 前回チェック時刻)), XMLPATH (11), JSONPATH (12), IN_RANGE (13), MATCHES_REGEX (14), NOT_MATCHES_REGEX (15), CHECK_JSON_ERROR (16), CHECK_XML_ERROR (17), CHECK_REGEX_ERROR (18), DISCARD_UNCHANGED (19), DISCARD_UNCHANGED_HEARTBEAT (20), JAVASCRIPT (21), PROMETHEUS_PATTERN (22), PROMETHEUS_TO_JSON (23), CSV_TO_JSON (24), STR_REPLACE (25), CHECK_NOT_SUPPORTED (26), XML_TO_JSON (27), SNMP_WALK_VALUE (28), SNMP_WALK_TO_JSON (29), SNMP_GET_VALUE (30)。
parameters (必須) アイテム値の事前処理ステップのパラメータのルート要素。
parameter string アイテム値の事前処理ステップの個別パラメータ。
error_handler string 事前処理ステップの失敗時に使用されるアクションタイプ。
指定可能な値:1 ORIGINAL_ERROR (0, デフォルト), DISCARD_VALUE (1), CUSTOM_VALUE (2), CUSTOM_ERROR (3)。
error_handler_params string エラーハンドラのパラメータ。

参照: アイテムの事前処理オブジェクト (同名のプロパティを参照)。

テンプレートアイテムのトリガー
zabbix_export:
         (...)
         templates:
           (...)
             items:
               (...)
               - uuid: 58818005e76d46dda14d6592f601ab00
                 (...)
                 triggers:
                   - uuid: b950c306394f4b3c902060a8273cbcde
                     expression: 'change(/Linux by Zabbix agent/system.sw.packages.get)<>0'
                     name: 'Linux: Number of installed packages has been changed'
                     priority: WARNING
                     manual_close: 'YES'
                     tags:
                       - tag: scope
                         value: notice
               (...)
               - uuid: 403cebed115441369e94d35d070ca7b8
                 (...)
                 triggers:
                   - uuid: cfd395b1cde74ef18a5e5f840bd5142a
                     expression: 'min(/Linux by Zabbix agent/vm.memory.utilization,5m)>{$MEMORY.UTIL.MAX}'
                     name: 'Linux: High memory utilization'
                     event_name: 'Linux: High memory utilization (>{$MEMORY.UTIL.MAX}% for 5m)'
                     priority: AVERAGE
                     description: 'The system is running out of free memory.'
                     dependencies:
                       - name: 'Linux: Lack of available memory'
                         expression: 'max(/Linux by Zabbix agent/vm.memory.size[available],5m)<{$MEMORY.AVAILABLE.MIN} and last(/Linux by Zabbix agent/vm.memory.size[total])>0'
                     tags:
                       - tag: scope
                         value: capacity
                       - tag: scope
                         value: performance
               (...)
要素 説明
uuid string (必須) このトリガーの一意な識別子。
expression string (必須) トリガーの式。
recovery_mode string OKイベント生成の基準。
可能な値:1 EXPRESSION (0, デフォルト), RECOVERY_EXPRESSION (1), NONE (2)。
recovery_expression string トリガーのリカバリー式。
correlation_mode string 相関モード(イベント相関なし、またはタグによるイベント相関)。
可能な値:1 DISABLED (0, デフォルト), TAG_VALUE (1)。
correlation_tag string イベント相関に使用するタグ名。
name string (必須) トリガー名。
event_name string イベント名。
opdata string 運用データ。
url_name string トリガーに関連付けられたURLのラベル。
url string トリガーに関連付けられたURL。
status string トリガーのステータス。
可能な値:1 ENABLED (0, デフォルト), DISABLED (1)。
priority string トリガーの深刻度。
可能な値:1 NOT_CLASSIFIED (0, デフォルト), INFO (1), WARNING (2), AVERAGE (3), HIGH (4), DISASTER (5)。
description text トリガーの説明。
type string イベント生成タイプ(単一の問題イベントまたは複数の問題イベント)。
可能な値:1 SINGLE (0, デフォルト), MULTIPLE (1)。
manual_close string 問題イベントの手動クローズ。
可能な値:1 NO (0, デフォルト), YES (1)。
dependencies 依存関係のルート要素。
name string (必須) 依存トリガー名。
expression string (必須) 依存トリガーの式。
recovery_expression string 依存トリガーのリカバリー式。
tags トリガータグのルート要素。
tag string (必須) タグ名。
value string タグ値。

参照: Trigger object(同名のプロパティを参照)。

テンプレートのローレベルディスカバリルール

zabbix_export:
         (...)
         templates:
           (...)
             discovery_rules:
               - uuid: acfdea9c46ef48c68e6636f43b8f96a2
                 name: 'Network interface discovery'
                 key: net.if.discovery
                 delay: 1h
                 filter: (see table below)
                 description: 'The discovery of network interfaces.'
                 item_prototypes: (see table below)
                 trigger_prototypes: (see table below)
                 graph_prototypes: (see table below)
               (...)

テンプレートのローレベルディスカバリルール要素のほとんどは、テンプレートアイテムと同じです。 下記の表では、テンプレートアイテムと異なる要素について説明します。

要素 説明
type string アイテムタイプ。
指定可能な値:1 ZABBIX_PASSIVE (0, デフォルト), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), JMX (16), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22)。
key string (必須) ローレベルディスカバリルールのキー。
filter テンプレートのローレベルディスカバリルールフィルタのルート要素。
lifetime string 発見されなくなったリソースが削除されるまでの期間(秒、時間サフィックス、またはユーザーマクロを使用)。
デフォルト: 7d。
lifetime_type string 失われたLLDリソースを削除するシナリオ。
指定可能な値: DELETE_NEVER, DELETE_IMMEDIATELY, DELETE_AFTER。
enabled_lifetime string 発見されなくなったリソースが無効化されるまでの期間(秒、時間サフィックス、またはユーザーマクロを使用)。
enabled_lifetime_type string 失われたLLDリソースを無効化するシナリオ。
指定可能な値: DISABLE_NEVER, DISABLE_IMMEDIATELY, DISABLE_AFTER。
item_prototypes テンプレートアイテムプロトタイプ要素のルート要素。テンプレートアイテムと同じです。
trigger_prototypes テンプレートトリガープロトタイプ要素のルート要素。テンプレートアイテムトリガーと同じです。
graph_prototypes テンプレートグラフプロトタイプ要素のルート要素。ホストグラフと同じです。
host_prototypes テンプレートホストプロトタイプ要素のルート要素。ホストと同じです。
parent_discovery_rule ローレベルディスカバリルールプロトタイプの親ローレベルディスカバリルール(またはルールプロトタイプ)のルート要素。このプロパティは、参照されたルール/ルールプロトタイプの直接の子であるLLDルールプロトタイプであることを示します。
key string (必須) 親ローレベルディスカバリルール(またはルールプロトタイプ)のキー。
master_item string (DEPENDENTルールの場合は必須) 従属ルールのマスターアイテムのルート要素。
lld_macro_paths ローレベルディスカバリルールのマクロパスのルート要素。
lld_macro string (必須) ローレベルディスカバリルールのマクロ名。
path string (必須) 対応するマクロに割り当てる値のセレクタ。
preprocessing ローレベルディスカバリルール値のプリプロセスのルート要素。
step テンプレートアイテム値のプリプロセスステップと同じローレベルディスカバリルール値のプリプロセスステップ要素のルート要素。ただし、指定可能な値は少なくなります。参照: LLDルールプリプロセスオブジェクト
overrides ローレベルディスカバリルールのオーバーライドルールのルート要素。
name string (必須) 一意のオーバーライド名。
step string (必須) オーバーライドの一意の順序番号。
stop string 一致した場合、次のオーバーライドの処理を停止します。
filter テンプレートのローレベルディスカバリルールフィルタと同じテンプレートのローレベルディスカバリルールオーバーライドルールフィルタ要素のルート要素。
operations テンプレートのローレベルディスカバリルールオーバーライド操作のルート要素。

参照: LLDルールオブジェクト(同名の該当プロパティを参照)。

テンプレートのローレベルディスカバリールールフィルター
zabbix_export:
         (...)
         templates:
           (...)
             discovery_rules:
               - uuid: acfdea9c46ef48c68e6636f43b8f96a2
                 (...)
                 filter:
                   evaltype: AND
                   conditions:
                     - macro: '{#IFNAME}'
                       value: '{$NET.IF.IFNAME.MATCHES}'
                     - macro: '{#IFNAME}'
                       value: '{$NET.IF.IFNAME.NOT_MATCHES}'
                       operator: NOT_MATCHES_REGEX
                 (...)
               - uuid: 2bbdc79f082d4c618e01bec625e9c90a
                 (...)
                 filter:
                   evaltype: AND
                   conditions:
                     - macro: '{#DEVNAME}'
                       value: '{$VFS.DEV.DEVNAME.MATCHES}'
                     - macro: '{#DEVNAME}'
                       value: '{$VFS.DEV.DEVNAME.NOT_MATCHES}'
                       operator: NOT_MATCHES_REGEX
                     - macro: '{#DEVTYPE}'
                       value: disk
                 (...)
要素 説明
evaltype string フィルター条件の評価方法を上書きします。
使用可能な値:1 AND_OR (0, デフォルト), AND (1), OR (2), FORMULA (3)。
formula string フィルター条件のカスタム計算式。
conditions フィルター条件のルート要素。
macro string (必須) チェックを実行するローレベルディスカバリーマクロの名前。
value string 比較する値。
operator string 条件演算子。
使用可能な値:1 MATCHES_REGEX (8, デフォルト), NOT_MATCHES_REGEX (9)。
formulaid string (必須) カスタム式から条件を参照するために使用される任意の一意のID。大文字のみ使用可能。フィルター条件を変更する際にユーザーが定義する必要がありますが、その後リクエストする際には新たに生成されます。

参照: LLDルールフィルターオブジェクト(該当するプロパティ名で参照)。

テンプレートのローレベルディスカバリールールのオーバーライド操作
要素 説明
operationobject string 操作が適用されるオブジェクト。
可能な値:1 ITEM_PROTOTYPE (0), TRIGGER_PROTOTYPE (1), GRAPH_PROTOTYPE (2), HOST_PROTOTYPE (3)。
operator string オーバーライド条件演算子。
可能な値:1 EQUAL (1), NOT_EQUAL (2), LIKE (3), NOT_LIKE (4), REGEXP (5), NOT_REGEXP (6)。
value string オーバーライド条件演算子のための正規表現または文字列。
status string オーバーライド操作時のオブジェクトのステータス。
discover string ディスカバリの結果としてオブジェクトが追加されるかどうか。
delay string オーバーライド操作時にアイテムプロトタイプに設定される更新間隔。
history string オーバーライド操作時にアイテムプロトタイプに設定される履歴保存期間。
trends string オーバーライド操作時にアイテムプロトタイプに設定されるトレンド保存期間。
severity string オーバーライド操作時に設定されるトリガープロトタイプの深刻度。
tags オーバーライド操作時にオブジェクトに設定されるタグのルート要素。
tag string (必須) タグ名。
value string タグ値。
templates オーバーライド操作時にホストプロトタイプにリンクされるテンプレートのルート要素。
name string (必須) テンプレート名。
inventory_mode string オーバーライド操作時に設定されるホストプロトタイプのインベントリモード。

関連項目: LLDルールのオーバーライド操作オブジェクト(同名のプロパティを参照)。

テンプレートWebシナリオ

要素 説明
uuid string (必須) このWebシナリオの一意の識別子。
name string (必須) Webシナリオ名。
delay string Webシナリオを実行する頻度(秒、時間サフィックス、またはユーザーマクロを使用)。
デフォルト: 1m。
attempts integer Webシナリオステップの実行試行回数。
可能な値:1 1-10 (デフォルト: 1)。
agent string クライアントエージェント。Zabbixは選択されたブラウザを装います。
これは、Webサイトが異なるブラウザに対して異なるコンテンツを返す場合に便利です。
デフォルト: Zabbix。
http_proxy string Webシナリオで使用されるプロキシ。http://[username[:password]@]proxy.example.com[:port]の形式で指定。
variables シナリオステップで使用できるWebシナリオ変数のルート要素。
name string (必須) 変数名。
value text (必須) 変数値。
headers リクエスト実行時に送信されるHTTPヘッダーのルート要素。
ヘッダーはHTTPプロトコルで表示されるのと同じ構文でリストする必要があります。
name string (必須) ヘッダー名。
value text (必須) ヘッダー値。
status string Webシナリオのステータス。
可能な値:1 ENABLED (0, デフォルト), DISABLED (1)。
authentication string 認証方式。
可能な値:1 NONE (0, デフォルト), BASIC (1), NTLM (2)。
http_user string BASIC(HTTP)またはNTLM認証で使用されるユーザー名。
http_password string BASIC(HTTP)またはNTLM認証で使用されるパスワード。
verify_peer string WebサーバーのSSL証明書を検証するかどうか。
可能な値:1 NO (0, デフォルト), YES (1)。
verify_host string Webサーバー証明書のCommon NameフィールドまたはSubject Alternate Nameフィールドが一致するかどうかを検証します。
可能な値:1 NO (0, デフォルト), YES (1)。
ssl_cert_file string クライアント認証で使用されるSSL証明書ファイル名(PEM形式である必要があります)。
ssl_key_file string クライアント認証で使用されるSSL秘密鍵ファイル名(PEM形式である必要があります)。
ssl_key_password string SSL秘密鍵ファイルのパスワード。
steps (必須) テンプレートWebシナリオステップのルート要素。
tags Webシナリオタグのルート要素。
tag string (必須) タグ名。
value string タグ値。

参照: Webシナリオオブジェクト (同名の関連プロパティを参照)。

テンプレートWebシナリオステップ
要素 説明
name string (必須) Webシナリオステップ名。
url string (必須) 監視対象のURL。
query_fields クエリパラメータのルート要素(リクエスト実行時にURLに追加されるHTTPフィールドの配列)。
name string (必須) クエリパラメータ名。
value string クエリパラメータ値。
posts HTTP POST変数のルート要素(文字列(生のPOSTデータ)またはHTTPフィールドの配列(フォームフィールドデータ))。
name string (必須) POSTフィールド名。
value string (必須) POSTフィールド値。
variables このステップの後に適用されるべきステップレベルの変数(マクロ)のルート要素。
変数値に 'regex:' プレフィックスがある場合、その値はこのステップで返されたデータから 'regex:' プレフィックスに続く正規表現パターンに従って抽出されます
name string (必須) 変数名。
value text (必須) 変数値。
headers リクエスト実行時に送信されるHTTPヘッダーのルート要素。
name string (必須) ヘッダー名。
value text (必須) ヘッダー値。
follow_redirects string HTTPリダイレクトの追従。
指定可能な値:1 NO (0), YES (1, デフォルト)。
retrieve_mode string HTTPレスポンスの取得モード。
指定可能な値:1 BODY (0, デフォルト), HEADERS (1), BOTH (2)。
timeout string ステップ実行のタイムアウト(秒、時間のサフィックス、またはユーザーマクロを使用)。
デフォルト: 15s。
required string レスポンスに含まれている必要があるテキスト(空の場合は無視)。
status_codes string 許可されるHTTPステータスコードのカンマ区切りリスト(例: 200-201,210-299。空の場合は無視)。

参照: Webシナリオステップオブジェクト(同名の関連プロパティを参照)。

テンプレートマクロの設定

zabbix_export:
         (...)
         templates:
           - uuid: f8f7908280354f2abeed07dc788c3747
             (...)
             macros:
               - macro: '{$AGENT.TIMEOUT}'
                 (...)
                 config:
                   type: TEXT
                   priority: '1'
                   label: 'Seconds since the last Zabbix agent seen'
                   description: 'Timeout after which agent is considered unavailable.'
               - macro: '{$CPU.UTIL.CRIT}'
                 (...)
                 config:
                   type: TEXT
                   priority: '2'
                   section_name: Thresholds
                   label: 'Threshold of CPU utilization expressed'
                   description: 'Critical threshold of CPU utilization expressed in %. In the range from 0 to 100 inclusive.'
                   regex: '^-?([0-9]+|(([0-9]+)\.([0-9]+)))$'
               (...)
               - macro: '{$IFCONTROL}'
                 (...)
                 config:
                   type: CHECKBOX
                   priority: '19'
                   label: 'Interfaces control'
                   description: 'Fire a trigger when the interface operational status changes to "Link down".'
                   options:
                     - checked: '1'
                       unchecked: '0'
               (...)
要素 説明
type string (必須) マクロ入力フィールドのタイプ。
指定可能な値:1 NOCONF (0), TEXT (1), LIST (2), CHECKBOX (3)。
priority string マクロリスト内でのマクロの位置。
section_name string マクロがグループ化される折りたたみセクションのラベル。
label string (TEXT、LIST、CHECKBOXマクロで必須) マクロのラベル。
description text マクロのヘルプテキスト。Markdown書式をサポート。
required string マクロを必須としてマークします。
指定可能な値:1 NO (0), YES (1)。
TEXTおよびLISTマクロでサポート。
regex string テキストボックスフィールドでのユーザー入力を検証するための正規表現。
TEXTマクロでサポート。
options LISTアイテムまたはCHECKBOX値のルート要素。
value string (LISTマクロで必須) LISTアイテムの値。
text string (LISTマクロで必須) LISTアイテムのテキスト。
checked string (CHECKBOXマクロで必須) チェック状態を表す値。
指定可能な値:1 0 (false), 1 (true)。
CHECKBOXマクロでサポート。
unchecked string (CHECKBOXマクロで必須) 未チェック状態を表す値。
指定可能な値:1 0 (false), 1 (true)。
CHECKBOXマクロでサポート。

参考: マクロ設定オブジェクト(同名のプロパティを参照)。

テンプレートダッシュボード

zabbix_export:
         (...)
         templates:
           (...)
             dashboards:
               - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
                 name: Filesystems
                 pages:
                   - name: Overview
                     widgets: (下表参照)
               (...)
要素 説明
uuid string (必須) このダッシュボードの一意の識別子。
name string (必須) テンプレートダッシュボード名。
display period integer ダッシュボードページの表示期間。
auto_start string スライドショーの自動開始。
指定可能な値:1 NO (0), YES (1, デフォルト)。
pages テンプレートダッシュボードページのルート要素。
name string ページ名。
display period integer ページの表示期間。
sortorder integer ページの並び順。
widgets テンプレートダッシュボードウィジェットのルート要素。

参照: テンプレートダッシュボードオブジェクト(同名のプロパティを参照)。

テンプレートダッシュボードウィジェット
zabbix_export:
         (...)
         templates:
           (...)
             dashboards:
               - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
                 name: Filesystems
                 pages:
                   - name: Overview
                     widgets:
                       - type: graphprototype
                         width: '72'
                         height: '5'
                         fields:
                           - type: INTEGER
                             name: columns
                             value: '3'
                           - type: GRAPH_PROTOTYPE
                             name: graphid.0
                             value:
                               host: 'Linux by Zabbix agent'
                               name: 'FS [{#FSTYPE}({#FSNAME})]: Space utilization chart (relative to total)'
                           - type: STRING
                             name: reference
                             value: AAAEB
                       - type: graphprototype
                         'y': '5'
                         width: '72'
                         height: '5'
                         fields:
                           - type: INTEGER
                             name: columns
                             value: '1'
                           - type: GRAPH_PROTOTYPE
                             name: graphid.0
                             value:
                               host: 'Linux by Zabbix agent'
                               name: 'FS [{#FSTYPE}({#FSNAME})]: Space usage graph, in % (relative to max available)'
                           - type: STRING
                             name: reference
                             value: AAAEC
               (...)
要素 説明
type string (必須) ウィジェットタイプ。
name string ウィジェット名。
x integer テンプレートダッシュボードの左端からの水平位置。
可能な値:1 0-71。
y integer テンプレートダッシュボードの上端からの垂直位置。
可能な値:1 0-63。
width integer ウィジェットの幅。
可能な値:1 1-72。
height integer ウィジェットの高さ。
可能な値:1 1-64。
hide_header string ウィジェットヘッダーの非表示。
可能な値:1 NO (0, デフォルト), YES (1)。
fields テンプレートダッシュボードウィジェットフィールドのルート要素。
type string (必須) ウィジェットフィールドタイプ。
可能な値:1 INTEGER (0), STRING (1), ITEM (4), ITEM_PROTOTYPE (5), GRAPH (6), GRAPH_PROTOTYPE (7), MAP (8), SERVICE (9), SLA (10), USER (11), ACTION (12), MEDIA_TYPE (13)。
name string (必須) ウィジェットフィールド名。
value mixed (必須) フィールドタイプに応じたウィジェットフィールド値。

関連項目: テンプレートダッシュボードウィジェットオブジェクト(同名のプロパティを参照)。

テンプレートの値のマッピング

zabbix_export:
         (...)
         templates:
           (...)
             valuemaps:
               - uuid: 8c048c6cca8248f2860c208e8db0f59e
                 name: ifOperStatus
                 mappings:
                   - value: '0'
                     newvalue: unknown
                   - value: '1'
                     newvalue: notpresent
                   - value: '2'
                     newvalue: down
                   - value: '3'
                     newvalue: lowerlayerdown
                   - value: '4'
                     newvalue: testing
                   - value: '5'
                     newvalue: dormant
                   - value: '6'
                     newvalue: up
               (...)
要素 説明
uuid 文字列 (必須) この値のマッピングの一意の識別子。
name 文字列 (必須) 値のマッピング名。
mapping マッピングのルート要素。
type 文字列 マッピングの一致タイプ。
可能な値:1 EQUAL (0, デフォルト), GREATER_OR_EQUAL (2), LESS_OR_EQUAL (3), IN_RANGE (4), REGEXP (5), DEFAULT (6)。
value 文字列 元の値。
newvalue 文字列 (必須) 元の値がマッピングされる値。

参照: 値のマッピングオブジェクト (同名の関連プロパティを参照)。

脚注

1 括弧内のAPI整数値(例:ENABLED(0))は参照用にのみ記載されています。 詳細については、表のエントリまたは各セクションの最後にあるリンクされたAPIオブジェクトページを参照してください。