删除 Zabbix 媒介类型

注意

此模块是 community.zabbix 集合（版本 3.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.zabbix。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：community.zabbix.zabbix_mediatype。

概要 

此模块允许您创建、修改和删除 Zabbix 媒介类型。

要求 

执行此模块的主机需要以下要求。

python >= 3.9

参数 

参数	注释
attempt_interval 字符串	重试尝试之间的间隔。可能的范围是 0-1 小时。默认： `"10s"`
content_type 字符串	当 type=email 时可以使用。消息格式。选择 `"plaintext"` `"html"` ← (默认)
description 字符串	媒介类型的描述。默认： `""`
event_menu 布尔值	当 type=webhook 时可以使用。在事件菜单中包含带有指向创建的外部票证的链接的条目。选择 `false` ← (默认) `true`
event_menu_name 字符串	当 event_menu=true 时必需。事件菜单条目名称。
event_menu_url 字符串	当 event_menu=true 时必需。事件菜单条目底层 URL。
gsm_modem 字符串	gsm 调制解调器的串行设备名称。当 type=sms 时必需。
http_login_password 字符串	基本身份验证密码
http_login_user 字符串	基本身份验证登录名
max_attempts 整数	发送警报的最大尝试次数。可能的范围是 0-10。默认： `3`
max_sessions 整数	可以并行处理的最大警报数。当 type=sms 时，可能的值为 1，否则为 0-100。默认： `1`
message_templates 列表 / 元素=字典	事件类型的默认通知消息。默认： `[]`
body 字符串	默认消息的正文。可能包含宏。默认： `""`
eventsource 字符串	事件源。当使用 recovery 时必需。选择 `"triggers"` `"discovery"` `"autoregistration"` `"internal"`
recovery 字符串	操作模式。当使用 eventsource 时必需。选择 `"operations"` `"recovery_operations"` `"update_operations"`
subject 字符串	默认消息的主题。可能包含宏，并且限制为 255 个字符。默认： `""`
message_text_limit 字符串	消息文本限制。当 type=ez_texting 时必需。美国为 160 个字符，加拿大为 136 个字符。选择 `"USA"` `"Canada"`
name 字符串 / 必需	媒介类型的名称。
password 字符串	身份验证密码。当 type=jabber 或 type=ez_texting 时必需。当 type=email 且 smtp_authentication=true 时必需。
process_tags 布尔值	当 type=webhook 时可以使用。将返回的 JSON 属性值处理为标签。这些标签会添加到 Zabbix 中已存在的（如果有）问题事件标签中。选择 `false` ← (默认) `true`
script_name 字符串	执行的脚本的名称。当 type=script 时必需。
script_params 列表 / 元素=字符串	脚本参数列表。当 type=script 时必需。
smtp_authentication 布尔值	是否应启用使用用户名和密码的 SMTP 身份验证。如果设置为 `true`，则应指定 `username` 和 `password`。选择 `false` ← (默认) `true`
smtp_email 字符串	将发送通知的电子邮件地址。当 type=email 时必需。
smtp_helo 字符串	SMTP HELO。当 type=email 时必需。默认： `"localhost"`
smtp_security 字符串	要使用的 SMTP 连接安全级别。选择 `"None"` `"STARTTLS"` `"SSL/TLS"`
smtp_server 字符串	SMTP 服务器主机。当 type=email 时必需。默认： `"localhost"`
smtp_server_port 整数	SMTP 服务器端口。当 type=email 时必需。默认： `25`
smtp_verify_host 布尔值	SMTP 的 SSL 验证主机。当 smtp_security=STARTTLS 或 smtp_security=SSL/TLS 时可以指定选择 `false` ← (默认) `true`
smtp_verify_peer 布尔值	SMTP 的 SSL 验证对等方。当 smtp_security=STARTTLS 或 smtp_security=SSL/TLS 时可以指定选择 `false` ← (默认) `true`
state 字符串	媒介类型的所需状态。当为 `present` 时，如果媒介类型不存在，则会创建该媒介类型；如果关联数据不同，则会更新该媒介类型。如果设置为 `absent`，则会删除该媒体类型（如果存在）。选择 `"present"` ← (默认) `"absent"`
状态字符串	是否启用该媒体类型。选择 `"enabled"` ← (默认) `"disabled"`
类型字符串 / 必需	媒体类型的类型。媒体类型 jabber 和 ez_texting 仅适用于 Zabbix 4.2 或更早版本。选择 `"email"` `"script"` `"sms"` `"webhook"` `"jabber"` `"ez_texting"`
用户名字符串	用户名或 Jabber 标识符。当 type=jabber 或 type=ez_texting 时必需。当 type=email 且 smtp_authentication=true 时必需。
webhook_params 列表 / 元素=字典	当 type=webhook 时可以使用。执行 webhook 脚本时传递给 webhook 的变量。默认： `[]`
name 字符串 / 必需	参数的名称。
值字符串	参数的值。问题通知中支持的所有宏都可以在参数中使用。值会自动进行 URL 编码。宏中的值会被解析，然后自动进行 URL 编码。默认： `""`
webhook_script 字符串	当 type=webhook 时为必填项。将执行 webhook 操作的 JavaScript 代码。此代码可以访问 webhook_params 中的所有参数。它可以执行 HTTP GET、POST、PUT 和 DELETE 请求，并可以控制 HTTP 头部和请求体。它可能返回 OK 状态，以及可选的标签列表和标签值，或者返回一个错误字符串。
webhook_timeout 字符串	当 type=webhook 时可以使用。 webhook_script 中 JavaScript 代码的执行超时时间。可能的值为 1-60 秒。默认值： `"30s"`

示例 

# 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}"

作者

Ruben Tsirunyan (@rubentsirunyan)

community.zabbix.zabbix_mediatype 模块 – 创建/更新/删除 Zabbix 媒介类型

概要

要求

参数

示例

作者

集合链接

概要 

要求 

参数 

示例 