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: '8.0'
  template_groups:
    - uuid: 846977d1dfed4968bc5f8bdb363285bc
      name: 'Templates/Operating systems'
  templates: (see table below)
  triggers: (see table below)
  graphs: (see table below)

テンプレート

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: (下記の表を参照)
    (...)

テンプレートアイテム

zabbix_export:
  (...)
  templates:
    (...)
      items:
        - uuid: f94f9f4699e94c369e6c98b2a2f485ce
          name: 'Zabbixエージェント ping'
          key: agent.ping
          description: 'エージェントはこのアイテムに対して常に "1" を返します。可用性チェックのために `nodata()` と組み合わせて使用できます。'
          valuemap:
            name: 'Zabbixエージェント ping status'
          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: （以下の表を参照）
        (...)

テンプレートアイテムの値の事前処理ステップ

zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          preprocessing:
            - type: JSONPATH
              parameters:
                - $.length()
            - type: DISCARD_UNCHANGED_HEARTBEAT
              parameters:
                - 12h
          (...)

テンプレートアイテムのトリガー

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
        (...)

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

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)
        (...)

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

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
          (...)

テンプレートのローレベルディスカバリールールのオーバーライド操作

テンプレートWebシナリオ

テンプレート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'
        (...)

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

zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              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
        (...)

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

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
        (...)

脚注

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