community.zabbix.zabbix_itemprototype 模块 – 创建/删除 Zabbix 项目原型

注意

此模块是 community.zabbix 集合 (版本 3.2.0) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.zabbix。您需要其他要求才能使用此模块，请参阅 需求 以了解详情。

要在 playbook 中使用它，请指定： community.zabbix.zabbix_itemprototype。

概要

  • 如果项目原型不存在，则创建它们。

  • 如果项目原型存在，则删除它们。

需求

在执行此模块的主机上需要以下要求。

  • python >= 2.6

参数

参数

注释

discoveryrule_name

字符串 / 必需

项目所属的 LLD 规则的名称。

host_name

字符串

要向其添加项目原型的宿主机名称。

当不使用 *template_name* 时必需。

与 *template_name* 互斥。

http_login_password

字符串

基本认证密码

http_login_user

字符串

基本认证用户名

name

字符串 / 必需

要创建或删除的项目原型的名称。

params

字典

用于创建/更新项目原型的参数。

如果 state 为“present”，则必需。

参数定义在 https://www.zabbix.com/documentation/current/en/manual/api/reference/itemprototype/object

另外支持的参数如下

enabled

布尔值

项目原型的状态。

覆盖 API 文档中的“status”

选项

  • false

  • true

interval

字符串

项目原型的更新间隔。

API 文档中“delay”的别名

key

字符串

项目原型键。

API 文档中“key_”的别名

master_item

字典

作为当前项目主项目的项目

覆盖 API 文档中的“master_itemid”

discovery_rule

字符串 / 必需

主项目所属的发现规则的名称

host_name

字符串

主项目所属的宿主机名称

当不使用 *template_name* 时必需。

与 *template_name* 互斥。

item_name

字符串 / 必需

主项目的名称

template_name

字符串

主项目所属的模板名称。

当不使用 *host_name* 时必需。

与 *host_name* 互斥。

preprocessing

列表 / 元素=字典

项目预处理选项。

参数定义在

https://www.zabbix.com/documentation/current/en/manual/api/reference/itemprototype/object#item-prototype-preprocessing

另外支持的参数如下

error_handler

字符串

预处理步骤失败时使用的操作类型。

选项

  • "zabbix_server"

  • "discard"

  • "set_custom_value"

  • "set_custom_error_message"

type

字符串 / 必需

预处理选项类型。

选项

  • "custom_multiplier"

  • "right_trim"

  • "left_trim"

  • "trim"

  • "regular_expressions"

  • "regex"

  • "boolean_to_decimal"

  • "octal_to_decimal"

  • "hexadecimal_to_decimal"

  • "simple_change"

  • "change_per_second"

  • "xml_xpath"

  • "jsonpath"

  • "in_range"

  • "matches_regular_expression"

  • "matches_regex"

  • "does_not_match_regular_expression"

  • "not_match_regex"

  • "check_for_error_in_json"

  • "check_for_json_error"

  • "check_for_error_in_xml"

  • "check_for_xml_error"

  • "check_for_error_using_regular_expression"

  • "check_for_error_regex"

  • "discard_unchanged"

  • "discard_unchanged_with_heartbeat"

  • "javascript"

  • "prometheus_pattern"

  • "prometheus_to_json"

  • "csv_to_json"

  • "replace"

  • "check_unsupported"

  • "xml_to_json"

  • "snmp_walk_value"

  • "snmp_walk_to_json"

status

字符串

项目原型的状态。

选项

  • "enabled"

  • "disabled"

type

字符串

项目原型的类型。

如果 state 为“present”，则必需。

选项

  • "zabbix_agent"

  • "zabbix_trapper"

  • "simple_check"

  • "zabbix_internal"

  • "zabbix_agent_active"

  • "web_item"

  • "external_check"

  • "database_monitor"

  • "ipmi_agent"

  • "ssh_agent"

  • "telnet_agent"

  • "calculated"

  • "jmx_agent"

  • "snmp_trap"

  • "dependent_item"

  • "http_agent"

  • "snmp_agent"

  • "script"

value_type

字符串

项目原型的信息类型。

如果 state 为“present”，则必需。

选项

  • "numeric_float"

  • "character"

  • "log"

  • "numeric_unsigned"

  • "text"

state

字符串

创建或删除项目原型。

选项

  • "present" ← (默认)

  • "absent"

template_name

字符串

要向其添加项目原型的模板名称。

当不使用 *host_name* 时必需。

与 *host_name* 互斥。

示例

# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
  ansible.builtin.set_fact:
    ansible_user: Admin
    ansible_httpapi_pass: zabbix

# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
  ansible.builtin.set_fact:
    ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895

# Create item prototype on example_host using example_rule
- name: create item prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    host_name: example_host
    params:
      type: zabbix_agent
      key: "{% raw %}vfs.fs.size[{#FSNAME},used]{% endraw %}"
      value_type: numeric_unsigned
      interval: 1m
    state: present

# Create item prototype on example_template using example_rule
- name: create item prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    template_name: example_template
    params:
      type: zabbix_agent
      key: "{% raw %}vfs.fs.size[{#FSNAME},used]{% endraw %}"
      value_type: numeric_unsigned
      interval: 1m
    state: present


# Add tags to the existing Zabbix item prototype
- name: update item prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    template_name: example_template
    params:
      type: zabbix_agent
      key: "{% raw %}vfs.fs.size[{#FSNAME},used]{% endraw %}"
      value_type: numeric_unsigned
      interval: 1m
      tags:
          - tag: class
            value: application
    state: present

- name: create dependent item
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:example_depend_item_prototype{% endraw %}'
    discoveryrule_name: example_rule
    host_name: example_host
    params:
        type: dependent_item
        key: '{% raw %}vfs.fs.size.half[{#FSNAME}]{% endraw %}'
        value_type: numeric_float
        units: B
        master_item:
          item_name: '{% raw %}{#FSNAME}:example_item_prototype{% endraw %}'
          discoveryrule_name: example_rule
          host_name: example_host
        preprocessing:
          - type: javascript
            params: 'return value / 2;'
            error_handler: zabbix_server
    state: present

- name: Delete Zabbix item prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    template_name: example_template
    state: absent

作者

  • Andrew Lathrop (@aplathrop)