community.zabbix.zabbix_correlation module – Create/update/delete Zabbix correlation
Note
This module is part of the community.zabbix collection (version 3.1.1).
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_correlation
.
New in community.zabbix 2.4.0
Synopsis
This module allows you to create, update and delete Zabbix correlation.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
Parameters
Parameter |
Comments |
---|---|
Description of this correlation |
|
A filter. |
|
A condition. |
|
Arbitrary unique ID that is used to reference the condition from a custom expression. This parameter’s value must be only contain capital-case letters. This parameter is required if value of evaltype of the filter is |
|
A name of hostgroup name This parameter is required if value of type of the condition is |
|
New event tag. This parameter is required if value of type of the condition is |
|
Old event tag. This parameter is required if value of type of the condition is |
|
Condition operator. This parameter is required if value of type of the condition is You can only select Choices:
|
|
Event tag (old or new). This parameter is required if value of type of the condition is |
|
Type of the condition. Choices:
|
|
Event tag (old or new) value. This parameter is required if value of type of the condition is |
|
An evaluation method of the filter. Choices:
|
|
A custom expression for the filter. This parameter is required if value of evaltype is |
|
Basic Auth password |
|
Basic Auth login |
|
Name of this correlation |
|
A operations. |
|
Type of the operation. Choices:
|
|
State of the correlation. Choices:
|
|
Status of the correlation. Choices:
|
Examples
# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
ansible.builtin.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
ansible.builtin.set_fact:
ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895
- name: Create correlation of 'New event tag correlation'
# 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_correlation:
name: New event tag correlation
filter:
evaltype: and_or
conditions:
- type: new_event_tag
tag: ok
operations:
- type: close_old_events
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the operation Returned: success Sample: |