community / community.zabbix / 1.8.0 / module / zabbix_screen Create/update/delete Zabbix screens Authors: Cove (@cove), Tony Minfei Ding (!UNKNOWN), Harrison Gu (@harrisongu)community.zabbix.zabbix_screen (1.8.0) — module
Install with ansible-galaxy collection install community.zabbix:==1.8.0
collections: - name: community.zabbix version: 1.8.0
This module allows you to create, modify and delete Zabbix screens and associated graph data.
# Screens where removed from Zabbix with Version 5.4 # Create/update a screen. - name: Create a new screen or update an existing screen's items 5 in a row local_action: module: community.zabbix.zabbix_screen server_url: http://monitor.example.com login_user: username login_password: password screens: - screen_name: ExampleScreen1 host_group: Example group1 state: present graph_names: - Example graph1 - Example graph2 graph_width: 200 graph_height: 100 graphs_in_row: 5
# Create/update multi-screen - name: Create two of new screens or update the existing screens' items local_action: module: community.zabbix.zabbix_screen server_url: http://monitor.example.com login_user: username login_password: password screens: - screen_name: ExampleScreen1 host_group: Example group1 state: present graph_names: - Example graph1 - Example graph2 graph_width: 200 graph_height: 100 - screen_name: ExampleScreen2 host_group: Example group2 state: present graph_names: - Example graph1 - Example graph2 graph_width: 200 graph_height: 100
# Limit the Zabbix screen creations to one host since Zabbix can return an error when doing concurrent updates - name: Create a new screen or update an existing screen's items local_action: module: community.zabbix.zabbix_screen server_url: http://monitor.example.com login_user: username login_password: password state: present screens: - screen_name: ExampleScreen host_group: Example group state: present graph_names: - Example graph1 - Example graph2 graph_width: 200 graph_height: 100 when: inventory_hostname==groups['group_name'][0]
# Create/update using multiple hosts_groups. Hosts NOT present in all listed host_groups will be skipped. - name: Create new screen or update the existing screen's items for hosts in both given groups local_action: module: community.zabbix.zabbix_screen server_url: http://monitor.example.com login_user: username login_password: password screens: - screen_name: ExampleScreen1 host_group: - Example group1 - Example group2 state: present graph_names: - Example graph1 - Example graph2 graph_width: 200 graph_height: 100
screens: description: - List of screens to be created/updated/deleted (see example). elements: dict required: true suboptions: graph_height: description: - Graph height will be set in graph settings. type: int graph_names: description: - Graph names will be added to a screen. Case insensitive. - Required if I(state=present). elements: str type: list graph_width: description: - Graph width will be set in graph settings. type: int graphs_in_row: default: 3 description: - Limit columns of a screen and make multiple rows. type: int host_group: aliases: - host_groups description: - Host group(s) will be used for searching hosts. - Required if I(state=present). elements: str type: list screen_name: description: - Screen name will be used. - If a screen has already been added, the screen name won't be updated. required: true type: str sort: default: false description: - Sort hosts alphabetically. - If there are numbers in hostnames, leading zero should be used. type: bool state: choices: - absent - present default: present description: - I(present) - Create a screen if it doesn't exist. If the screen already exists, the screen will be updated as needed. - I(absent) - If a screen exists, the screen will be deleted. type: str type: list timeout: default: 10 description: - The timeout of API request (seconds). type: int login_user: description: - Zabbix user name. - If not set the environment variable C(ZABBIX_USERNAME) will be used. required: true type: str server_url: aliases: - url description: - URL of Zabbix server, with protocol (http or https). C(url) is an alias for C(server_url). - If not set the environment variable C(ZABBIX_SERVER) will be used. required: true type: str login_password: description: - Zabbix user password. - If not set the environment variable C(ZABBIX_PASSWORD) will be used. required: true type: str validate_certs: default: true description: - 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 C(ZABBIX_VALIDATE_CERTS) will be used. type: bool http_login_user: description: - Basic Auth login type: str http_login_password: description: - Basic Auth password type: str