Модуль community.zabbix.zabbix_item — создание/удаление элементов данных Zabbix

Примечание

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

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

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

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

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

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

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

Требования

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

python >= 2.6

Параметры

Параметр	Комментарии
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/item/object Ниже перечислены дополнительные поддерживаемые параметры
enabled boolean	Состояние элемента данных. Переопределяет «status» в документации API Варианты: `false` `true`
interface list / elements=dictionary	настройки интерфейса узла, связанного с элементом данных обязателен, если элемент данных принадлежит узлу и для его типа задано «Zabbix agent», «IPMI agent», «JMX agent», «SNMP trap» или «SNMP agent»
dns string	DNS-имя, используемое интерфейсом Если main равно false, необходимо указать ip или dns
ip string	IP-адрес, используемый интерфейсом Если main равно false, необходимо указать ip или dns
main boolean	Используется ли интерфейс этого типа, заданный для узла по умолчанию Варианты: `false` ← (по умолчанию) `true`
interval string	Интервал обновления элемента данных. Синоним «delay» в документации API
key string	Ключ элемента данных. Синоним «key_» в документации API
master_item dictionary	элемент данных, являющийся родительским для текущего Переопределяет «master_itemid» в документации API
host_name string	имя узла, которому принадлежит родительский элемент данных Обязателен, если не используется template_name. Несовместим с template_name.
item_name string / обязательный	имя родительского элемента данных
template_name string	имя шаблона, которому принадлежит родительский элемент данных Обязателен, если не используется host_name. Несовместим с host_name.
new_name string	Новое имя элемента данных
preprocessing list / elements=dictionary	Параметры предварительной обработки элемента данных. Параметры, определённые по адресу https://www.zabbix.com/documentation/current/en/manual/api/reference/item/object#item-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 ping item on example_host
- name: create ping 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_item:
    name: agent_ping
    host_name: example_host
    params:
        type: zabbix_agent
        key: agent.ping
        value_type: numeric_unsigned
        interval: 1m
        interface:
            main: true
    state: present

# Create ping item on example_template
- name: create ping 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_item:
    name: agent_ping
    template_name: example_template
    params:
        type: zabbix_agent
        key: agent.ping
        value_type: numeric_unsigned
        interval: 1m
    state: present

- name: Add tags to the existing Zabbix 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_item:
    name: agent_ping
    template_name: example_template
    params:
        type: zabbix_agent
        key: agent.ping
        value_type: numeric_unsigned
        interval: 1m
        tags:
          - tag: class
            value: application
    state: present

- name: create a 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_item:
    name: depend_item
    host_name: example_host
    params:
        type: dependent_item
        key: vfs.fs.pused
        value_type: numeric_float
        units: '%'
        master_item:
          item_name: example_item
          host_name: example_host
        preprocessing:
          - type: jsonpath
            params: '$[?(@.fstype == "ext4")]'
            error_handler: zabbix_server
          - type: jsonpath
            params: "$[*].['bytes', 'inodes'].pused.max()"
            error_handler: zabbix_server
    state: present

- name: Delete Zabbix 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_item:
    name: agent_ping
    template_name: example_template
    state: absent

- name: Rename Zabbix 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_item:
    name: agent_ping
    template_name: example_template
    params:
      new_name: new_agent_ping
    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_item_module.html