deletes¶

New in version 2.0.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

Synopsis ¶

This module allows you to create, modify and delete Zabbix screens and associated graph data.

Requirements ¶

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

python >= 2.6
zabbix-api

Parameters ¶

Parameter	Choices/Defaults	Comments
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.
screens required		List of screens to be created/updated/deleted(see example). If the screen(s) already been added, the screen(s) name won't be updated. When creating or updating screen(s), `screen_name`, `host_group` are required. When deleting screen(s), the `screen_name` is required. Option `graphs_in_row` will limit columns of screen and make multiple rows (default 3) The available states are: `present` (default) and `absent`. If the screen(s) already exists, and the state is not `absent`, the screen(s) will just be updated as needed.
server_url required		URL of Zabbix server, with protocol (http or https). `url` is an alias for `server_url`. aliases: url
timeout	Default: 10	The timeout of API request (seconds).
validate_certs bool (added in 2.5)	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.

Notes ¶

Note

Too many concurrent updates to the same screen may cause Zabbix to return errors, see examples for a workaround if needed.

Examples ¶

# Create/update a screen.
- name: Create a new screen or update an existing screen's items 5 in a row
  local_action:
    module: 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: 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: 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]

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

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.

Author ¶

(@cove)
Tony Minfei Ding
Harrison Gu (@harrisongu)

Hint

If you notice any issues in this documentation you can edit this document to improve it.