- Docs »
- zabbix_hostmacro - Zabbix host macro creates/updates/deletes
-
You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.
zabbix_hostmacro - Zabbix host macro creates/updates/deletes
- manages Zabbix host macros, it can create, update or delete them.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
force
bool
(added in 2.5) |
|
Only updates an existing macro if set to yes .
|
host_name
required |
|
Name of the host.
|
http_login_password
(added in 2.1) |
|
Basic Auth password
|
http_login_user
(added in 2.1) |
|
Basic Auth login
|
login_password
required |
|
Zabbix user password.
|
login_user
required |
|
Zabbix user name.
|
macro_name
required |
|
Name of the host macro.
|
macro_value
required |
|
Value of the host macro.
|
server_url
required |
|
URL of Zabbix server, with protocol (http or https). url is an alias for server_url .
aliases: url
|
state
|
Choices:
present ←
- absent
|
State of the macro.
On present , it will create if macro does not exist or update the macro if the associated data is different.
On absent will remove a macro if it exists.
|
timeout
|
Default:
10
|
The timeout of API request (seconds).
|
validate_certs
bool
(added in 2.5) |
|
If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|
- name: Create a new host macro or update an existing macro's value
local_action:
module: zabbix_hostmacro
server_url: http://monitor.example.com
login_user: username
login_password: password
host_name: ExampleHost
macro_name: Example macro
macro_value: Example value
state: present
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.