4 ホスト

概要

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

ホストのエクスポートには、以下が含まれます。

  • リンクされたホストグループ
  • ホストデータ
  • テンプレートのリンク
  • ホストグループのリンク
  • ホストインターフェース
  • 直接リンクされたアイテム
  • 直接リンクされたトリガー
  • すべてのプロトタイプを含む、直接リンクされたディスカバリルール
  • 直接リンクされたWebシナリオ
  • ホストマクロ
  • ホストインベントリデータ
  • 値マップ
  • リンクされたグラフ

エクスポート

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

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

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

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

インポート

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

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

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

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

インポートルール:

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

インポートの成功または失敗のメッセージがWebインターフェースに表示されます。

エクスポート形式

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

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

以下のセクションでは、エクスポート形式の各要素について説明します。 例では、MySQL by Zabbix agent 2 テンプレートを使用するホストを用いています。 要素の説明を目的として、ホストの作成後にテンプレートのリンクを解除しています。 リンクを解除しても、すべての要素は設定内に保持されます(リンク解除とクリアを行った場合とは異なり、その場合は要素が削除されます)。

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

ホストメタデータ

zabbix_export:
  version: '7.4'
  host_groups:
    - uuid: 748ad4d098d447d492bb935c907f652f
      name: Databases
  hosts: (以下の表を参照)
  graphs: (以下の表を参照)
要素 Type 説明
version string (必須) Zabbixのバージョン。
host_groups (必須) ホストグループのルート要素。
uuid string (必須) このホストグループの一意の識別子。
name string (必須) ホストグループ名。
hosts ホスト のルート要素。
graphs ホストグラフ のルート要素。

ホスト

zabbix_export:
  (...)
  hosts:
    - host: 'MySQL server'
      name: 'MySQL server'
      groups:
        - name: Databases
      interfaces: (以下の表を参照)
      items: (以下の表を参照)
      discovery_rules: (以下の表を参照)
      tags:
        - tag: location
          value: Riga
      macros:
        (...)
        - macro: '{$MYSQL.DSN}'
          value: 192.0.2.0
        (...)
        - macro: '{$MYSQL.PASSWORD}'
          type: SECRET_TEXT
          description: 'MySQL user password.'
        (...)
      valuemaps: (以下の表を参照)
  (...)
Element Type 説明
host string (必須)一意のホスト名。
name string 表示用ホスト名。
description text ホストの説明。
monitored_by string ホストの監視方法。
指定可能な値:1 SERVER (0、デフォルト)、PROXY (1)、または PROXY_GROUP (2)。
proxy プロキシのルート要素。
name string (必須)ホストを監視するプロキシの名前(存在する場合)。
proxy_group プロキシグループのルート要素。
name string (必須)ホストの監視に使用されるプロキシグループの名前(存在する場合)。
status string ホストのステータス。
指定可能な値:1 ENABLED (0、デフォルト)、DISABLED (1)。
ipmi_authtype string IPMIセッションの認証タイプ。
指定可能な値:1 DEFAULT (-1、デフォルト)、NONE (0)、MD2 (1)、MD5 (2)、STRAIGHT (4)、OEM (5)、RMCP_PLUS (6)。
ipmi_privilege string IPMIセッションの権限レベル。
指定可能な値:1 CALLBACK (1)、USER (2、デフォルト)、OPERATOR (3)、ADMIN (4)、OEM (5)。
ipmi_username string IPMIチェック用のユーザー名。
ipmi_password string IPMIチェック用のパスワード。
templates リンクされたテンプレートのルート要素。
name string (必須)テンプレート名。
groups ホストグループのルート要素。ホストが所属するホストグループを指定します。
name string (必須)ホストグループ名。
interfaces ホストインターフェース のルート要素。
items ホストアイテム のルート要素。
discovery_rules ホストのローレベルディスカバリルール のルート要素。
http_tests ホストのWebシナリオ のルート要素。
tags ホストタグのルート要素。
tag string (必須)タグ名。
value string タグ値。
macros ホストマクロのルート要素。
macro string (必須)ユーザーマクロ名。
type string ユーザーマクロのタイプ。
指定可能な値:1 TEXT (0、デフォルト)、SECRET_TEXT (1)、VAULT (2)。
value string ユーザーマクロ値。
description string ユーザーマクロの説明。
inventory ホストインベントリのルート要素。
<inventory_property> string インベントリプロパティ。すべてのプロパティには対応する要素があります(typenameos など。例については Export format を参照)。
inventory_mode string インベントリモード。
指定可能な値:1 DISABLED (-1)、MANUAL (0、デフォルト)、AUTOMATIC (1)。
valuemaps ホストの値マップ のルート要素。

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

ホストインターフェース

zabbix_export:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      interfaces:
        - ip: 192.0.2.0
          interface_ref: if1
      (...)
要素 Type 説明
default string これがプライマリホストインターフェースであるかどうか。1つのホスト上では、1つのタイプにつきプライマリインターフェースは1つだけ設定できます。
指定可能な値:1 NO (0), YES (1, デフォルト)。
type string インターフェースのタイプ。
指定可能な値:1 ZABBIX (1, デフォルト), SNMP (2), IPMI (3), JMX (4)。
useip string ホストへの接続にIPをインターフェースとして使用するかどうか(使用しない場合はDNSが使用されます)。
指定可能な値:1 NO (0), YES (1, デフォルト)。
ip string (IP接続で必須)IPアドレス(IPv4またはIPv6)。
dns string (DNS接続で必須)DNS名。
port string ポート番号。
details インターフェース詳細のルート要素。
version string 使用するSNMPバージョン。
指定可能な値:1 SNMPV1 (1), SNMP_V2C (2, デフォルト), SNMP_V3 (3)。
community string (SNMPv1およびSNMPv2アイテムで必須)SNMPコミュニティ。
max_repetitions string ネイティブSNMPバルクリクエスト(GetBulkRequest-PDUs)の最大繰り返し値。
SNMPv2およびSNMPv3アイテム(discovery[] および walk[] アイテム)でサポートされます。
デフォルト: 10。
contextname string SNMPv3コンテキスト名。
SNMPv3アイテムでサポートされます。
securityname string SNMPv3セキュリティ名。
SNMPv3アイテムでサポートされます。
securitylevel string SNMPv3セキュリティレベル。
SNMPv3アイテムでサポートされます。
指定可能な値:1 NOAUTHNOPRIV (0, デフォルト), AUTHNOPRIV (1), AUTHPRIV (2)。
authprotocol string SNMPv3認証プロトコル。
SNMPv3アイテムでサポートされます。
指定可能な値:1 MD5 (0, デフォルト), SHA1 (1), SHA224 (2), SHA256 (3), SHA384 (4), SHA512 (5)。
authpassphrase string SNMPv3認証パスフレーズ。
SNMPv3アイテムでサポートされます。
privprotocol string SNMPv3プライバシープロトコル。
SNMPv3アイテムでサポートされます。
指定可能な値:1 DES (0, デフォルト), AES128 (1), AES192 (2), AES256 (3), AES192C (4), AES256C (5)。
privpassphrase string SNMPv3プライバシーパスフレーズ。
SNMPv3アイテムでサポートされます。
bulk string SNMPにバルクリクエストを使用するかどうか。
指定可能な値:1 NO (0), YES (1, デフォルト)。
interface_ref string アイテムで使用するインターフェース参照名(形式: if<N>)。

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

ホストのアイテム

zabbix_export:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      items:
        (...)
        - name: 'Binlog cache disk use'
          type: DEPENDENT
          key: mysql.binlog_cache_disk_use
          value_type: FLOAT
          description: '`binlog_cache_size` に収まらないため、通常のバイナリログキャッシュではなく一時ディスクキャッシュを使用したトランザクション数。'
          preprocessing: (下表を参照)
          master_item:
            key: 'mysql.get_status_variables["{$MYSQL.DSN}","{$MYSQL.USER}","{$MYSQL.PASSWORD}"]'
          tags:
            - tag: component
              value: cache
        (...)
        - name: 'Buffer pool utilization'
          type: CALCULATED
          key: mysql.buffer_pool_utilization
          value_type: FLOAT
          units: '%'
          params: |
            ( last(//mysql.innodb_buffer_pool_pages_total) - 
            last(//mysql.innodb_buffer_pool_pages_free) ) / 
            ( last(//mysql.innodb_buffer_pool_pages_total) + 
            ( last(//mysql.innodb_buffer_pool_pages_total) = 0 ) ) * 100 * 
            ( last(//mysql.innodb_buffer_pool_pages_total) > 0 )
          description: 'バッファプール内の総ページ数に対する使用済みページ数の比率。'
          tags:
            - tag: component
              value: memory
          triggers: (下表を参照)
        (...)
        - name: Uptime
          type: DEPENDENT
          key: mysql.uptime
          units: uptime
          description: 'サーバーが稼働している秒数。'
          preprocessing: (下表を参照)
          master_item:
            key: 'mysql.get_status_variables["{$MYSQL.DSN}","{$MYSQL.USER}","{$MYSQL.PASSWORD}"]'
          tags:
            - tag: component
              value: application
          triggers: (下表を参照)
        (...)
Element Type 説明
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), ITEM_TYPE_NESTED (23)。
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 ホストのアイテム値前処理ステップ のルート要素。
interface_ref string ホストインターフェースへの参照(形式: if<N>)。
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:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      items:
        (...)
        - name: 'Binlog cache disk use'
          (...)
          preprocessing:
            - type: JSONPATH
              parameters:
                - $.Binlog_cache_disk_use
            - type: DISCARD_UNCHANGED_HEARTBEAT
              parameters:
                - 6h
          (...)
要素 Type 説明
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:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      items:
        (...)
        - name: Uptime
          (...)
          triggers:
            - expression: 'nodata(/MySQL server/mysql.uptime,30m)=1'
              name: 'MySQL: Failed to fetch info data'
              event_name: 'MySQL: Failed to fetch info data (or no data for 30m)'
              priority: INFO
              description: 'Zabbix has not received any data for items for the last 30 minutes.'
              dependencies:
                - name: 'MySQL: Service is down'
                  expression: 'last(/MySQL server/mysql.ping["{$MYSQL.DSN}","{$MYSQL.USER}","{$MYSQL.PASSWORD}"])=0'
              tags:
                - tag: scope
                  value: availability
            - expression: 'last(/MySQL server/mysql.uptime)<10m'
              name: 'MySQL: Service has been restarted'
              event_name: 'MySQL: Service has been restarted (uptime < 10m)'
              priority: INFO
              description: 'MySQL uptime is less than 10 minutes.'
              tags:
                - tag: scope
                  value: notice
        (...)
要素 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:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      discovery_rules:
        - name: 'Database discovery'
          key: 'mysql.db.discovery["{$MYSQL.DSN}","{$MYSQL.USER}","{$MYSQL.PASSWORD}"]'
          delay: 1h
          filter: (see table below)
          description: 'Scanning databases in DBMS.'
          interface_ref: if1
          item_prototypes:
            - name: 'Size of database {#DATABASE}'
              key: 'mysql.db.size["{$MYSQL.DSN}","{$MYSQL.USER}","{$MYSQL.PASSWORD}","{#DATABASE}"]'
              delay: 5m
              units: B
              description: 'Database size.'
              preprocessing:
                - type: DISCARD_UNCHANGED_HEARTBEAT
                  parameters:
                    - 1h
              interface_ref: if1
              tags:
                - tag: component
                  value: storage
                - tag: database
                  value: '{#DATABASE}'
          lld_macro_paths:
            - lld_macro: '{#DATABASE}'
              path: $.Database
          preprocessing:
            - type: DISCARD_UNCHANGED_HEARTBEAT
              parameters:
                - 1d
        (...)

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

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:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      discovery_rules:
        - name: 'Database discovery'
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#DATABASE}'
                value: '{$MYSQL.DBNAME.MATCHES}'
              - macro: '{#DATABASE}'
                value: '{$MYSQL.DBNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
          (...)
要素 Type 説明
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(一致する名前の関連プロパティを参照してください)。

ホストのローレベルディスカバリルールの上書き操作
要素 Type 説明
operationobject string 操作が適用されるオブジェクト。
使用可能な値:1 ITEM_PROTOTYPE (0), TRIGGER_PROTOTYPE (1), GRAPH_PROTOTYPE (2), HOST_PROTOTYPE (3), DISCOVERY_PROTOTYPE (4)。
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シナリオ

Element Type 説明
uuid string (必須) このWebシナリオの一意の識別子。
name string (必須) Webシナリオ名。
delay string Webシナリオを実行する頻度(秒、time suffix、または user macro を使用)。
デフォルト: 1m。
attempts integer Webシナリオのステップを実行する試行回数。
指定可能な値: 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シナリオのステップ
要素 説明
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:
  (...)
  graphs:
    - name: 'MySQL: Bandwidth'
      graph_items: (以下の表を参照)
    (...)
要素 説明
uuid string グラフの一意な識別子。
name string (必須)グラフ名。
width integer グラフの幅(ピクセル単位)。
プレビューおよび円/分離円グラフで使用されます。
指定可能な値:1 20-65535(デフォルト: 900)。
height integer グラフの高さ(ピクセル単位)。
プレビューおよび円/分離円グラフで使用されます。
指定可能な値:1 20-65535(デフォルト: 900)。
yaxismin double Y軸の最小値。
Y軸の最小値がFIXEDの場合にサポートされます。
デフォルト: 0。
yaxismax double Y軸の最大値。
X軸の最小値がFIXEDの場合にサポートされます。
デフォルト: 0。
show_work_period string 非稼働時間を強調表示します。
NORMALおよびSTACKEDグラフでサポートされます。
指定可能な値:1 NO (0), YES (1、デフォルト)。
show_triggers string 単純トリガーの値を線として表示します。
NORMALおよびSTACKEDグラフでサポートされます。
指定可能な値:1 NO (0), YES (1、デフォルト)。
type string グラフの種類。
指定可能な値:1 NORMAL (0、デフォルト), STACKED (1), PIE (2), EXPLODED (3)。
show_legend string グラフの凡例を表示します。
指定可能な値:1 NO (0), YES (1、デフォルト)。
show_3d string 3Dスタイルを有効にします。
NORMALおよびSTACKEDグラフでサポートされます。
指定可能な値:1 NO (0、デフォルト), YES (1)。
percent_left double 左軸のパーセンタイル線を表示します。
NORMALグラフでサポートされます。
デフォルト: 0。
percent_right double 右軸のパーセンタイル線を表示します。
NORMALグラフでサポートされます。
デフォルト: 0。
ymin_type_1 string Y軸の最小値。
NORMALおよびSTACKEDグラフでサポートされます。
指定可能な値:1 CALCULATED (0、デフォルト), FIXED (1), ITEM (2)。
ymin_item_1 (ymin_type_1ITEM に設定されている場合は必須) 個々のアイテム詳細のルート要素。
host string (必須)アイテムのホスト。
key string (必須)アイテムキー。
ymax_type_1 string Y軸の最大値。
NORMALおよびSTACKEDグラフでサポートされます。
指定可能な値:1 CALCULATED (0、デフォルト), FIXED (1), ITEM (2)。
ymax_item_1 (ymax_type_1ITEM に設定されている場合は必須) 個々のアイテム詳細のルート要素。
host string (必須)アイテムのホスト。
key string (必須)アイテムキー。
graph_items (必須)ホストグラフアイテムのルート要素。

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

ホストのグラフアイテム
zabbix_export:
  (...)
  graphs:
    - name: 'MySQL: Bandwidth'
      graph_items:
        - drawtype: GRADIENT_LINE
          color: 199C0D
          item:
            host: 'MySQL server'
            key: mysql.bytes_received.rate
        - sortorder: '1'
          drawtype: GRADIENT_LINE
          color: F63100
          item:
            host: 'MySQL server'
            key: mysql.bytes_sent.rate
    (...)
要素 < Type 説明
sortorder < integer 描画順序。値が小さいものから先に描画されます。ほかの線や領域の背後(または前面)に描画するために使用できます。
drawtype < string グラフアイテムの描画スタイル。
NORMAL グラフでサポートされています。
指定可能な値:1 SINGLE_LINE (0、デフォルト)、FILLED_REGION (1)、BOLD_LINE (2)、DOTTED_LINE (3)、DASHED_LINE (4)、GRADIENT_LINE (5)。
color < string 要素の色(16進数6文字)。
yaxisside < string グラフアイテムの Y 軸スケールを描画するグラフの側。
NORMAL および STACKED グラフでサポートされています。

指定可能な値:1 LEFT (0、デフォルト)、RIGHT (1)。
calc_fnc < string アイテムに複数の値が存在する場合に描画するデータ。
指定可能な値:1 MIN (1)、AVG (2、デフォルト)、MAX (4)、ALL (7、最小値・平均値・最大値。シンプルグラフでサポート)、LAST (9、円グラフ/分解円グラフでサポート)。
type < string グラフアイテムのタイプ。
指定可能な値:1 SIMPLE (0、デフォルト)、GRAPH_SUM (2、アイテムの値が円グラフ全体を表します。円グラフ/分解円グラフでサポート)。
item < (必須) 個別のアイテム。
< host string (必須) アイテムのホスト。
^ key string (必須) アイテムキー。

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

ホストの値のマッピング

zabbix_export:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      valuemaps:
        - name: 値のマッピングの例
          mappings:
            - value: '1'
              newvalue: 変換後の値の例
  (...)
要素 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オブジェクトページ、または各セクションの末尾を参照してください。