Модуль community.zabbix.zabbix_globalmacro – Создание/обновление/удаление глобальных макросов Zabbix

Примечание

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

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

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

Для использования в playbook, укажите: community.zabbix.zabbix_globalmacro.

Новое в community.zabbix 1.4.0

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

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

управляет глобальными макросами Zabbix, может создавать, обновлять или удалять их.
Для macro_type Secret поле value не может быть проверено и всегда будет перезаписано из-за секретного характера текста.

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
force boolean	Обновляет существующий макрос только если установлено в `yes`. Варианты: `false` `true` ← (по умолчанию)
http_login_password string	Пароль Basic Auth
http_login_user string	Логин Basic Auth
macro_description string	Текстовое описание глобального макроса. По умолчанию: `""`
macro_name string / обязательно	Имя глобального макроса в собственном формате Zabbix `{$MACRO}` или простом формате `MACRO`.
macro_type string	Тип глобального макроса: Text или Secret Text. Обязательно, если state=present. text secret - Secret Text Работает только с Zabbix >= 5.0 и будет по умолчанию Text в более низких версиях vault - Vault Secret Работает только с Zabbix >= 5.2 и будет по умолчанию Text в более низких версиях Варианты: `"text"` ← (по умолчанию) `"secret"` `"vault"`
macro_value string	Значение глобального макроса. Обязательно, если state=present.
state string	Состояние макроса. При `present`, он создаст, если макрос не существует, или обновит макрос, если связанные данные отличаются. При `absent` удалит макрос, если он существует. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Этот модуль возвращает changed=true, когда macro_type=secret.

Примеры

# 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 global 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_globalmacro:
    macro_name: EXAMPLE.MACRO
    macro_value: Example value
    macro_type: 0
    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 global macro in Zabbix native format with Secret Type
  # 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_globalmacro:
    macro_name: "{$EXAMPLE.MACRO}"
    macro_value: Example value
    macro_type: 1
    macro_description: Example description
    state: present
- name: Delete existing global macro
  community.zabbix.zabbix_globalmacro:
    macro_name: "{$EXAMPLE.MACRO}"
    state: absent

Авторы

Cove (@cove)
Dean Hailin Song
Timothy Test (@ttestscripting)

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

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