3 テンプレート

概要

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

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

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

エクスポート

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

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

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

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

インポート

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

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

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

すべて 行のチェックボックスをクリックすると、その下にあるすべての要素がオン/オフされます。

インポートルール:

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

同じ名前のテンプレートがすでに存在する場合、クリーンなインポートを実現するには、インポート時に 不足分を削除 オプションをチェックする必要があります。 こうすることで、更新後のテンプレートに含まれなくなった古いアイテムが削除されます(これらの古いアイテムの履歴が失われることに注意してください)。

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

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

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

エクスポート形式

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

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

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

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

テンプレートのメタデータ

zabbix_export:
  version: '7.4'
  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エージェント 7.4以降が必要です。(...) 
      wizard_ready: 'YES'
      readme: |
        ## 概要

        これは公式のLinuxテンプレートです。Zabbixエージェント 7.4以降が必要です。(...)
      vendor:
        name: Zabbix
        version: 7.4-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: (以下の表を参照)
    (...)
要素 Type 説明
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、7.4-0、7.4-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エージェント ping'
          key: agent.ping
          description: 'このアイテムに対して、エージェントは常に "1" を返します。可用性チェックのために `nodata()` と組み合わせて使用できます。'
          valuemap:
            name: 'Zabbixエージェント ping ステータス'
          tags:
            - tag: component
              value: system
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          name: 'インストール済みパッケージ数'
          key: system.sw.packages.get
          delay: 1h
          preprocessing: (以下の表を参照)
          tags:
            - tag: component
              value: os
          triggers: (以下の表を参照)
        - uuid: 403cebed115441369e94d35d070ca7b8
          name: 'メモリ使用率'
          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: (以下の表を参照)
        (...)
Element Type 説明
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 履歴データを保存する期間(time suffixuser macro または LLD macro を使用)。
デフォルト: 31d。
trends string トレンドデータを保存する期間(time suffixuser macro または LLD macro を使用)。
デフォルト: 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)、Kerberos (3)、または Digest (4)。
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) など(サポートされるフィールドについては Host inventory を参照)。
valuemap アイテムの値マッピングのルート要素。
name string (必須)アイテムで使用する値マッピング名。
logtimefmt string ログエントリ内の時刻の形式。
LOG 値型のアイテムでサポートされます。
preprocessing アイテム値の前処理のルート要素。
step テンプレートアイテム値の前処理ステップ のルート要素。
jmx_endpoint string JMXエンドポイント。
JMX アイテムでサポートされます。
master_item (DEPENDENT アイテムで必須)依存アイテムのマスターアイテムのルート要素。
key string (必須)依存アイテムのマスターアイテムキー。
timeout string アイテムデータのポーリング要求タイムアウト。
Timeouts のアイテムタイプ一覧でサポートされます。
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 POST データ本文のタイプ。
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 テンプレートアイテムトリガー のルート要素。

関連項目: Item object(一致する名前の関連プロパティを参照してください)。

テンプレートのアイテム値前処理ステップ
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
        (...)
要素 Type 説明
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: 'ネットワークインターフェースのディスカバリ'
          key: net.if.discovery
          delay: 1h
          filter: (下の表を参照)
          description: 'ネットワークインターフェースをディスカバリします。'
          item_prototypes: (下の表を参照)
          trigger_prototypes: (下の表を参照)
          graph_prototypes: (下の表を参照)
        (...)

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

Element Type Description
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 ディスカバリされなくなったリソースが削除されるまでの期間(秒、time suffix、または user macro を使用)。
デフォルト: 7d。
lifetime_type string 失われたLLDリソースを削除するシナリオ。
指定可能な値: DELETE_NEVER, DELETE_IMMEDIATELY, DELETE_AFTER。
enabled_lifetime string ディスカバリされなくなったリソースが無効化されるまでの期間(秒、time suffix、または user macro を使用)。
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 rule preprocessing object
overrides ローレベルディスカバリルールのオーバーライドルールのルート要素。
name string (必須)一意のオーバーライド名。
step string (必須)オーバーライドの一意の順序番号。
stop string 一致した場合に後続のオーバーライドの処理を停止します。
filter テンプレートのローレベルディスカバリルールのオーバーライドルールフィルター要素のルート要素。これは テンプレートのローレベルディスカバリルールフィルター と同じです。
operations テンプレートのローレベルディスカバリルールのオーバーライド操作 のルート要素。

参照: LLD rule object(一致する名前の関連プロパティを参照してください)。

テンプレートのローレベルディスカバリルールのフィルター
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
          (...)
Element Type Description
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。使用できるのは大文字のみです。フィルター条件を変更する際、このIDはユーザーが定義する必要がありますが、その後に条件を要求すると新たに生成されます。

関連項目: LLD rule filter object(一致する名前の関連プロパティを参照してください)。

テンプレートのローレベルディスカバリルールのオーバーライド操作
要素 説明
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 rule override operation object(一致する名前の関連プロパティを参照してください)。

テンプレートのWebシナリオ

要素 Type 説明
uuid string (必須) このWebシナリオの一意な識別子。
name string (必須) Webシナリオ名。
delay string Webシナリオの実行頻度(秒、time suffix、または user macro を使用)。
デフォルト: 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)、Kerberos (3)、または Digest (4)。
http_user string BASIC (HTTP)、NTLM、Kerberos、または Digest 認証で使用するユーザー名。
http_password string BASIC (HTTP)、NTLM、Kerberos、または Digest 認証で使用するパスワード。
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 scenario object(一致する名前の関連プロパティを参照してください)。

テンプレートWebシナリオのステップ
要素 Type 説明
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 ステップ実行のタイムアウト(秒、time suffix、または user macro を使用)。
デフォルト: 15s。
required string レスポンス内に存在する必要があるテキスト(空の場合は無視されます)。
status_codes string 許可されるHTTPステータスコードのカンマ区切りリスト(例: 200-201,210-299。空の場合は無視されます)。

参照: Web scenario step object(一致する名前の関連プロパティを参照してください)。

テンプレートマクロ設定

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      (...)
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          (...)
          config:
            type: TEXT
            priority: '1'
            label: '最後にZabbixエージェントが確認されてからの秒数'
            description: 'エージェントが利用不可と見なされるまでのタイムアウト。'
        - macro: '{$CPU.UTIL.CRIT}'
          (...)
          config:
            type: TEXT
            priority: '2'
            section_name: Thresholds
            label: 'CPU使用率のしきい値'
            description: 'CPU使用率の重大なしきい値(%)。0から100までの範囲です。'
            regex: '^-?([0-9]+|(([0-9]+)\.([0-9]+)))$'
        (...)
        - macro: '{$IFCONTROL}'
          (...)
          config:
            type: CHECKBOX
            priority: '19'
            label: 'インターフェース制御'
            description: 'インターフェースの動作状態が "Link down" に変化したときにトリガーを生成します。'
            options:
              - checked: '1'
                unchecked: '0'
        (...)
要素 Type 説明
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 マクロでサポートされます。

関連項目: Macro configuration object(一致する名前の関連プロパティを参照してください)。

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

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 説明
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 (必須) フィールドタイプに応じたウィジェットフィールド値。

参照: Template dashboard widget object (一致する名前の関連プロパティを参照してください)。

テンプレートの値マップ

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
        (...)
要素 Type 説明
uuid string (必須) この値マップの一意の識別子。
name string (必須) 値マップ名。
mapping マッピングのルート要素。
type string マッピングの一致タイプ。
使用可能な値:1 EQUAL (0、デフォルト)、GREATER_OR_EQUAL (2)、LESS_OR_EQUAL (3)、IN_RANGE (4)、REGEXP (5)、DEFAULT (6)。
value string 元の値。
newvalue string (必須) 元の値がマッピングされる先の値。

参照: Value map object(一致する名前の関連プロパティを参照してください)。

脚注

1 かっこ内のAPI integer値(例: ENABLED (0))は、参照用としてのみ記載されています。 詳細については、表のエントリ内のリンク先APIオブジェクトページ、または各セクションの末尾を参照してください。