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 (on host that executes module)

  • python >= 2.6
  • zabbix-api

Options

parameter required default choices comments
host_groups
 yes
    List of host groups to create or delete.

    aliases: host_group
    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.
            server_url
            		 yes
              Url of Zabbix server, with protocol (http or https). url is an alias for server_url.

              aliases: url
              state
              		 no present
              • present
              • absent
              Create or delete host group.
              timeout
              		 no 10
                The timeout of API request(seconds).

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

                Notes

                Note

                Too many concurrent updates to the same group 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.