W3cubDocs

/Ansible

community.zabbix.zabbix_proxy_group module – Create/update/delete Zabbix proxy group

Note

This module is part of the community.zabbix collection (version 3.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.zabbix. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.zabbix.zabbix_proxy_group.

Synopsis

  • This module allows you to create, modify and delete Zabbix proxy group.

Requirements

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

  • python >= 3.9

Parameters

Parameter

Comments

description

string

Description of the proxy group.

failover_delay

string

Failover period for each proxy in the group to have online/offline state.

Time suffixes are supported, e.g. 30s, 1m.

Default: "1m"

http_login_password

string

Basic Auth password

http_login_user

string

Basic Auth login

min_online

string

Minimum number of online proxies required for the group to be online.

Possible values range: 1-1000.

Default: "1"

name

string / required

Name of the proxy group.

state

string

State of the proxy group.

On present, it will create if proxy group does not exist or update it if the associated data is different.

On absent will remove the proxy group if it exists.

Choices:

  • "present" ← (default)
  • "absent"

Examples

---
# 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

# 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

- name: Create/update Zabbix proxy group
  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_proxy_group:
    name: ProxyGroup01
    description: Example Zabbix Proxy Group
    state: present
    failover_delay: 10s
    min_online: 2

- name: delete Zabbix proxy group
  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_proxy_group:
    name: ProxyGroup01
    state: absent

Authors

  • Evgeny Yurchenko (@BGmot)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/zabbix/zabbix_proxy_group_module.html