community.zabbix.zabbix_host_events_info – Get all triggers about a Zabbix host
Note
This plugin is part of the community.zabbix collection (version 1.1.0).
To install it use: ansible-galaxy collection install community.zabbix.
To use it in a playbook, specify: community.zabbix.zabbix_host_events_info.
Synopsis
- This module allows you to see if a Zabbix host have no active alert to make actions on it. For this case use module Ansible ‘fail’ to exclude host in trouble.
- Length of “triggers_ok” allow if template’s triggers exist for Zabbix Host
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- zabbix-api >= 0.5.3
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| host_id_type
string
|
|
Type of host_identifier
|
| host_identifier
string / required
|
Identifier of Zabbix Host
|
|
| http_login_password
string
|
Basic Auth password
|
|
| http_login_user
string
|
Basic Auth login
|
|
| login_password
string / required
|
Zabbix user password.
|
|
| login_user
string / required
|
Zabbix user name.
|
|
| 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).
|
| trigger_severity
string
|
|
Zabbix severity for search filter
|
| validate_certs
boolean
|
|
If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|
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: exclude machine if alert active on it
community.zabbix.zabbix_host_events_info:
server_url: "{{ zabbix_url }}"
login_user: "{{ lookup('env','ZABBIX_USER') }}"
login_password: "{{ lookup('env','ZABBIX_PASSWORD') }}"
host_identifier: "{{inventory_hostname}}"
host_id_type: "hostname"
timeout: 120
register: zbx_host
delegate_to: localhost
- fail:
msg: "machine alert in zabbix"
when: zbx_host['triggers_problem']|length > 0
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |||
|---|---|---|---|---|---|
| triggers_ok
complex
|
On success |
Host Zabbix Triggers in OK state
|
|||
| comments
string
|
success |
Additional description of the trigger
|
|||
| description
string
|
success |
Name of the trigger
|
|||
| error
string
|
success |
Error text if there have been any problems when updating the state of the trigger
|
|||
| expression
string
|
success |
Reduced trigger expression
|
|||
| flags
integer
|
success |
Origin of the trigger
|
|||
| lastchange
integer
|
success |
Time when the trigger last changed its state (timestamp)
|
|||
| priority
integer
|
success |
Severity of the trigger
|
|||
| state
integer
|
success |
State of the trigger
|
|||
| status
integer
|
success |
Whether the trigger is enabled or disabled
|
|||
| templateid
integer
|
success |
ID of the parent template trigger
|
|||
| triggerid
integer
|
success |
ID of the trigger
|
|||
| type
integer
|
success |
Whether the trigger can generate multiple problem events
|
|||
| url
string
|
success |
URL associated with the trigger
|
|||
| value
integer
|
success |
Whether the trigger is in OK or problem state
|
|||
| triggers_problem
complex
|
On success |
Host Zabbix Triggers in problem state. See trigger and event objects in API documentation of your zabbix version for more
|
|||
| comments
string
|
success |
Additional description of the trigger
|
|||
| description
string
|
success |
Name of the trigger
|
|||
| error
string
|
success |
Error text if there have been any problems when updating the state of the trigger
|
|||
| expression
string
|
success |
Reduced trigger expression
|
|||
| flags
integer
|
success |
Origin of the trigger
|
|||
| last_event
complex
|
success |
last event informations
|
|||
| acknowledged
integer
|
success |
If set to true return only acknowledged events
|
|||
| acknowledges
complex
|
success |
acknowledges informations
|
|||
| alias
string
|
success |
Account who acknowledge
|
|||
| clock
integer
|
success |
Time when the event was created (timestamp)
|
|||
| message
string
|
success |
Text of the acknowledgement message
|
|||
| clock
integer
|
success |
Time when the event was created (timestamp)
|
|||
| eventid
integer
|
success |
ID of the event
|
|||
| value
integer
|
success |
State of the related object
|
|||
| lastchange
integer
|
success |
Time when the trigger last changed its state (timestamp)
|
|||
| priority
integer
|
success |
Severity of the trigger
|
|||
| state
integer
|
success |
State of the trigger
|
|||
| status
integer
|
success |
Whether the trigger is enabled or disabled
|
|||
| templateid
integer
|
success |
ID of the parent template trigger
|
|||
| triggerid
integer
|
success |
ID of the trigger
|
|||
| type
integer
|
success |
Whether the trigger can generate multiple problem events
|
|||
| url
string
|
success |
URL associated with the trigger
|
|||
| value
integer
|
success |
Whether the trigger is in OK or problem state
|
|||
Authors
- Stéphane Travassac (@stravassac)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/zabbix/zabbix_host_events_info_module.html