ホスト

概要

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

ホストのエクスポートには、次の内容が含まれます。

  • リンクされたホストグループ
  • ホストデータ
  • テンプレートのリンク
  • ホストグループのリンク
  • ホストインターフェース
  • 直接リンクされたアイテム
  • 直接リンクされたトリガー
  • すべてのプロトタイプを含む、直接リンクされたディスカバリルール
  • 直接リンクされた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
Update existing 既存の要素は、インポートファイルのデータを使用して更新されます。そうでない場合は、更新されません。
Create new 新しい要素は、インポートファイルのデータを使用して作成されます。そうでない場合は、作成されません。
Delete missing インポートファイルに存在しない既存の要素は削除されます。そうでない場合は、削除されません。
Template linkage に対して Delete missing が有効な場合、インポートファイルに存在しない現在のテンプレートリンクは解除されます。解除されたテンプレートから継承されたエンティティ(アイテム、トリガー、グラフなど)は削除されません(各エンティティに対しても Delete missing オプションが選択されている場合を除く)。

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

エクスポート形式

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

各要素には特定の役割があり、入れ子の要素を含む場合があります。

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

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

ホストメタデータ

zabbix_export:
  version: '8.0'
  host_groups:
    - uuid: 748ad4d098d447d492bb935c907f652f
      name: Databases
  hosts: (see table below)
  graphs: (see table below)
Element Type Description
version string (必須) Zabbixのバージョン。
host_groups (必須) ホストグループのルート要素。
uuid string (必須) このホストグループの一意の識別子。
name string (必須) ホストグループ名。
hosts ホストのルート要素。
graphs ホストグラフのルート要素。

ホスト

zabbix_export:
  (...)
  hosts:
    - host: 'MySQL server'
      name: 'MySQL server'
      groups:
        - name: Databases
      interfaces: (see table below)
      items: (see table below)
      discovery_rules: (see table below)
      tags:
        - tag: location
          value: Riga
      macros:
        (...)
        - macro: '{$MYSQL.DSN}'
          value: 192.0.2.1
        (...)
        - macro: '{$MYSQL.PASSWORD}'
          type: SECRET_TEXT
          description: 'MySQL user password.'
        (...)
      valuemaps: (see table below)
  (...)
Element Type Description
host string (必須) 一意のホスト名。
name string 表示用ホスト名。
description text ホストの説明。
monitored_by string ホストの監視方法。
可能な値:1 SERVER (0, default), PROXY (1), or PROXY_GROUP (2).
proxy プロキシのルート要素。
name string (必須) ホストを監視するプロキシの名前(ある場合)。
proxy_group プロキシグループのルート要素。
name string (必須) ホストの監視に使用するプロキシグループの名前(ある場合)。
status string ホストのステータス。
可能な値:1 ENABLED (0, default), DISABLED (1).
ipmi_authtype string IPMIセッションの認証タイプ。
可能な値:1 DEFAULT (-1, default), NONE (0), MD2 (1), MD5 (2), STRAIGHT (4), OEM (5), RMCP_PLUS (6).
ipmi_privilege string IPMIセッションの権限レベル。
可能な値:1 CALLBACK (1), USER (2, default), 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, default), SECRET_TEXT (1), VAULT (2).
value string ユーザーマクロの値。
description string ユーザーマクロの説明。
inventory ホストインベントリのルート要素。
<inventory_property> string インベントリプロパティ。すべてのプロパティにはそれぞれ対応する要素があります (type, name, os など。例: Export format を参照)。
inventory_mode string インベントリモード。
可能な値:1 DISABLED (-1), MANUAL (0, default), AUTOMATIC (1).
valuemaps ホストの値マップのルート要素。

参照: Host object(該当する名前のプロパティを参照してください)。

ホストインターフェース

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

参照: ホストインターフェースオブジェクト(該当する名前のプロパティを参照してください)。

ホストアイテム

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: (see table below)
          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: (see table below)
        (...)
        - name: Uptime
          type: DEPENDENT
          key: mysql.uptime
          units: uptime
          description: 'サーバーが稼働していた秒数。'
          preprocessing: (see table below)
          master_item:
            key: 'mysql.get_status_variables["{$MYSQL.DSN}","{$MYSQL.USER}","{$MYSQL.PASSWORD}"]'
          tags:
            - tag: component
              value: application
          triggers: (see table below)
        (...)
Element Type Description
name string (必須) アイテム名。
type string アイテムの種類。
可能な値:1 ZABBIX_PASSIVE (0, default), 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, default), DISABLED (1).
value_type string 受信値の型。
可能な値:1 FLOAT (0), CHAR (1), LOG (2), UNSIGNED (3, default), TEXT (4), BINARY (5), JSON (6).
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, default), PUBLIC_KEY (1).
HTTP_AGENT アイテムでの可能な値:1 NONE (0, default), BASIC (1), NTLM (2), Kerberos (3), or 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, default).
post_type string POSTデータ本文の種類。
HTTP_AGENT アイテムでサポートされます。
可能な値:1 RAW (0, default), JSON (1), 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, default), HEADERS (1), BOTH (2).
request_method string リクエストメソッドの種類。
HTTP_AGENT アイテムでサポートされます。
可能な値:1 GET (0, default), POST (1), PUT (2), HEAD (3).
output_format string レスポンスの処理方法。
HTTP_AGENT アイテムでサポートされます。
可能な値:1 RAW (0, default), JSON (1).
allow_traps string トラッパーアイテムと同様に値を設定できるようにするかどうか。
HTTP_AGENT アイテムでサポートされます。
可能な値:1 NO (0, default), 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, default), YES (1).
verify_host string 接続先のホスト名がホストの証明書内のものと一致することを検証するかどうか。
HTTP_AGENT アイテムでサポートされます。
可能な値:1 NO (0, default), 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
          (...)
Element Type Description
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, calculated: received value - previous value), CHANGE_PER_SECOND (10, calculated: (received value - previous value)/(time now - time of last check)), 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, default), DISCARD_VALUE (1), CUSTOM_VALUE (2), CUSTOM_ERROR (3).
error_handler_params string エラーハンドラーのパラメーター。

あわせて参照: Item preprocessing object (対応する名前の関連プロパティを参照してください)。

ホストアイテムのトリガー
zabbix_export:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      items:
        (...)
        - name: Uptime
          (...)
          triggers:
            - expression: 'nodata(/MySQL server/mysql.uptime,30m)=1'
              name: 'MySQL: 情報データの取得に失敗しました'
              event_name: 'MySQL: 情報データの取得に失敗しました (または30分間データなし)'
              priority: INFO
              description: 'Zabbix は過去30分間、アイテムのデータを受信していません。'
              dependencies:
                - name: 'MySQL: サービスが停止しています'
                  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: サービスが再起動されました'
              event_name: 'MySQL: サービスが再起動されました (稼働時間 < 10分)'
              priority: INFO
              description: 'MySQL の稼働時間は10分未満です。'
              tags:
                - tag: scope
                  value: notice
        (...)
Element Type Description
uuid string (必須) このトリガーの一意の識別子。
expression string (必須) トリガーの式。
recovery_mode string OKイベントを生成する基準。
可能な値:1 EXPRESSION (0, default), RECOVERY_EXPRESSION (1), NONE (2).
recovery_expression string トリガーの復旧式。
correlation_mode string 相関モード(イベント相関なし、またはタグによるイベント相関)。
可能な値:1 DISABLED (0, default), 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, default), DISABLED (1).
priority string トリガーの深刻度。
可能な値:1 NOT_CLASSIFIED (0, default), INFO (1), WARNING (2), AVERAGE (3), HIGH (4), DISASTER (5).
description text トリガーの説明。
type string イベント生成タイプ(単一の障害イベント、または複数の障害イベント)。
可能な値:1 SINGLE (0, default), MULTIPLE (1).
manual_close string 障害イベントの手動クローズ。
可能な値:1 NO (0, default), 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: '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: 'データベースサイズ。'
              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, default), 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
          (...)
Element Type Description
evaltype string フィルター条件の評価方法を上書きします。
使用可能な値:1 AND_OR (0, default), AND (1), OR (2), FORMULA (3).
formula string フィルター条件のカスタム計算式。
conditions フィルター条件のルート要素。
macro string (required) チェック対象となる低レベルディスカバリマクロの名前。
value string 比較する値。
operator string 条件演算子。
使用可能な値:1 MATCHES_REGEX (8, default), NOT_MATCHES_REGEX (9).
formulaid string (required) カスタム式から条件を参照するために使用される、任意の一意なID。大文字の英字のみを含めることができます。フィルター条件を変更する際にはユーザーがこのIDを指定する必要がありますが、その後に取得する際には新たに生成されます。

あわせて参照: LLD rule filter object (対応する名前のプロパティを参照してください)。

ホストの低レベルディスカバリルールのオーバーライド操作
Element Type Description
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 Description
uuid string (required) このWebシナリオの一意の識別子。
name string (required) Webシナリオ名。
delay string Webシナリオを実行する頻度(秒、time suffix、またはuser macroを使用)。
Default: 1m.
attempts integer Webシナリオのステップを実行する試行回数。
Possible values: 1-10 (default: 1).
agent string クライアントエージェント。Zabbix は選択したブラウザになりすまします。
これは、Webサイトがブラウザごとに異なるコンテンツを返す場合に便利です。
Default: Zabbix.
http_proxy string Webシナリオで使用するプロキシ。形式: http://[username[:password]@]proxy.example.com[:port]
variables Webシナリオのステップで使用できる変数のルート要素。
name string (required) 変数名。
value text (required) 変数値。
headers リクエスト実行時に送信する HTTP ヘッダーのルート要素。
ヘッダーは HTTP プロトコルに表示されるのと同じ構文で列挙してください。
name string (required) ヘッダー名。
value text (required) ヘッダー値。
status string Webシナリオの状態。
Possible values:1 ENABLED (0, default), DISABLED (1).
authentication string 認証方式。
Possible values:1 NONE (0, default), BASIC (1), NTLM (2), Kerberos (3), or Digest (4).
http_user string BASIC (HTTP)、NTLM、Kerberos、または Digest 認証で使用するユーザー名。
http_password string BASIC (HTTP)、NTLM、Kerberos、または Digest 認証で使用するパスワード。
verify_peer string Webサーバーの SSL 証明書を検証します。
Possible values:1 NO (0, default), YES (1).
verify_host string Webサーバー証明書の Common Name フィールドまたは Subject Alternate Name フィールドが一致することを検証します。
Possible values:1 NO (0, default), YES (1).
ssl_cert_file string クライアント認証に使用する SSL 証明書ファイル名(PEM 形式である必要があります)。
ssl_key_file string クライアント認証に使用する SSL 秘密鍵ファイル名(PEM 形式である必要があります)。
ssl_key_password string SSL 秘密鍵ファイルのパスワード。
steps (required) ホストのWebシナリオステップ のルート要素。
tags Webシナリオタグのルート要素。
tag string (required) タグ名。
value string タグ値。

See also: Web scenario object (refer to the relevant property with a matching name).

ホストのWebシナリオステップ
Element Type Description
name string (必須) Webシナリオステップ名。
url string (必須) 監視対象のURL。
query_fields クエリパラメータのルート要素(リクエスト実行時にURLへ追加されるHTTPフィールドの配列)。
name string (必須) クエリパラメータ名。
value string クエリパラメータ値。
posts HTTP POST変数のルート要素(文字列(raw post data)または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: (see table below)
    (...)
Element Type Description
uuid string グラフの一意の識別子。
name string (必須) グラフ名。
width integer グラフの幅(ピクセル単位)。
プレビューおよび円グラフ/分割円グラフで使用されます。
指定可能な値:1 20-65535 (default: 900).
height integer グラフの高さ(ピクセル単位)。
プレビューおよび円グラフ/分割円グラフで使用されます。
指定可能な値:1 20-65535 (default: 900).
yaxismin double Y軸の最小値。
Y軸の FIXED 最小値でサポートされます。
デフォルト: 0。
yaxismax double Y軸の最大値。
X軸の FIXED 最小値でサポートされます。
デフォルト: 0。
show_work_period string 非稼働時間を強調表示します。
NORMAL および STACKED グラフでサポートされます。
指定可能な値:1 NO (0), YES (1, default).
show_triggers string 単純なトリガー値を線として表示します。
NORMAL および STACKED グラフでサポートされます。
指定可能な値:1 NO (0), YES (1, default).
type string グラフの種類。
指定可能な値:1 NORMAL (0, default), STACKED (1), PIE (2), EXPLODED (3).
show_legend string グラフの凡例を表示します。
指定可能な値:1 NO (0), YES (1, default).
show_3d string 3D スタイルを有効にします。
NORMAL および STACKED グラフでサポートされます。
指定可能な値:1 NO (0, default), YES (1).
percent_left double 左軸のパーセンタイル線を表示します。
NORMAL グラフでサポートされます。
デフォルト: 0。
percent_right double 右軸のパーセンタイル線を表示します。
NORMAL グラフでサポートされます。
デフォルト: 0。
ymin_type_1 string Y軸の最小値。
NORMAL および STACKED グラフでサポートされます。
指定可能な値:1 CALCULATED (0, default), FIXED (1), ITEM (2).
ymin_item_1 (ymin_type_1ITEM に設定されている場合に必須) 個別アイテムの詳細のルート要素。
host string (必須) アイテムのホスト。
key string (必須) アイテムキー。
ymax_type_1 string Y軸の最大値。
NORMAL および STACKED グラフでサポートされます。
指定可能な値:1 CALCULATED (0, default), 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
    (...)
Element Type Description
sortorder integer 描画順序。値が小さいものから先に描画されます。線や領域を他の線や領域の背後に、または前面に描画するために使用できます。
drawtype string グラフアイテムの描画スタイル。
NORMALグラフでサポートされます。
指定可能な値:1 SINGLE_LINE (0, default), FILLED_REGION (1), BOLD_LINE (2), DOTTED_LINE (3), DASHED_LINE (4), GRADIENT_LINE (5).
color string 要素の色(6文字の16進数)。
yaxisside string グラフアイテムのY軸スケールを描画するグラフの側。
NORMALおよびSTACKEDグラフでサポートされます。
指定可能な値:1 LEFT (0, default), RIGHT (1).
calc_fnc string アイテムに複数の値が存在する場合に描画するデータ。
指定可能な値:1 MIN (1), AVG (2, default), MAX (4), ALL (7; 最小値、平均値、最大値。simple graphsでサポート), LAST (9, pie/exploded graphsでサポート).
type string グラフアイテムのタイプ。
指定可能な値:1 SIMPLE (0, default), GRAPH_SUM (2; アイテムの値が円グラフ全体を表す。pie/exploded graphsでサポート).
item (必須) 個別のアイテム。
host string (必須) アイテムのホスト。
key string (必須) アイテムのキー。

こちらも参照: Graph item object(該当する名前のプロパティを参照してください)。

ホストの値マップ

zabbix_export:
  (...)
  hosts:
    - host: 'MySQL server'
      (...)
      valuemaps:
        - name: Example value map
          mappings:
            - value: '1'
              newvalue: Example value
  (...)
Element Type Description
uuid string (required) この値マップの一意な識別子。
name string (required) 値マップ名。
mapping マッピングのルート要素。
type string マッピングの一致タイプ。
Possible values:1 EQUAL (0, default), GREATER_OR_EQUAL (2), LESS_OR_EQUAL (3), IN_RANGE (4), REGEXP (5), DEFAULT (6).
value string 元の値。
newvalue string (required) 元の値がマッピングされる先の値。

See also: Value map object (refer to the relevant property with a matching name).

脚注

1 角括弧内の API の整数値、たとえば ENABLED (0) は、参考情報としてのみ記載されています。 詳細については、表の項目内にあるリンク先の API オブジェクトページ、または各セクションの末尾を参照してください。