Documentation

zabbix_group - Zabbix host groups creates/deletes

New in version 1.8.

Synopsis

  • Create host groups if they do not exist.
  • Delete existing host groups if they exist.

Requirements

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

  • python >= 2.6
  • zabbix-api

Parameters

Parameter Choices/Defaults Comments
host_groups
required
List of host groups to create or delete.

aliases: host_group
http_login_password
(added in 2.1)
Default:
None
Basic Auth password
http_login_user
(added in 2.1)
Default:
None
Basic Auth login
login_password
required
Zabbix user password.
login_user
required
Zabbix user name.
server_url
required
Url of Zabbix server, with protocol (http or https). url is an alias for server_url.

aliases: url
state
    Choices:
  • present ←
  • absent
Create or delete host group.
timeout Default:
10
The timeout of API request(seconds).
validate_certs
(added in 2.5)
    Choices:
  • true
  • false
Default:
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 group may cause Zabbix to return errors, see examples for a workaround if needed.

Examples

# Base create host groups example
- name: Create host groups
  local_action:
    module: zabbix_group
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    state: present
    host_groups:
      - Example group1
      - Example group2

# Limit the Zabbix group creations to one host since Zabbix can return an error when doing concurrent updates
- name: Create host groups
  local_action:
    module: zabbix_group
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    state: present
    host_groups:
      - Example group1
      - Example group2
  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.

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.