You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.zabbix.zabbix httpapi – HttpApi Plugin for Zabbix

Note

This httpapi plugin is part of the community.zabbix collection (version 1.9.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.

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

New in community.zabbix 1.8.0

Synopsis

• This HttpApi plugin provides methods to connect to Zabbix over their HTTP(S)-based api.

Parameters

Parameter	Comments
zabbix_auth_key string	Specifies API authentication key Configuration: Environment variable: ANSIBLE_ZABBIX_AUTH_KEY Variable: ansible_zabbix_auth_key
zabbix_url_path string	Specifies path portion in Zabbix WebUI URL, e.g. for https://myzabbixfarm.com/zabbixeu zabbix_url_path=zabbixeu Default: "zabbix" Configuration: Environment variable: ANSIBLE_ZABBIX_URL_PATH Variable: ansible_zabbix_url_path

Authors

• Markus Fischbacher (@rockaut)

• Evgeny Yurchenko (@BGmot)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.

Collection links

Issue Tracker Homepage Repository (Sources)