community.zabbix.zabbix_template module – Create/update/delete/dump Zabbix template
Note
This module is part of the community.zabbix collection (version 1.9.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.
Synopsis
This module allows you to create, modify, delete and dump Zabbix templates.
Multiple templates can be created or modified at once if passing JSON or XML to module.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
|---|---|
List of template names to be unlinked and cleared from the template. This option is ignored if template is being created for the first time. |
|
Format to use when dumping template with This option is deprecated and will eventually be removed in 2.14. Choices:
|
|
List of template names to be linked to the template. Templates that are not specified and are linked to the existing template will be only unlinked and not cleared from the template. |
|
Zabbix user password. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Zabbix user name. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
List of user macros to create for the template. Macros that are not specified and are present on the existing template will be replaced. See examples on how to pass macros. |
|
Name of the macro. Must be specified in {$NAME} format. |
|
Value of the macro. |
|
Removes the date field for the exported/dumped template Requires Choices:
|
|
URL of Zabbix server, with protocol (http or https). If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Required state of the template. On On On The Choices:
|
|
List of tags to assign to the template. Works only with >= Zabbix 4.2. Providing tags=[] with force=yes will clean all of the tags from the template. |
|
Name of the template tag. |
|
Value of the template tag. Default: |
|
List of template groups to add template to when template is created. Replaces the current template groups the template belongs to if the template is already present. Required when creating a new template with |
|
JSON dump of templates to import. Multiple templates can be imported this way. Mutually exclusive with template_name and template_xml. |
|
Name of Zabbix template. Required when template_json or template_xml are not used. Mutually exclusive with template_json and template_xml. |
|
XML dump of templates to import. Multiple templates can be imported this way. You are advised to pass XML structure matching the structure used by your version of Zabbix server. Custom XML structure can be imported as long as it is valid, but may not yield consistent idempotent results on subsequent runs. Mutually exclusive with template_name and template_json. |
|
The timeout of API request (seconds). This option is deprecated with the move to httpapi connection and will be removed in the next release Default: |
|
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 This option is deprecated with the move to httpapi connection and will be removed in the next release Choices:
|
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
---
# Set following variables for Zabbix Server host in play or inventory
- name: Set connection specific variables
set_fact:
ansible_network_os: community.zabbix.zabbix
ansible_connection: httpapi
ansible_httpapi_port: 80
ansible_httpapi_use_ssl: false
ansible_httpapi_validate_certs: false
ansible_zabbix_url_path: 'zabbixeu' # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
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
set_fact:
ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895
- name: Create a new Zabbix template linked to groups, macros and templates
community.zabbix.zabbix_template:
template_name: ExampleHost
template_groups:
- Role
- Role2
link_templates:
- Example template1
- Example template2
macros:
- macro: '{$EXAMPLE_MACRO1}'
value: 30000
- macro: '{$EXAMPLE_MACRO2}'
value: 3
- macro: '{$EXAMPLE_MACRO3}'
value: 'Example'
state: present
- name: Unlink and clear templates from the existing Zabbix template
community.zabbix.zabbix_template:
template_name: ExampleHost
clear_templates:
- Example template3
- Example template4
state: present
- name: Import Zabbix templates from JSON
community.zabbix.zabbix_template:
template_json: "{{ lookup('file', 'zabbix_apache2.json') }}"
state: present
- name: Import Zabbix templates from XML
community.zabbix.zabbix_template:
template_xml: "{{ lookup('file', 'zabbix_apache2.xml') }}"
state: present
- name: Import Zabbix template from Ansible dict variable
community.zabbix.zabbix_template:
template_json:
zabbix_export:
version: '3.2'
templates:
- name: Template for Testing
description: 'Testing template import'
template: Test Template
groups:
- name: Templates
applications:
- name: Test Application
state: present
- name: Configure macros on the existing Zabbix template
community.zabbix.zabbix_template:
template_name: Template
macros:
- macro: '{$TEST_MACRO}'
value: 'Example'
state: present
- name: Add tags to the existing Zabbix template
community.zabbix.zabbix_template:
template_name: Template
tags:
- tag: class
value: application
state: present
- name: Delete Zabbix template
community.zabbix.zabbix_template:
template_name: Template
state: absent
- name: Dump Zabbix template as JSON
community.zabbix.zabbix_template:
template_name: Template
omit_date: yes
state: dump
register: template_dump
- name: Dump Zabbix template as XML
community.zabbix.zabbix_template:
template_name: Template
dump_format: xml
omit_date: false
state: dump
register: template_dump
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The JSON dump of the template Returned: when state is dump and omit_date is no Sample: |
|
dump of the template in XML representation Returned: when state is dump, dump_format is xml and omit_date is yes Sample: |