W3cubDocs

/Ansible

community.zabbix.zabbix_valuemap – Create/update/delete Zabbix value maps

Note

This plugin is part of the community.zabbix collection (version 1.5.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.

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

Synopsis

  • This module allows you to create, modify and delete Zabbix value maps.

Requirements

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

  • zabbix-api >= 0.5.4

Parameters

Parameter Choices/Defaults Comments
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.
mappings
list / elements=dictionary
List of value mappings for the value map.
Required when state=present.
map_to
string / required
Value to which the original value is mapped to.
value
string / required
Original value.
name
string / required
Name of the value map.
server_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.

aliases: url
state
string
    Choices:
  • present ←
  • absent
State of the value map.
On present, it will create a value map if it does not exist or update the value map if the associated data is different.
On absent, it will remove the value map if it exists.
timeout
integer
Default:
10
The timeout of API request (seconds).
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.

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 a value map
  local_action:
    module: community.zabbix.zabbix_valuemap
    server_url: http://zabbix.example.com
    login_user: username
    login_password: password
    name: Numbers
    mappings:
      - value: 1
        map_to: one
      - value: 2
        map_to: two
    state: present

Authors

  • Ruben Tsirunyan (@rubentsirunyan)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/zabbix/zabbix_valuemap_module.html