Documentation

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
    Choices:
  • 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
string
added in 2.1
Basic Auth password
http_login_user
string / required
added in 2.1
Basic Auth login
login_password
string / required
Zabbix user password.
login_user
string / required
Zabbix user name.
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.

aliases: url
timeout
integer
Default:
10
The timeout of API request (seconds).
validate_certs
boolean
added in 2.5
    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.

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

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


Status

Authors

  • Michael Miko (@RedWhiteMiko)

Hint

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