community.zabbix.zabbix_mediatype module – Create/Update/Delete Zabbix media types
Note
This module is part of the community.zabbix collection (version 2.5.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_mediatype
.
Synopsis
This module allows you to create, modify and delete Zabbix media types.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
Parameters
Parameter |
Comments |
---|---|
The interval between retry attempts. Possible range is 0-1h. Default: |
|
Can be used when type=email. Message format. Choices:
|
|
Description of the media type. Default: |
|
Can be used when type=webhook. Includes entry in Event menu with link to created external ticket. Choices:
|
|
Requred when event_menu=true. Event menu entry name. |
|
Requred when event_menu=true. Event menu entry underlying URL. |
|
Serial device name of the gsm modem. Required when type=sms. |
|
Basic Auth password |
|
Basic Auth login |
|
The maximum number of attempts to send an alert. Possible range is 0-10. Default: |
|
The maximum number of alerts that can be processed in parallel. Possible value is 1 when type=sms and 0-100 otherwise. Default: |
|
Default notification messages for the event types. Default: |
|
Body of the default message. May contain macros. Default: |
|
Event source. Required when recovery is used. Choices:
|
|
Operation mode. Required when eventsource is used. Choices:
|
|
Subject of the default message. May contain macros and is limited to 255 characters. Default: |
|
The message text limit. Required when type=ez_texting. 160 characters for USA and 136 characters for Canada. Choices:
|
|
Name of the media type. |
|
Authentication password. Required when type=jabber or type=ez_texting. Required when type=email and smtp_authentication=true. |
|
Can be used when type=webhook. Process returned JSON property values as tags. These tags are added to the already existing (if any) problem event tags in Zabbix. Choices:
|
|
The name of the executed script. Required when type=script. |
|
List of script parameters. Required when type=script. |
|
Whether SMTP authentication with username and password should be enabled or not. If set to Choices:
|
|
Email address from which notifications will be sent. Required when type=email. |
|
SMTP HELO. Required when type=email. Default: |
|
SMTP connection security level to use. Choices:
|
|
SMTP server host. Required when type=email. Default: |
|
SMTP server port. Required when type=email. Default: |
|
SSL verify host for SMTP. Can be specified when smtp_security=STARTTLS or smtp_security=SSL/TLS Choices:
|
|
SSL verify peer for SMTP. Can be specified when smtp_security=STARTTLS or smtp_security=SSL/TLS Choices:
|
|
Desired state of the mediatype. On On Choices:
|
|
Whether the media type is enabled or no. Choices:
|
|
Type of the media type. Media types jabber and ez_texting works only with Zabbix versions 4.2 or older. Choices:
|
|
Username or Jabber identifier. Required when type=jabber or type=ez_texting. Required when type=email and smtp_authentication=true. |
|
Can be used when type=webhook. Webhook variables that are passed to webhook script when executed. Default: |
|
Name of the parameter. |
|
Value of the parameter. All macros that are supported in problem notifications are supported in the parameters. Values are URL-encoded automatically. Values from macros are resolved and then URL-encoded automatically. Default: |
|
Required when type=webhook. JavaScript code that will perform webhook operation. This code has access to all parameters in webhook_params. It may perform HTTP GET, POST, PUT and DELETE requests and has control over HTTP headers and request body. It may return OK status along with an optional list of tags and tag values or an error string. |
|
Can be used when type=webhook. Execution timeout for JavaScript code in webhook_script. Possible values are 1-60s. Default: |
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 an email mediatype with SMTP authentication"
# 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_mediatype:
name: "Ops email"
type: "email"
smtp_server: "example.com"
smtp_server_port: 2000
smtp_email: "[email protected]"
smtp_authentication: true
username: "smtp_user"
password: "smtp_pass"
- name: "Create a script mediatype"
# 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_mediatype:
name: "my script"
type: "script"
script_name: "my_script.py"
script_params:
- "arg1"
- "arg2"
- name: "Create a jabber mediatype"
# 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_mediatype:
name: "My jabber"
type: "jabber"
username: "jabber_id"
password: "jabber_pass"
- name: "Create a SMS mediatype"
# 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_mediatype:
name: "My SMS Mediatype"
type: "sms"
gsm_modem: "/dev/ttyS0"
- name: "Create a webhook mediatype"
# 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_mediatype:
name: "My webhook Mediatype"
type: "webhook"
webhook_script: "{{ lookup('file', 'slack.js') }}"
webhook_params:
- name: alert_message
value: "{ALERT.MESSAGE}"
- name: zabbix_url
value: "{$ZABBIX.URL}"
process_tags: true
event_menu: true
event_menu_name: "Open in Slack: '{EVENT.TAGS.__channel_name}'"
event_menu_url: "{EVENT.TAGS.__message_link}"
- name: "Create an email mediatype with message templates"
# 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_mediatype:
name: "Ops email"
type: "email"
smtp_email: "[email protected]"
message_templates:
- eventsource: triggers
recovery: operations
subject: "Problem: {EVENT.NAME}"
body: "Problem started at {EVENT.TIME} on {EVENT.DATE}\r\nProblem name: {EVENT.NAME}\r\n"
- eventsource: triggers
recovery: recovery_operations
subject: "Resolved: {EVENT.NAME}"
body: "Problem resolved at {EVENT.TIME} on {EVENT.DATE}\r\nProblem name: {EVENT.NAME}\r\n"
- eventsource: triggers
recovery: update_operations
subject: "Updated problem: {EVENT.NAME}"
body: "{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.\r\n"
- eventsource: discovery
recovery: operations
subject: "Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}"
body: "Discovery rule: {DISCOVERY.RULE.NAME}\r\n\r\nDevice IP: {DISCOVERY.DEVICE.IPADDRESS}"
- eventsource: autoregistration
recovery: operations
subject: "Autoregistration: {HOST.HOST}"
body: "Host name: {HOST.HOST}\r\nHost IP: {HOST.IP}\r\nAgent port: {HOST.PORT}"