媒体类型

概述

媒体类型会与所有相关对象及对象关系一起导出。

导出

要导出媒体类型，请执行以下操作：

  1. 转到 Alerts > Media types。
  2. 勾选要导出的媒体类型复选框。
  3. 单击列表下方的 Export。

根据所选格式，媒体类型将导出到本地文件，默认文件名如下：

  • zabbix_export_mediatypes.yaml - YAML 导出（导出的默认选项）；
  • zabbix_export_mediatypes.xml - XML 导出；
  • zabbix_export_mediatypes.json - JSON 导出。

导入

要导入媒体类型，请执行以下操作：

  1. 转到 Alerts > Media types。
  2. 单击右上角的 Import。
  3. 选择导入文件。
  4. 在导入规则中勾选所需选项。
  5. 单击配置表单右下角的 Import。

导入规则：

Rule Description
Update existing 现有元素将使用导入文件中的数据进行更新。否则，不会更新。
Create new 将根据导入文件中的数据创建新元素。否则，不会创建。

导入成功或失败的消息将显示在前端中。

导出格式

导出为 YAML：

zabbix_export:
  version: '8.0'
  media_types:
    - name: Pushover
      type: WEBHOOK
      parameters:
        - name: endpoint
          value: 'https://api.pushover.net/1/messages.json'
        - name: eventid
          value: '{EVENT.ID}'
        - name: event_nseverity
          value: '{EVENT.NSEVERITY}'
        - name: event_source
          value: '{EVENT.SOURCE}'
        - name: event_value
          value: '{EVENT.VALUE}'
        - name: expire
          value: '1200'
        - name: message
          value: '{ALERT.MESSAGE}'
        - name: priority_average
          value: '0'
        - name: priority_default
          value: '0'
        - name: priority_disaster
          value: '0'
        - name: priority_high
          value: '0'
        - name: priority_information
          value: '0'
        - name: priority_not_classified
          value: '0'
        - name: priority_warning
          value: '0'
        - name: retry
          value: '60'
        - name: title
          value: '{ALERT.SUBJECT}'
        - name: token
          value: '<PUSHOVER TOKEN HERE>'
        - name: triggerid
          value: '{TRIGGER.ID}'
        - name: url
          value: '{$ZABBIX.URL}'
        - name: url_title
          value: Zabbix
        - name: user
          value: '{ALERT.SENDTO}'
      status: DISABLED
      max_sessions: '0'
      script: |
        try {
            var params = JSON.parse(value),
                request = new HttpRequest(),
                data,
                response,
                severities = [
                    {name: 'not_classified', color: '#97AAB3'},
                    {name: 'information', color: '#7499FF'},
                    {name: 'warning', color: '#FFC859'},
                    {name: 'average', color: '#FFA059'},
                    {name: 'high', color: '#E97659'},
                    {name: 'disaster', color: '#E45959'},
                    {name: 'resolved', color: '#009900'},
                    {name: 'default', color: '#000000'}
                ],
                priority;

            if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
                request.setProxy(params.HTTPProxy);
            }

            if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) {
                throw 'Incorrect "event_source" parameter given: "' + params.event_source + '".\nMust be 0-3.';
            }

            if (params.event_value !== '0' && params.event_value !== '1'
                && (params.event_source === '0' || params.event_source === '3')) {
                throw 'Incorrect "event_value" parameter given: ' + params.event_value + '\nMust be 0 or 1.';
            }

            if ([0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity)) === -1) {
                params.event_nseverity = '7';
            }

            if (params.event_value === '0') {
                params.event_nseverity = '6';
            }

            priority = params['priority_' + severities[params.event_nseverity].name] || params.priority_default;

            if (isNaN(priority) || priority < -2 || priority > 2) {
                throw '"priority" should be -2..2';
            }

            if (params.event_source === '0' && isNaN(params.triggerid)) {
                throw 'field "triggerid" is not a number';
            }

            if (isNaN(params.eventid)) {
                throw 'field "eventid" is not a number';
            }

            if (typeof params.message !== 'string' || params.message.trim() === '') {
                throw 'field "message" cannot be empty';
            }

            data = {
                token: params.token,
                user: params.user,
                title: params.title,
                message: params.message,
                url: (params.event_source === '0') 
                    ? params.url + '/tr_events.php?triggerid=' + params.triggerid + '&eventid=' + params.eventid
                    : params.url,
                url_title: params.url_title,
                priority: priority
            };

            if (priority == 2) {
                if (isNaN(params.retry) || params.retry < 30) {
                    throw 'field "retry" should be a number with value of at least 30 if "priority" is set to 2';
                }

                if (isNaN(params.expire) || params.expire > 10800) {
                    throw 'field "expire" should be a number with value of at most 10800 if "priority" is set to 2';
                }

                data.retry = params.retry;
                data.expire = params.expire;
            }

            data = JSON.stringify(data);
            Zabbix.log(4, '[ Pushover Webhook ] Sending request: ' + params.endpoint + '\n' + data);

            request.addHeader('Content-Type: application/json');
            response = request.post(params.endpoint, data);

            Zabbix.log(4, '[ Pushover Webhook ] Received response with status code ' + request.getStatus() + '\n' + response);

            if (response !== null) {
                try {
                    response = JSON.parse(response);
                }
                catch (error) {
                    Zabbix.log(4, '[ Pushover Webhook ] Failed to parse response received from Pushover');
                    response = null;
                }
            }

            if (request.getStatus() != 200 || response === null || typeof response !== 'object' || response.status !== 1) {
                if (response !== null && typeof response === 'object' && typeof response.errors === 'object'
                        && typeof response.errors[0] === 'string') {
                    throw response.errors[0];
                }
                else {
                    throw 'Unknown error. Check debug log for more information.';
                }
            }

            return 'OK';
        }
        catch (error) {
            Zabbix.log(4, '[ Pushover Webhook ] Pushover notification failed: ' + error);
            throw 'Pushover notification failed: ' + error;
        }
      description: |
        请参阅此处的设置指南：https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/pushover

        将 token 参数设置为您的 Pushover 应用密钥。
        将 Pushover 媒体分配给 Zabbix 用户时，请将用户密钥添加到“发送到”字段中。
      message_templates:
        - event_source: TRIGGERS
          operation_mode: PROBLEM
          subject: '问题：{EVENT.NAME}'
          message: |
            问题开始于 {EVENT.TIME}，日期为 {EVENT.DATE}
            问题名称：{EVENT.NAME}
            主机：{HOST.NAME}
            严重性：{EVENT.SEVERITY}
            运行数据：{EVENT.OPDATA}
            原始问题 ID：{EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: RECOVERY
          subject: '已在 {EVENT.DURATION} 内解决：{EVENT.NAME}'
          message: |
            问题已于 {EVENT.RECOVERY.TIME}，日期 {EVENT.RECOVERY.DATE} 解决
            问题名称：{EVENT.NAME}
            问题持续时间：{EVENT.DURATION}
            主机：{HOST.NAME}
            严重性：{EVENT.SEVERITY}
            原始问题 ID：{EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: UPDATE
          subject: '已更新的问题，持续 {EVENT.AGE}：{EVENT.NAME}'
          message: |
            {USER.FULLNAME} 于 {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} {EVENT.UPDATE.ACTION} 了问题。
            {EVENT.UPDATE.MESSAGE}

            当前问题状态为 {EVENT.STATUS}，持续时间为 {EVENT.AGE}，已确认：{EVENT.ACK.STATUS}。
        - event_source: DISCOVERY
          operation_mode: PROBLEM
          subject: '发现：{DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
          message: |
            发现规则：{DISCOVERY.RULE.NAME}

            设备 IP：{DISCOVERY.DEVICE.IPADDRESS}
            设备 DNS：{DISCOVERY.DEVICE.DNS}
            设备状态：{DISCOVERY.DEVICE.STATUS}
            设备运行时间：{DISCOVERY.DEVICE.UPTIME}

            设备服务名称：{DISCOVERY.SERVICE.NAME}
            设备服务端口：{DISCOVERY.SERVICE.PORT}
            设备服务状态：{DISCOVERY.SERVICE.STATUS}
            设备服务运行时间：{DISCOVERY.SERVICE.UPTIME}
        - event_source: AUTOREGISTRATION
          operation_mode: PROBLEM
          subject: '自动注册：{HOST.HOST}'
          message: |
            主机名：{HOST.HOST}
            主机 IP：{HOST.IP}
            agent 端口：{HOST.PORT}

导出的元素

导出的元素在下表中说明。

Element Type Description
name string (必填) 媒体类型名称。
type string (必填) 媒体类型使用的传输方式。
可能的值:1 EMAIL (0), SMS (1), SCRIPT (2), WEBHOOK (4).
status string 媒体类型是否启用。
可能的值:1 ENABLED (0, 默认), DISABLED (1)
max_sessions integer 可并行处理的告警最大数量。
SMS 的可能值:1 1 (默认).
其他媒体类型的可能值:1 0-100 (其中 0 表示无限制).
attempts integer 发送告警的最大尝试次数。
可能的值:1 1-10 (默认: 3).
attempt_interval string 重试尝试之间的间隔（使用秒或 time suffix）。
可能的值:1 0-60s (默认: 10s).
description string 媒体类型描述。
message_templates 媒体类型消息模板的根元素。
event_source string (必填) 事件源。
可能的值:1 TRIGGERS (0), DISCOVERY (1), AUTOREGISTRATION (2), INTERNAL (3), SERVICE (4).
operation_mode string 操作模式。
可能的值:1 PROBLEM (0), RECOVERY (1), UPDATE (2).
subject string 消息主题。
message string 消息正文。

另请参见: Media type object（请参阅名称匹配的相关属性）。

Email

以下附加元素仅针对 Email 媒体类型导出。

Element Type Description
provider string Email 提供商。
smtp_server string SMTP 服务器。
smtp_port integer 要连接的 SMTP 服务器端口。
默认值：25。
smtp_helo string SMTP helo。
smtp_email string 将从中发送通知的电子邮件地址。
smtp_security string 要使用的 SMTP 连接安全级别。
可选值：1 NONE (0, 默认), STARTTLS (1), SSL_OR_TLS (2)。
smtp_verify_host string SMTP 的 SSL 主机验证。
可选值：1 NO (0, 默认), YES (1)。
smtp_verify_peer string SMTP 的 SSL 对等方验证。
可选值：1 NO (0, 默认), YES (1)。
smtp_authentication string 要使用的 SMTP 身份验证方法。
可选值：1 NONE (0, 默认), PASSWORD (1), OAUTH (2)。
username string 用户名。
password string 身份验证密码。
redirection_url string 用于重定向回 OAuth 授权的 Zabbix 前端 URL。
client_id string 在 OAuth 授权服务器中注册的客户端标识符。
authorization_url string 用于获取访问令牌和刷新令牌的 OAuth URL，带参数。
token_url string 用于将授权令牌交换为访问令牌和刷新令牌的 OAuth URL。
message_format string 消息格式。
可选值：1 TEXT (0), HTML (1, 默认)。

另请参见：Media type object（请参阅名称匹配的相关属性）。

SMS

以下附加元素仅针对 SMS 媒体类型导出。

元素 类型 描述
gsm_modem string （必需）GSM 调制解调器的串行设备名称。

另请参见：媒体类型对象（请参考名称匹配的相关属性）。

脚本

以下附加元素仅针对 Script 媒体类型导出。

元素 类型 描述
脚本名称 string (必填) 脚本名称。
参数 脚本参数的根元素。
sortorder string (必填) 传递给脚本的脚本参数顺序，作为命令行参数。
值 string 脚本参数值。

另请参见：媒体类型对象（请参阅名称匹配的相关属性）。

webhook

以下附加元素仅针对 webhook 媒体类型导出。

Element Type Description
script string 脚本。
timeout string Javascript 脚本 HTTP 请求超时间隔。
可选值:1 1-60s（默认值: 30s）。
process_tags string 是否处理返回的标签。
可选值:1 NO (0, 默认), YES (1)。
show_event_menu string 如果在 event_menu_url 和 event_menu_name 字段中成功解析了 {EVENT.TAGS.*} 宏，则表示事件菜单中存在一个条目。
可选值:1 NO (0, 默认), YES (1)。
event_menu_url string 事件菜单条目的 URL。支持 {EVENT.TAGS.*} 宏。
event_menu_name string 事件菜单条目的名称。支持 {EVENT.TAGS.*} 宏。
parameters webhook 媒体类型参数的根元素。
name string (必填) webhook 参数名称。
value string webhook 参数值。

另请参见: Media type object（请参阅具有匹配名称的相应属性）。

脚注

1 括号中的 API 整数值，例如 ENABLED (0)，仅供参考。 有关更多信息，请参见表项中链接的 API 对象页面，或每个章节末尾的相关页面。