community.zabbix.zabbix_globalmacro – Create/update/delete Zabbix Global macros

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_globalmacro.

New in version 1.4.0: of community.zabbix

Synopsis

  • manages Zabbix Global macros, it can create, update or delete them.

  • For macro_type Secret the value field cannot be validated and will always be overwritten due to the secret nature of the Text.

Requirements

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

  • python >= 2.6

  • zabbix-api >= 0.5.4

Parameters

Parameter

Comments

force

boolean

Only updates an existing macro if set to yes.

Choices:

  • no

  • yes ← (default)

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.

macro_description

string

Text Description of the global macro.

Works only with Zabbix >= 4.4 and is silently ignored in lower versions

macro_name

string / required

Name of the global macro in zabbix native format {$MACRO} or simple format MACRO.

macro_type

string

Type of the global macro Text or Secret Text.

Required if state=present.

text

secret - Secret Text Works only with Zabbix >= 5.0 and will default to Text in lower versions

vault - Vault Secret Works only with Zabbix >= 5.2 and will default to Text in lower versions

Choices:

  • text ← (default)

  • secret

  • vault

macro_value

string

Value of the global macro.

Required if state=present.

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.

state

string

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.

Choices:

  • present ← (default)

  • absent

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:

  • no

  • yes ← (default)

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: Create new global macro or update an existing macro's value
  local_action:
    module: community.zabbix.zabbix_globalmacro
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    macro_name: EXAMPLE.MACRO
    macro_value: Example value
    macro_type: 0
    macro_description: Example description
    state: present
# Values with curly brackets need to be quoted otherwise they will be interpreted as a dictionary
- name: Create new global macro in Zabbix native format with Secret Type
  local_action:
    module: community.zabbix.zabbix_globalmacro
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    macro_name: "{$EXAMPLE.MACRO}"
    macro_value: Example value
    macro_type: 1
    macro_description: Example description
    state: present
- name: Delete existing global macro
  local_action:
    module: community.zabbix.zabbix_globalmacro
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    macro_name: "{$EXAMPLE.MACRO}"
    state: absent

Authors

  • Cove (@cove)

  • Dean Hailin Song (!UNKNOWN)

  • Timothy Test (@ttestscripting)