/ home / community / community.zabbix / 2.3.1 / module / zabbix_group_info

community.zabbix.zabbix_group_info (2.3.1) — module

Gather information about Zabbix hostgroup

Authors: Michael Miko (@RedWhiteMiko)

Install collection

Install with ansible-galaxy collection install community.zabbix:==2.3.1

Add to requirements.yml

  collections:
    - name: community.zabbix
      version: 2.3.1

Description

This module allows you to search for Zabbix hostgroup entries.

This module was called C(zabbix_group_facts) before Ansible 2.9. The usage did not change.

Requirements

python >= 3.9

Usage examples

Scanned by Steampunk Spotter

# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
  ansible.builtin.set_fact:
    ansible_user: Admin
    ansible_httpapi_pass: zabbix

Scanned by Steampunk Spotter

# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
  ansible.builtin.set_fact:
    ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895

Scanned by Steampunk Spotter

- name: Get hostgroup info
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: "zabbixeu"  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_group_info:
    hostgroup_name:
      - ExampleHostgroup

Inputs

    
hostgroup_name:
    description:
    - Name of the hostgroup in Zabbix.
    - hostgroup is the unique identifier used and cannot be updated using this module.
    elements: str
    required: true
    type: list

http_login_user:
    description:
    - Basic Auth login
    required: false
    type: str

http_login_password:
    description:
    - Basic Auth password
    required: false
    type: str

Outputs

host_groups:
  description: List of Zabbix groups.
  returned: success
  sample:
  - flags: '0'
    groupid: '33'
    internal: '0'
    name: Hostgruup A
  type: dict