Модуль community.zabbix.zabbix_hostmacro — создание, обновление и удаление макросов узлов Zabbix

Примечание

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

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

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

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

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

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

управляет макросами узлов Zabbix: создает, обновляет и удаляет их.

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
force логическое значение	Обновляет существующий макрос, только если задано значение `yes`. Возможные значения: `false` `true` ← (значение по умолчанию)
host_name строка / обязательный параметр	Имя узла.
http_login_password строка	Пароль для базовой аутентификации
http_login_user строка	Имя пользователя для базовой аутентификации
macro_description строка	Текстовое описание глобального макроса. По умолчанию: `""`
macro_name строка / обязательный параметр	Имя макроса узла в собственном формате Zabbix `{$MACRO}` или простом формате `MACRO`.
macro_type строка	Тип макроса узла. текст (по умолчанию) Возможные значения: `"text"` ← (значение по умолчанию) `"secret"` `"vault"`
macro_value строка	Значение макроса узла. Обязательно, если state=present.
state строка	Состояние макроса. При значении `present` макрос будет создан, если он не существует, или обновлен, если связанные с ним данные отличаются. При значении `absent` макрос будет удален, если он существует. Возможные значения: `"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

- name: Create new host macro or update an existing macro's value
  # 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_hostmacro:
    host_name: ExampleHost
    macro_name: EXAMPLE.MACRO
    macro_value: Example value
    macro_description: Example description
    state: present

# Values with curly brackets need to be quoted otherwise they will be interpreted as a dictionary
- name: Create new host macro in Zabbix native format
  # 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_hostmacro:
    host_name: ExampleHost
    macro_name: "{$EXAMPLE.MACRO}"
    macro_value: Example value
    macro_description: Example description
    state: present

- name: Delete existing host macro
  # 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_hostmacro:
    host_name: ExampleHost
    macro_name: "{$EXAMPLE.MACRO}"
    state: absent

Авторы

Cove (@cove)
Dean Hailin Song

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

© 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_hostmacro_module.html