ansible.builtin.zabbix_screen (v2.8.13) — module

Create/update/delete Zabbix screens

| "added in version" 2.0 of ansible.builtin"

Authors: Cove (@cove), Tony Minfei Ding (!UNKNOWN), Harrison Gu (@harrisongu)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.13

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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]

Inputs

    
screens:
    description:
    - List of screens to be created/updated/deleted (see example).
    - If a screen has already been added, the screen name won't be updated.
    - When creating or updating a screen, C(screen_name) and C(host_group) are required.
    - When deleting a screen, the C(screen_name) is required.
    - Option C(graphs_in_row) will limit columns of a screen and make multiple rows (default
      3).
    - 'The available states are: C(present) (default) and C(absent). If the screen already
      exists, and the state is not C(absent), the screen will be updated as needed.

      '
    required: true

http_login_user:
    description:
    - Basic Auth login
    required: false
    type: str

http_login_password:
    description:
    - Basic Auth password
    required: false
    type: str