Модуль community.zabbix.zabbix_template_info — сбор информации о шаблоне Zabbix

Примечание

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

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

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

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

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

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

Этот модуль позволяет искать шаблоны Zabbix.

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
all_templategroups boolean	Возвращать информацию обо всех группах шаблонов. Варианты: `false` `true`
format string	Формат для выгрузки шаблона. Варианты: `"json"` ← (по умолчанию) `"xml"` `"yaml"` `"none"`
http_login_password string	Пароль для базовой аутентификации
http_login_user string	Имя пользователя для базовой аутентификации
omit_date boolean	Удаляет поле даты из выгружаемого шаблона Начиная с Zabbix 6.4 этот параметр игнорируется. Варианты: `false` ← (по умолчанию) `true`
template_name string	Имя шаблона в Zabbix.

Примеры

# 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: Get Zabbix template as JSON
  # 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_template_info:
    template_name: Template
    format: json
    omit_date: yes
  register: template_json

- name: Get Zabbix template as XML
  # 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_template_info:
    template_name: Template
    format: xml
    omit_date: no
  register: template_json

- name: Get Zabbix template as YAML
  # 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_template_info:
    template_name: Template
    format: yaml
    omit_date: no
  register: template_yaml

- name: Determine if Zabbix template exists
  # 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_template_info:
    template_name: Template
    format: none
  register: template

- name: Get info about all templategroups
  # 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_template_info:
    all_templategroups: true
    register: all_templategroups

Возвращаемые значения

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

Ключ	Описание
template_id string	Идентификатор шаблона Возвращается: всегда
template_json string	Представление шаблона в формате JSON Возвращается: если format имеет значение json и omit_date — true Пример: `"{'changed': False, 'failed': False, 'template_id': '10529', 'template_json': {'zabbix_export': {'groups': [{'name': 'Templates', 'uuid': '7df96b18c230490a9a0a9e2307226338'}], 'templates': [{'groups': [{'name': 'Templates'}], 'name': 'ExampleTemplateForTempleteInfoModule', 'template': 'ExampleTemplateForTempleteInfoModule', 'uuid': '615e9b0662bb4399a2503a9aaa743517'}], 'version': '6.0'}}}"`
template_xml string	Представление шаблона в формате XML Возвращается: если format имеет значение xml и omit_date — false Пример: "<zabbix_export>\n <version>6.0</version>\n <groups>\n <group>\n <uuid>7df96b18c230490a9a0a9e2307226338</uuid>\n <name>Templates</name>\n </group>\n </groups>\n <templates>\n <template>\n <uuid>9a83162273f74032a1005fdb13943038</uuid>\n <template>ExampleTemplateForTempleteInfoModule</template>\n <name>ExampleTemplateForTempleteInfoModule</name>\n <groups>\n <group>\n <name>Templates</name>\n </group>\n </groups>\n </template>\n </templates>\n</zabbix_export>"
template_yaml string	Представление шаблона в формате YAML Возвращается: если format имеет значение yaml и omit_date — false Пример: `"zabbix_export:\n version: \"6.0\"\n groups:\n -\n uuid: 7df96b18c230490a9a0a9e2307226338\n name: Templates\n templates:\n -\n uuid: 67b075276bf047d3aeb8f7d5c2121c6a\n template: ExampleTemplateForTempleteInfoModule\n name: ExampleTemplateForTempleteInfoModule\n groups:\n -\n name: Templatesn"`

Авторы

sky-joker (@sky-joker)

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

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