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
-
added in 2.1
Basic Auth password
http_login_user
-
added in 2.1
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
timeout
-
Default:
10
The timeout of API request (seconds).
validate_certs
boolean
added in 2.5
    Choices:
  • no
  • yes ←
If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

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
dictionary
 success
List of Zabbix groups.

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


Status

Authors

  • (@redwhitemiko)

Hint

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