Documentation

zabbix_screen - Zabbix screen creates/updates/deletes

New in version 2.0.

Synopsis

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

Requirements (on host that executes module)

  • python >= 2.6
  • zabbix-api

Options

parameter required default choices comments
http_login_password
(added in 2.1)
 no None
    Basic Auth password
    http_login_user
    (added in 2.1)
    		 no None
      Basic Auth login
      login_password
      		 yes
        Zabbix user password.
        login_user
        		 yes
          Zabbix user name.
          screens
          		 yes
            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.
            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
            		 yes
              Url of Zabbix server, with protocol (http or https).

              aliases: url
              timeout
              		 no 10
                The timeout of API request (seconds).

                Examples

                # Create/update a screen.
- 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
    screens:
      - screen_name: ExampleScreen1
        host_group: Example group1
        state: present
        graph_names:
          - Example graph1
          - Example graph2
        graph_width: 200
        graph_height: 100

# 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 concurent 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]

                Notes

                Note

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

                This is an Extras Module

                For more information on what this means please read Extras Modules

                For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.