W3cubDocs

/Ansible

community.zabbix.zabbix httpapi – HttpApi Plugin for Zabbix

Note

This httpapi plugin 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.

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

http_login_password

string

The http password to access zabbix url with Basic Auth

Configuration:

  • Variable: http_login_password

http_login_user

string

The http user to access zabbix url with Basic Auth

Configuration:

  • Variable: http_login_user

zabbix_auth_key

string

Specifies API authentication key

Configuration:

zabbix_url_path

string

Specifies path portion in Zabbix WebUI URL, e.g. for https://myzabbixfarm.com/zabbixeu zabbix_url_path=zabbixeu.

If Zabbix WebUI is running at the root, i.e. https://myzabbixfarm.com/, then assign empty string to this variable zabbix_url_path: ''.

Default: "zabbix"

Configuration:

Note

Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) 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. The entry types are also ordered by precedence from low to high priority order. For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).

Authors

  • Markus Fischbacher (@rockaut)
  • 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_httpapi.html