3 模板

概述

模板会与许多相关对象及对象关系一起被导出

模板导出包含:

  • 已链接的模板组
  • 已链接的主机组(如果在主机原型配置中使用)
  • 模板数据
  • 与其他模板的链接关系
  • 与模板组的链接关系
  • 直接链接的监控项
  • 直接链接的触发器
  • 直接链接的图形
  • 直接链接的仪表板
  • 直接链接的发现规则及其所有原型
  • 直接链接的 web 场景
  • 值映射

导出时

导出模板的步骤如下:

  • 前往: 配置模板
  • 标记要导出的模板的复选框
  • 点击列表下方的Export

根据所选择的格式,模板被导出到一个默认名称的本地文件:

  • 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 模板。

省略号 (...) 表示为简洁起见而省略的元素。 当某个元素会在后续章节中进行更详细说明时,会使用注释 (见下表)

模板元数据

zabbix_export:
  version: '8.0'
  template_groups:
    - uuid: 846977d1dfed4968bc5f8bdb363285bc
      name: 'Templates/Operating systems'
  templates: (见下表)
  triggers: (见下表)
  graphs: (见下表)
Element Type Description
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: '超过此超时时间后,agent 将被视为不可用。仅适用于可从 Zabbix 服务器/proxy 访问的 agent(被动模式)。'
          config: (见下表)
        - macro: '{$CPU.UTIL.CRIT}'
          value: '90'
          description: '以 % 表示的 CPU 利用率严重阈值。'
          config: (见下表)
        (...)
      dashboards: (见下表)
      valuemaps: (见下表)
    (...)
Element Type Description
uuid string (必填)此模板的唯一标识符。
template string (必填)唯一的模板名称。
name string 可见的模板名称。
description text 模板描述。
wizard_ready text 该模板是否可在 Host Wizard 中选择。
可能的值:1 NO (0,默认),YES (1)。
另请参见:Template object (wizard_ready)。
readme text 显示在 Host Wizard 中的模板专用配置说明。支持 Markdown 格式。
vendor 模板供应商的根元素(如果导出的模板包含供应商数据,则存在)。
name string (必填)模板供应商名称。
version string (必填)模板版本。
对于 out-of-the-box templates,版本显示格式如下: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)。
另请参见:User macro object (type)。
value string 用户宏值。
description string 用户宏描述。
config 模板宏配置 的根元素,负责定义该宏在 Host Wizard 中的显示方式。
dashboards 模板仪表板 的根元素。
valuemaps 模板值映射 的根元素。

模板监控项

zabbix_export:
  (...)
  templates:
    (...)
      items:
        - uuid: f94f9f4699e94c369e6c98b2a2f485ce
          name: 'Zabbix agent ping'
          key: agent.ping
          description: 'agent 始终对此监控项返回 "1"。可与 `nodata()` 结合使用以进行可用性检查。'
          valuemap:
            name: 'Zabbix agent 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: (见下表)
        (...)
Element Type Description
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)、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, 默认)、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 提交数据体类型。
支持 HTTP_AGENT 监控项。
可能的值:1 RAW (0, 默认)、JSON (2)、XML (3)。
http_proxy string HTTP(S) proxy 连接字符串。
支持 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
          (...)
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,计算方式:接收值 - 前一个值)、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 错误处理器参数。

另请参见:Item preprocessing object(请参考名称匹配的相关属性)。

模板监控项触发器
zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          triggers:
            - uuid: b950c306394f4b3c902060a8273cbcde
              expression: 'change(/Linux by Zabbix agent/system.sw.packages.get)<>0'
              name: 'Linux:已安装软件包数量已发生变化'
              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:高内存利用率'
              event_name: 'Linux:高内存利用率(>{$MEMORY.UTIL.MAX}% 持续 5m)'
              priority: AVERAGE
              description: '系统可用内存即将耗尽。'
              dependencies:
                - name: 'Linux:可用内存不足'
                  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 时间段(使用秒、时间后缀用户宏),超过该时间后,不再发现的资源将被删除。
默认值: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
          (...)
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 < 字符串 应用操作的对象。
可能的取值:1 ITEM_PROTOTYPE(0),TRIGGER_PROTOTYPE(1),GRAPH_PROTOTYPE(2),HOST_PROTOTYPE(3)。
operator < 字符串 覆盖条件的运算符。
可能的取值:1 EQUAL(1),NOT_EQUAL(2),LIKE(3),NOT_LIKE(4),REGEXP(5),NOT_REGEXP(6)。
value < 字符串 用于覆盖条件运算符的正则表达式或字符串。
status < 字符串 覆盖操作后对象的状态。
discover < 字符串 对象是否作为发现的结果添加。
delay < 字符串 覆盖操作后为监控项原型设置的更新间隔。
history < 字符串 覆盖操作后为监控项原型设置的历史记录存储期限。
trends < 字符串 覆盖操作后为监控项原型设置的趋势存储期限。
severity < 字符串 覆盖操作后设置的触发器原型严重性。
tags < 覆盖操作后为对象设置标签的根元素。
tag 字符串 (必需)标签名称。
^ value 字符串 标签值。
templates < 覆盖操作后与主机原型关联的模板的根元素。
name 字符串 (必需)模板名称。
inventory_mode < 字符串 覆盖操作后设置的主机原型资产模式。

另请参阅:LLD规则覆盖操作对象(参考相关的具有匹配名称的属性)。

模板 Web 场景

Element Type Description
uuid string (必填)此 Web 场景的唯一标识符。
name string (必填)Web 场景名称。
delay string 执行 Web 场景的频率(使用秒、时间后缀用户宏)。
默认值:1m。
attempts integer 执行 Web 场景步骤的尝试次数。
可能的值:1 1-10(默认值:1)。
agent string 客户端 agent。Zabbix 将伪装为所选浏览器。
当网站针对不同浏览器返回不同内容时,这很有用。
默认值:Zabbix。
http_proxy string Web 场景将使用的 proxy,格式为: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 场景对象(请参阅名称匹配的相关属性)。

模板网页场景步骤

元素 < 类型 描述
name < 字符串 (必需)网页场景步骤名称。
url < 字符串 (必需)监控的URL。
query_fields < 查询参数的根元素(执行请求时添加到URL的HTTP字段数组)。
< name 字符串 (必需)查询参数名称。
^ value 字符串 查询参数值。
posts < HTTPPOST变量的根元素(原始POST数据字符串或HTTP字段(表单字段数据)数组)。
< name 字符串 (必需)POST字段名称。
^ value 字符串 (必需)POST字段值。
variables < 此步骤后应用的步骤级别变量(宏)的根元素。
如果变量值以'regex:'前缀开头,则根据后面跟随的正则表达式模式从此步骤返回的数据中提取其值。
< name 字符串 (必需)变量名称。
^ value 文本 (必需)变量值。
headers < 执行请求时发送的HTTP头的根元素。
< name 字符串 (必需)头部名称。
^ value 文本 (必需)头部值。
follow_redirects < 字符串 跟随HTTP重定向。
可能的取值:1 NO(0),YES(1,默认)。
retrieve_mode < 字符串 HTTP响应检索模式。
可能的取值:1 BODY(0,默认),HEADERS(1),BOTH(2)。
timeout < 字符串 步骤执行的超时时间(使用秒数、时间后缀用户宏)。
默认值:15s。
required < 字符串 响应中必须存在的文本(如果为空则忽略)。
status_codes < 字符串 接受的HTTP状态码的逗号分隔列表(例如,200-201,210-299;如果为空则忽略)。

另请参阅:网页场景步骤对象(参考相关的具有匹配名称的属性)。

模板宏配置

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      (...)
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          (...)
          config:
            type: TEXT
            priority: '1'
            label: '自上次检测到 Zabbix agent 以来的秒数'
            description: '超过此超时时间后,agent 将被视为不可用。'
        - 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 宏。

另请参见:宏配置对象(请参考名称匹配的相关属性)。

模板仪表板

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 模板仪表板部件的根元素。

另请参见:Template dashboard object(参阅具有匹配名称的相关属性)。

模板仪表板部件
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
        (...)
元素 类型 描述
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 (必填)原始值映射到的值。

另请参见:值映射对象(请参考具有匹配名称的相关属性)。

附注

1 API中的整数值用方括号标注,例如,ENABLED (0),仅供参考。 有关更多信息,请查看表格条目中的链接API对象页面或每个部分末尾的相关页面。