community.zabbix.zabbix_template_info – Gather information about Zabbix template
Note
This plugin is part of the community.zabbix collection (version 1.5.1).
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
.
To use it in a playbook, specify: community.zabbix.zabbix_template_info
.
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 to use when dumping template. Choices:
|
|
Basic Auth password |
|
Basic Auth login |
|
Zabbix user password. If not set the environment variable |
|
Zabbix user name. If not set the environment variable |
|
Removes the date field for the dumped template Choices:
|
|
URL of Zabbix server, with protocol (http or https). If not set the environment variable |
|
Name of the template in Zabbix. |
|
The timeout of API request (seconds). Default: 10 |
|
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 Choices:
|
Notes
Note
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
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”}} |
|
The XML of the template Returned: when format is xml and omit_date is false Sample: “\u003czabbix_export\u003e\n \u003cversion\u003e4.0\u003c/version\u003e\n \u003cdate\u003e2019-10-27T14:49:57Z\u003c/date\u003e\n \u003cgroups\u003e\n \u003cgroup\u003e\n \u003cname\u003eTemplates\u003c/name\u003e\n \u003c/group\u003e\n \u003c/groups\u003e\n \u003ctemplates\u003e\n \u003ctemplate\u003e\n \u003ctemplate\u003eTest Template\u003c/template\u003e\n \u003cname\u003eTemplate for Testing\u003c/name\u003e\n \u003cdescription\u003eTesting template import\u003c/description\u003e\n \u003cgroups\u003e\n \u003cgroup\u003e\n \u003cname\u003eTemplates\u003c/name\u003e\n \u003c/group\u003e\n \u003c/groups\u003e\n \u003capplications\u003e\n \u003capplication\u003e\n \u003cname\u003eTest Application\u003c/name\u003e\n \u003c/application\u003e\n \u003c/applications\u003e\n \u003citems /\u003e\n \u003cdiscovery_rules /\u003e\n \u003chttptests /\u003e\n \u003cmacros /\u003e\n \u003ctemplates /\u003e\n \u003cscreens /\u003e\n \u003c/template\u003e\n \u003c/templates\u003e\n\u003c/zabbix_export\u003e” |
Authors
sky-joker (@sky-joker)