community.zabbix.zabbix_host_events_info module – Get all triggers about a Zabbix host
Note
This module is part of the community.zabbix collection (version 1.9.3).
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.
You need further requirements to be able to use this module,
see Requirements for details.
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
Parameters
Parameter |
Comments |
|---|---|
Type of host_identifier Choices:
|
|
Identifier of Zabbix Host |
|
Basic Auth password |
|
Basic Auth login |
|
Zabbix user password. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Zabbix user name. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
URL of Zabbix server, with protocol (http or https). If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
The timeout of API request (seconds). This option is deprecated with the move to httpapi connection and will be removed in the next release The default value is |
|
Zabbix severity for search filter Choices:
|
|
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 This option is deprecated with the move to httpapi connection and will be removed in the next release The default value is Choices:
|
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
# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
set_fact:
ansible_user: Admin
ansible_httpapi_pass: zabbix
# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
set_fact:
ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895
- name: exclude machine if alert active on it
# set task level variables as we change ansible_connection plugin here
vars:
ansible_network_os: community.zabbix.zabbix
ansible_connection: httpapi
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_zabbix_url_path: 'zabbixeu' # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
ansible_host: zabbix-example-fqdn.org
community.zabbix.zabbix_host_events_info:
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 |
Description |
|---|---|
Host Zabbix Triggers in OK state Returned: On success |
|
Additional description of the trigger Returned: success |
|
Name of the trigger Returned: success |
|
Error text if there have been any problems when updating the state of the trigger Returned: success |
|
Reduced trigger expression Returned: success |
|
Origin of the trigger Returned: success |
|
Time when the trigger last changed its state (timestamp) Returned: success |
|
Severity of the trigger Returned: success |
|
State of the trigger Returned: success |
|
Whether the trigger is enabled or disabled Returned: success |
|
ID of the parent template trigger Returned: success |
|
ID of the trigger Returned: success |
|
Whether the trigger can generate multiple problem events Returned: success |
|
URL associated with the trigger Returned: success |
|
Whether the trigger is in OK or problem state Returned: success |
|
Host Zabbix Triggers in problem state. See trigger and event objects in API documentation of your zabbix version for more Returned: On success |
|
Additional description of the trigger Returned: success |
|
Name of the trigger Returned: success |
|
Error text if there have been any problems when updating the state of the trigger Returned: success |
|
Reduced trigger expression Returned: success |
|
Origin of the trigger Returned: success |
|
last event informations Returned: success |
|
If set to true return only acknowledged events Returned: success |
|
acknowledges informations Returned: success |
|
Account who acknowledge Returned: success |
|
Time when the event was created (timestamp) Returned: success |
|
Text of the acknowledgement message Returned: success |
|
Time when the event was created (timestamp) Returned: success |
|
ID of the event Returned: success |
|
State of the related object Returned: success |
|
Time when the trigger last changed its state (timestamp) Returned: success |
|
Severity of the trigger Returned: success |
|
State of the trigger Returned: success |
|
Whether the trigger is enabled or disabled Returned: success |
|
ID of the parent template trigger Returned: success |
|
ID of the trigger Returned: success |
|
Whether the trigger can generate multiple problem events Returned: success |
|
URL associated with the trigger Returned: success |
|
Whether the trigger is in OK or problem state Returned: success |