community.zabbix.zabbix_template_info module – Gather information about Zabbix template

Note

This module is part of the community.zabbix collection (version 1.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.zabbix. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.zabbix.zabbix_template_info.

Synopsis

  • This module allows you to search for Zabbix template.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • zabbix-api >= 0.5.4

Parameters

Parameter

Comments

format

string

Format to use when dumping template.

yaml works only with Zabbix >= 5.2.

Choices:

  • "json" ← (default)

  • "xml"

  • "yaml"

  • "none"

http_login_password

string

Basic Auth password

http_login_user

string

Basic Auth login

login_password

string / required

Zabbix user password.

If not set the environment variable ZABBIX_PASSWORD will be used.

login_user

string / required

Zabbix user name.

If not set the environment variable ZABBIX_USERNAME will be used.

omit_date

boolean

Removes the date field for the dumped template

Choices:

  • false ← (default)

  • true

server_url

aliases: url

string / required

URL of Zabbix server, with protocol (http or https). url is an alias for server_url.

If not set the environment variable ZABBIX_SERVER will be used.

template_name

string / required

Name of the template in Zabbix.

timeout

integer

The timeout of API request (seconds).

Default: 10

validate_certs

boolean

If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

If not set the environment variable ZABBIX_VALIDATE_CERTS will be used.

Choices:

  • false

  • true ← (default)

Notes

Note

  • there where breaking changes in the Zabbix API with version 5.4 onwards (especially UUIDs) which may require you to export the templates again (see version tag >= 5.4 in the resulting file/data).

  • If you use login_password=zabbix, the word “zabbix” is replaced by “********” in all module output, because login_password uses no_log. See this FAQ for more information.

Examples

- name: Get Zabbix template as JSON
  community.zabbix.zabbix_template_info:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    template_name: Template
    format: json
    omit_date: yes
  register: template_json

- name: Get Zabbix template as XML
  community.zabbix.zabbix_template_info:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    template_name: Template
    format: xml
    omit_date: no
  register: template_json

- name: Get Zabbix template as YAML
  community.zabbix.zabbix_template_info:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    template_name: Template
    format: yaml
    omit_date: no
  register: template_yaml

- name: Determine if Zabbix template exists
  community.zabbix.zabbix_template_info:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    template_name: Template
    format: none
  register: template

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

template_id

string

The ID of the template

Returned: always

template_json

string

The JSON of the template

Returned: when format is json and omit_date is true

Sample: "{'zabbix_export': {'groups': [{'name': 'Templates'}], 'templates': [{'applications': [{'name': 'Test Application'}], 'description': 'Testing template import', 'discovery_rules': [], 'groups': [{'name': 'Templates'}], 'httptests': [], 'items': [], 'macros': [], 'name': 'Template for Testing', 'screens': [], 'template': 'Test Template', 'templates': []}], 'version': '4.0'}}"

template_xml

string

The XML of the template

Returned: when format is xml and omit_date is false

Sample: "<zabbix_export>\n    <version>4.0</version>\n    <date>2019-10-27T14:49:57Z</date>\n    <groups>\n        <group>\n            <name>Templates</name>\n        </group>\n    </groups>\n    <templates>\n        <template>\n            <template>Test Template</template>\n            <name>Template for Testing</name>\n            <description>Testing template import</description>\n            <groups>\n                <group>\n                    <name>Templates</name>\n                </group>\n            </groups>\n            <applications>\n                <application>\n                    <name>Test Application</name>\n                </application>\n            </applications>\n            <items />\n            <discovery_rules />\n            <httptests />\n            <macros />\n            <templates />\n            <screens />\n        </template>\n    </templates>\n</zabbix_export>"

template_yaml

string

The YAML of the template

Returned: when format is yaml and omit_date is false

Sample: "zabbix_export:\n  version: '6.0'\n  date: '2022-07-09T13:25:18Z'\n  groups:\n    -\n      uuid: 7df96b18c230490a9a0a9e2307226338\n      name: Templates\n  templates:\n    -\n      uuid: 88a9ad240f924f669eb7d4eed736320c\n      template: 'Test Template'\n      name: 'Template for Testing'\n      description: 'Testing template import'\n      groups:\n        -\n          name: Templates"

Authors

  • sky-joker (@sky-joker)