Модуль community.zabbix.zabbix_itemprototype — создание/удаление прототипов элементов Zabbix

Примечание

Этот модуль входит в коллекцию community.zabbix (версия 4.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.zabbix. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.zabbix.zabbix_itemprototype.

Краткое описание
Требования
Параметры
Примеры

Краткое описание

Создание прототипов элементов, если они не существуют.
Удаление существующих прототипов элементов, если они существуют.

Требования

На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

python >= 2.6

Параметры

Параметр	Комментарии
discoveryrule_name string / обязательный	Имя правила низкоуровневого обнаружения (LLD), к которому относится элемент.
host_name string	Имя узла, в который нужно добавить прототип элемента. Обязателен, если не используется template_name. Не может использоваться одновременно с template_name.
http_login_password string	Пароль для базовой аутентификации
http_login_user string	Имя пользователя для базовой аутентификации
name string / обязательный	Имя прототипа элемента для создания или удаления.
params dictionary	Параметры для создания/обновления прототипа элемента. Обязателен, если state имеет значение «present». Параметры, определённые в https://www.zabbix.com/documentation/current/en/manual/api/reference/itemprototype/object Кроме того, поддерживаются следующие параметры
enabled boolean	Состояние прототипа элемента. Переопределяет параметр «status» в документации API Варианты: `false` `true`
interval string	Интервал обновления прототипа элемента. Синоним параметра «delay» в документации API
key string	Ключ прототипа элемента. Синоним параметра «key_» в документации API
master_item dictionary	Элемент, являющийся главным для текущего элемента Переопределяет параметр «master_itemid» в документации API
discovery_rule string / обязательный	Имя правила обнаружения, к которому относится главный элемент
host_name string	Имя узла, к которому относится главный элемент Обязателен, если не используется template_name. Не может использоваться одновременно с template_name.
item_name string / обязательный	Имя главного элемента
template_name string	Имя шаблона, к которому относится главный элемент Обязателен, если не используется host_name. Не может использоваться одновременно с host_name.
new_name string	Новое имя элемента
preprocessing list / элементы типа dictionary	Параметры предварительной обработки элемента. Параметры, определённые в https://www.zabbix.com/documentation/current/en/manual/api/reference/itemprototype/object#item-prototype-preprocessing Кроме того, поддерживаются следующие параметры
error_handler string	Тип действия в случае сбоя шага предварительной обработки. Варианты: `"zabbix_server"` `"discard"` `"set_custom_value"` `"set_custom_error_message"`
type string / обязательный	Тип параметра предварительной обработки. Варианты: `"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 string	Состояние прототипа элемента. Варианты: `"enabled"` `"disabled"`
type string	Тип прототипа элемента. Обязателен, если 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 string	Тип данных прототипа элемента. Обязателен, если state имеет значение «present». Варианты: `"numeric_float"` `"character"` `"log"` `"numeric_unsigned"` `"text"`
state string	Создать или удалить прототип элемента. Варианты: `"present"` ← (по умолчанию) `"absent"`
template_name string	Имя шаблона, в который нужно добавить прототип элемента. Обязателен, если не используется 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
      status: enabled
    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
      status: enabled
    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
      status: enabled
      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
        status: enabled
        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

- name: Rename 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
    params:
      new_name: '{% raw %}{#FSNAME}:New Used space{% endraw %}'
    state: present

Авторы

Andrew Lathrop (@aplathrop)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/zabbix/zabbix_itemprototype_module.html