ansible.builtin.zabbix_screen (v2.4.4.0-1) — module

Zabbix screen creates/updates/deletes

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

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

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.4.4.0.post1

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
  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
  • 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 the screen(s) already been added, the screen(s) name won't be updated.
    - When creating or updating screen(s), C(screen_name), C(host_group) are required.
    - When deleting screen(s), the C(screen_name) is required.
    - 'The available states are: C(present) (default) and C(absent). If the screen(s)
      already exists, and the state is not C(absent), the screen(s) will just be updated
      as needed.

      '
    required: true

timeout:
    default: 10
    description:
    - The timeout of API request (seconds).

login_user:
    description:
    - Zabbix user name.
    required: true

server_url:
    aliases:
    - url
    description:
    - Url of Zabbix server, with protocol (http or https).
    required: true

login_password:
    description:
    - Zabbix user password.
    required: true

http_login_user:
    default: None
    description:
    - Basic Auth login
    required: false
    version_added: '2.1'
    version_added_collection: ansible.builtin

http_login_password:
    default: None
    description:
    - Basic Auth password
    required: false
    version_added: '2.1'
    version_added_collection: ansible.builtin