community.zabbix.zabbix_host_info – Gather information about Zabbix host

Note

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

Synopsis

This module allows you to search for Zabbix host entries.
This module was called zabbix_host_facts before Ansible 2.9. The usage did not change.

Requirements

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

python >= 2.6
zabbix-api >= 0.5.4

Parameters

Parameter	Choices/Defaults	Comments
exact_match boolean	Choices: no ← yes	Find the exact match
host_inventory list / elements=string		List of host inventory keys to display in result. Whole host inventory is retrieved if keys are not specified.
host_ip list / elements=string		Host interface IP of the host in Zabbix. Required when host_name is not used.
host_name string		Name of the host in Zabbix. host_name is the unique identifier used and cannot be updated using this module. Required when host_ip is not used.
http_login_password string		Basic Auth password
http_login_user string		Basic Auth login
login_password string / required		Zabbix user password. If not set the environment variable `ZABBIX_PASSWORD` will be used.
login_user string / required		Zabbix user name. If not set the environment variable `ZABBIX_USERNAME` will be used.
remove_duplicate boolean	Choices: no yes ←	Remove duplicate host from host result
server_url string / required		URL of Zabbix server, with protocol (http or https). `url` is an alias for `server_url`. If not set the environment variable `ZABBIX_SERVER` will be used. aliases: url
timeout integer	Default: 10	The timeout of API request (seconds).
validate_certs boolean	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. If not set the environment variable `ZABBIX_VALIDATE_CERTS` will be used.

Notes

Note

If you use login_password=zabbix, the word “zabbix” is replaced by “****” in all module output, because login_password uses no_log. See this FAQ for more information.

Examples

- name: Get host info
  local_action:
    module: community.zabbix.zabbix_host_info
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    host_name: ExampleHost
    host_ip: 127.0.0.1
    timeout: 10
    exact_match: no
    remove_duplicate: yes

- name: Reduce host inventory information to provided keys
  local_action:
    module: community.zabbix.zabbix_host_info
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    host_name: ExampleHost
    host_inventory:
      - os
      - tag
    host_ip: 127.0.0.1
    timeout: 10
    exact_match: no
    remove_duplicate: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
hosts dictionary	success	List of Zabbix hosts. See https://www.zabbix.com/documentation/4.0/manual/api/reference/host/get for list of host values. Sample: [{'...': None, 'available': '1', 'description': '', 'disable_until': '0', 'error': '', 'flags': '0', 'groups': ['1'], 'host': 'Host A'}]

Authors

Michael Miko (@RedWhiteMiko)

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

Docs

Docs4dev

Title here