Documentation

zabbix_group_facts - Gather facts about Zabbix hostgroup

New in version 2.6.

Synopsis

  • This module allows you to search for Zabbix hostgroup entries.

Requirements

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

  • python >= 2.6
  • zabbix-api

Parameters

Parameter Choices/Defaults Comments
hostgroup_name
required
Name of the hostgroup in Zabbix.
hostgroup is the unique identifier used and cannot be updated using this module.
http_login_password Default:
None
Basic Auth password
http_login_user Default:
None
Basic Auth login
login_password
required
Zabbix user password.
login_user
required
Zabbix user name, used to authenticate against the server.
server_url
required
Url of Zabbix server, with protocol (http or https).

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

Examples

- name: Get hostgroup info
  local_action:
    module: zabbix_group_facts
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    hostgroup_name:
      - ExampleHostgroup
    timeout: 10

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
host_groups
dict
 success
List of Zabbix groups.

Sample:
[{'internal': '0', 'flags': '0', 'groupid': '33', 'name': 'Hostgruup A'}]


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • (@redwhitemiko)

Hint

If you notice any issues in this documentation you can edit this document to improve it.