Модуль community.zabbix.zabbix_itemprototype — Создание/удаление шаблонов элементов Zabbix

Примечание

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

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

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

Для использования в книге задач укажите: community.zabbix.zabbix_itemprototype.

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

Описание

Создаёт шаблоны элементов, если они не существуют.
Удаляет существующие шаблоны элементов, если они есть.

Требования

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

python >= 2.6

Параметры

Параметр	Комментарии
discoveryrule_name строка / обязательно	Имя правила LLD, к которому принадлежит элемент.
host_name строка	Имя хоста, к которому нужно добавить шаблон элемента. Требуется, когда не используется template_name. Взаимоисключающее с template_name.
http_login_password строка	Пароль аутентификации Basic Auth
http_login_user строка	Логин аутентификации Basic Auth
name строка / обязательно	Имя шаблона элемента для создания или удаления.
params словарь	Параметры для создания/обновления шаблона элемента. Требуется, если состояние “present”. Параметры, как определено в https://www.zabbix.com/documentation/current/en/manual/api/reference/itemprototype/object Дополнительно поддерживаются параметры ниже
enabled логическое	Статус шаблона элемента. Переопределяет “status” в документации API Варианты: `false` `true`
interval строка	Интервал обновления шаблона элемента. Псевдоним для “delay” в документации API
key строка	Ключ шаблона элемента. Псевдоним для “key_” в документации API
master_item словарь	элемент, являющийся основным для текущего Переопределяет “master_itemid” в документации API
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"`

тип строка	Тип прототипа элемента. Требуется, если состояние «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 строка	Тип информации прототипа элемента. Требуется, если состояние «present». Варианты: `"numeric_float"` `"character"` `"log"` `"numeric_unsigned"` `"text"`
состояние строка	Создать или удалить прототип элемента. Варианты: `"present"` ← (по умолчанию) `"absent"`
имя_шаблона строка	Имя шаблона, к которому нужно добавить прототип элемента. Требуется, когда имя_хоста не используется. Взаимоисключающее с имя_хоста.

Примеры

# 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)

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

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