6 媒介类型

概述

媒体类型与所有相关的 objects 和 object 关系都是exported

导出

要添加 export 媒介类型,请执行以下操作:

  1. 转至 告警媒介类型
  2. 标记要导出的媒介类型对应的复选框。
  3. 点击列表下方的“导出”。

根据所选格式,媒介类型将导出到本地 file,并采用默认名称:

  • zabbix_export_mediatypes.yaml - 在YAML export 中(导出的默认选项);
  • zabbix_export_mediatypes.xml - 在XML导出中;
  • zabbix_export_mediatypes.json - 在 JSON 导出中。

导入

要import媒体类型,请执行以下步骤:

1.转至 告警媒体类型。 2.点击Top右上角的 导入。 3.选择import文件。 4.在import规则中勾选所需选项。 5.点击配置表单右下角的 导入

导入规则:

规则 描述
更新现有 将使用来自import文件的数据更新现有元素。否则,不会更新它们。
创建新元素 将使用来自import文件的数据创建新元素。否则,不会创建它们。

import的成功或失败消息将在前端显示。

导出格式

导出为 YAML:

zabbix_export:
  version: '7.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: |
        Please refer to setup guide here: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/pushover

        Set token parameter with to your Pushover application key.
        When assigning Pushover media to the Zabbix user - add user key into send to field.
      message_templates:
        - event_source: TRIGGERS
          operation_mode: PROBLEM
          subject: 'Problem: {EVENT.NAME}'
          message: |
            Problem started at {EVENT.TIME} on {EVENT.DATE}
            Problem name: {EVENT.NAME}
            Host: {HOST.NAME}
            Severity: {EVENT.SEVERITY}
            Operational data: {EVENT.OPDATA}
            Original problem ID: {EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: RECOVERY
          subject: 'Resolved in {EVENT.DURATION}: {EVENT.NAME}'
          message: |
            Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
            Problem name: {EVENT.NAME}
            Problem duration: {EVENT.DURATION}
            Host: {HOST.NAME}
            Severity: {EVENT.SEVERITY}
            Original problem ID: {EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: UPDATE
          subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
          message: |
            {USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
            {EVENT.UPDATE.MESSAGE}

            Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
        - event_source: DISCOVERY
          operation_mode: PROBLEM
          subject: 'Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
          message: |
            Discovery rule: {DISCOVERY.RULE.NAME}

            Device IP: {DISCOVERY.DEVICE.IPADDRESS}
            Device DNS: {DISCOVERY.DEVICE.DNS}
            Device status: {DISCOVERY.DEVICE.STATUS}
            Device uptime: {DISCOVERY.DEVICE.UPTIME}

            Device service name: {DISCOVERY.SERVICE.NAME}
            Device service port: {DISCOVERY.SERVICE.PORT}
            Device service status: {DISCOVERY.SERVICE.STATUS}
            Device service uptime: {DISCOVERY.SERVICE.UPTIME}
        - event_source: AUTOREGISTRATION
          operation_mode: PROBLEM
          subject: 'Autoregistration: {HOST.HOST}'
          message: |
            Host name: {HOST.HOST}
            Host IP: {HOST.IP}
            Agent port: {HOST.PORT}

导出的元素

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

元素 类型 说明
name string (必填)媒介类型名称。
type string (必填)媒介类型使用的传输方式。
可能的值:1 电子邮件(0)、短信(1)、脚本(2)、网络钩子(4)。
status string 媒介类型是否启用。
可能的值:1 启用(0,默认)、禁用(1)。
max_sessions integer 可以并行处理的告警最大数量。
SMS 的可能值:1 1(默认)。
其他媒介类型的可能值:1 0-100(其中 0 表示无限制)。
attempts integer 发送告警的最大尝试次数。
可能的值:1 1-10(默认:3)。
attempt_interval string 重试尝试之间的间隔(使用秒或 时间后缀)。
可能的值:1 0-60s(默认:10s)。
description string 媒介类型描述。
message_templates 媒介类型消息模板的根元素。
event_source string (必填)事件来源。
可能的值:1 触发器(0)、发现(1)、自动注册(2)、内部(3)、服务(4)。
operation_mode string 操作模式。
可能的值:1 问题(0)、恢复(1)、更新(2)。
subject string 消息主题。
message string 消息正文。

另请参阅:Media type object(参考具有匹配名称的相关属性)。

电子邮件

以下附加元素仅适用于电子邮件媒体类型。

元素 类型 描述
provider string 电子邮件提供商。
smtp_server string SMTP服务器。
smtp_port integer 要连接的SMTP服务器端口。
默认值:25。
smtp_helo string SMTP HELO。
smtp_email string 发送通知的电子邮件地址。
smtp_security string 要使用的SMTP连接安全级别。
可能的值:1 无(0,默认),STARTTLS(1),SSL_OR_TLS(2)。
smtp_verify_host string SMTP的SSL验证主机。
可能的值:1 否(0,默认),是(1)。
smtp_verify_peer string SMTP的SSL验证对端。
可能的值:1 否(0,默认),是(1)。
smtp_authentication string 要使用的SMTP认证方法。
可能的值:1 无(0,默认),密码(1)。
username string 用户名。
password string 认证密码。
message_format string 消息格式。
可能的值:1 文本(0),HTML(1,默认)。

另请参阅:Media type object(请参考名称匹配的相关属性)。

短信

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

元素 类型 描述
gsm_modem string (必填)GSM调制解调器的串口设备名称。

另请参见:Media type object(参考名称匹配的相关属性)。

脚本

以下附加元素在导出为脚本媒介类型时导出。

元素 类型 说明
script name string (必填)脚本名称。
parameters 脚本参数的根元素。
sortorder string (必填)传递给脚本的命令行参数顺序。
value string 脚本参数值。

另请参阅:Media type object(请参考名称匹配的相关属性)。

Webhook

以下附加元素仅针对Webhook媒介类型导出。

元素 类型 说明
script string 脚本。
timeout string JavaScript脚本HTTP请求超时时间间隔。
可能的值:1 1-60秒(默认:30秒)。
process_tags string 是否处理返回的标签。
可能的值:1 否(0,默认),是(1)。
show_event_menu string 如果在event_menu_urlevent_menu_name字段中成功解析了{EVENT.TAGS.*}宏,则表示事件菜单中存在一个条目。
可能的值:1 否(0,默认),是(1)。
event_menu_url string 事件菜单条目的URL。支持{EVENT.TAGS.*}宏。
event_menu_name string 事件菜单条目的名称。支持{EVENT.TAGS.*}宏。
parameters Webhook媒介类型参数的根元素。
名称 string (必填)Webhook参数名称。
string Webhook参数值。

另请参阅:Media type object(请参考具有匹配名称的相关属性)。

脚注

^ 1 ^ API integer 括号中的值,例如 ENABLED (0),仅为参考。 如需更多信息,请参见表格条目中的相关 API object 页面链接或每个章节末尾的链接。