community.zabbix.zabbix_map – Create/update/delete Zabbix maps¶
Note
This plugin is part of the community.zabbix collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.zabbix
.
To use it in a playbook, specify: community.zabbix.zabbix_map
.
Synopsis¶
This module allows you to create, modify and delete Zabbix map entries, using Graphviz binaries and text description written in DOT language. Nodes of the graph will become map elements and edges will become links between map elements. See https://en.wikipedia.org/wiki/DOT_(graph_description_language) and https://www.graphviz.org/ for details. Inspired by http://blog.zabbix.com/maps-for-the-lazy/.
The following extra node attributes are supported:
zbx_host
contains name of the host in Zabbix. Use this if desired type of map element ishost
.zbx_group
contains name of the host group in Zabbix. Use this if desired type of map element ishost group
.zbx_map
contains name of the map in Zabbix. Use this if desired type of map element ismap
.zbx_label
contains label of map element.zbx_image
contains name of the image used to display the element in default state.zbx_image_disabled
contains name of the image used to display disabled map element.zbx_image_maintenance
contains name of the image used to display map element in maintenance.zbx_image_problem
contains name of the image used to display map element with problems.zbx_url
contains map element URL inname:url
format. More than one URL could be specified by adding a postfix (e.g.,zbx_url1
,zbx_url2
).The following extra link attributes are supported:
zbx_draw_style
contains link line draw style. Possible values:line
,bold
,dotted
,dashed
.zbx_trigger
contains name of the trigger used as a link indicator inhost_name:trigger_name
format. More than one trigger could be specified by adding a postfix (e.g.,zbx_trigger1
,zbx_trigger2
).zbx_trigger_color
contains indicator color specified either as CSS3 name or as a hexadecimal code starting with#
.zbx_trigger_draw_style
contains indicator draw style. Possible values are the same as forzbx_draw_style
.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
zabbix-api >= 0.5.4
pydotplus
webcolors
Pillow
Graphviz
Parameters¶
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¶
###
### Example inventory:
# [web]
# web[01:03].example.com ansible_host=127.0.0.1
# [db]
# db.example.com ansible_host=127.0.0.1
# [backup]
# backup.example.com ansible_host=127.0.0.1
###
### Each inventory host is present in Zabbix with a matching name.
###
### Contents of 'map.j2':
# digraph G {
# graph [layout=dot splines=false overlap=scale]
# INTERNET [zbx_url="Google:https://google.com" zbx_image="Cloud_(96)"]
# {% for web_host in groups.web %}
# {% set web_loop = loop %}
# web{{ '%03d' % web_loop.index }} [zbx_host="{{ web_host }}"]
# INTERNET -> web{{ '%03d' % web_loop.index }} [zbx_trigger="{{ web_host }}:Zabbix agent on {HOST.NAME} is unreachable for 5 minutes"]
# {% for db_host in groups.db %}
# {% set db_loop = loop %}
# web{{ '%03d' % web_loop.index }} -> db{{ '%03d' % db_loop.index }}
# {% endfor %}
# {% endfor %}
# { rank=same
# {% for db_host in groups.db %}
# {% set db_loop = loop %}
# db{{ '%03d' % db_loop.index }} [zbx_host="{{ db_host }}"]
# {% for backup_host in groups.backup %}
# {% set backup_loop = loop %}
# db{{ '%03d' % db_loop.index }} -> backup{{ '%03d' % backup_loop.index }} [color="blue"]
# {% endfor %}
# {% endfor %}
# {% for backup_host in groups.backup %}
# {% set backup_loop = loop %}
# backup{{ '%03d' % backup_loop.index }} [zbx_host="{{ backup_host }}"]
# {% endfor %}
# }
# }
###
### Create Zabbix map "Demo Map" made of template 'map.j2'
- name: Create Zabbix map
community.zabbix.zabbix_map:
server_url: http://zabbix.example.com
login_user: username
login_password: password
name: Demo map
state: present
data: "{{ lookup('template', 'map.j2') }}"
default_image: Server_(64)
expand_problem: no
highlight: no
label_type: label
delegate_to: localhost
run_once: yes
Authors¶
Antony Alekseyev (@Akint)