zabbix_host_facts – Gather facts about Zabbix host

From Get docs
Ansible/docs/2.7/modules/zabbix host facts module


zabbix_host_facts – Gather facts about Zabbix host

New in version 2.7.


Synopsis

  • This module allows you to search for Zabbix host entries.

Requirements

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

  • python >= 2.6
  • zabbix-api

Parameters

Parameter Choices/Defaults Comments

exact_match

boolean

  • no

  • yes

Find the exact match

host_ip

-

Host interface IP of the host in Zabbix.

host_name

- / required

Name of the host in Zabbix.

host_name is the unique identifier used and cannot be updated using this module.

http_login_password

-

added in 2.1

Basic Auth password

http_login_user

-

added in 2.1

Basic Auth login

login_password

- / required

Zabbix user password.

login_user

- / required

Zabbix user name.

remove_duplicate

boolean

  • no
  • yes

Remove duplicate host from host result

server_url

- / required

URL of Zabbix server, with protocol (http or https). url is an alias for server_url.


aliases: url

timeout

-

Default:

10

The timeout of API request (seconds).

validate_certs

boolean

added in 2.5

  • 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.



Examples

- name: Get host info
  local_action:
    module: zabbix_host_facts
    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

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 host. See https://www.zabbix.com/documentation/3.4/manual/api/reference/host/get for list of host values.


Sample:

[{'available': '1', 'description': , 'disable_until': '0', 'error': , 'flags': '0', 'groups': ['1'], 'host': 'Host A', '...': None}]




Status

Authors

  • (@redwhitemiko)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/zabbix_host_facts_module.html