6 媒介类型

概述

媒介类型是与所有相关对象和对象关系一起导出的。

导出时

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

  • 前往: Administration → Media types
  • 标记要导出的媒介类型的复选框
  • 点击列表下面的导出

6 媒介类型 - 图1

根据选择的格式，媒体类型被导出到一个默认名称的本地文件:

  • zabbix_export_mediatypes.yaml - 以YAML文件格式进行导出(导出的默认选项)
  • zabbix_export_mediatypes.xml - 以XML文件格式进行导出
  • zabbix_export_mediatypes.json - 以JSON文件格式进行导出

导入时

导入媒介类型步骤如下：

  • 前往: Administration → Media types
  • 点击右边的导入
  • 选择要导入的文件
  • 在导入规则中标记所需的选项
  • 点击 导入

6 媒介类型 - 图2

导入规则:

规则描述
Update existing从导入文件中获取的数据更新。否则它们将不会被更新。
Create new文件中的数据添加新元素。否则将不会添加它们。

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

导出格式

以YAML文件格式导出:

  1. zabbix_export:
  2.          version: '7.0'
  3.          media_types:
  4.            - name: Pushover
  5.              type: WEBHOOK
  6.              parameters:
  7.                - name: endpoint
  8.                  value: 'https://api.pushover.net/1/messages.json'
  9.                - name: eventid
  10.                  value: '{EVENT.ID}'
  11.                - name: event_nseverity
  12.                  value: '{EVENT.NSEVERITY}'
  13.                - name: event_source
  14.                  value: '{EVENT.SOURCE}'
  15.                - name: event_value
  16.                  value: '{EVENT.VALUE}'
  17.                - name: expire
  18.                  value: '1200'
  19.                - name: message
  20.                  value: '{ALERT.MESSAGE}'
  21.                - name: priority_average
  22.                  value: '0'
  23.                - name: priority_default
  24.                  value: '0'
  25.                - name: priority_disaster
  26.                  value: '0'
  27.                - name: priority_high
  28.                  value: '0'
  29.                - name: priority_information
  30.                  value: '0'
  31.                - name: priority_not_classified
  32.                  value: '0'
  33.                - name: priority_warning
  34.                  value: '0'
  35.                - name: retry
  36.                  value: '60'
  37.                - name: title
  38.                  value: '{ALERT.SUBJECT}'
  39.                - name: token
  40.                  value: '<PUSHOVER TOKEN HERE>'
  41.                - name: triggerid
  42.                  value: '{TRIGGER.ID}'
  43.                - name: url
  44.                  value: '{$ZABBIX.URL}'
  45.                - name: url_title
  46.                  value: Zabbix
  47.                - name: user
  48.                  value: '{ALERT.SENDTO}'
  49.              status: DISABLED
  50.              max_sessions: '0'
  51.              script: |
  52.                try {
  53.                    var params = JSON.parse(value),
  54.                        request = new HttpRequest(),
  55.                        data,
  56.                        response,
  57.                        severities = [
  58.                            {name: 'not_classified', color: '#97AAB3'},
  59.                            {name: 'information', color: '#7499FF'},
  60.                            {name: 'warning', color: '#FFC859'},
  61.                            {name: 'average', color: '#FFA059'},
  62.                            {name: 'high', color: '#E97659'},
  63.                            {name: 'disaster', color: '#E45959'},
  64.                            {name: 'resolved', color: '#009900'},
  65.                            {name: 'default', color: '#000000'}
  66.                        ],
  67.                        priority;
  69.                    if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
  70.                        request.setProxy(params.HTTPProxy);
  71.                    }
  73.                    if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) {
  74.                        throw 'Incorrect "event_source" parameter given: "' + params.event_source + '".\nMust be 0-3.';
  75.                    }
  77.                    if (params.event_value !== '0' && params.event_value !== '1'
  78.                        && (params.event_source === '0' || params.event_source === '3')) {
  79.                        throw 'Incorrect "event_value" parameter given: ' + params.event_value + '\nMust be 0 or 1.';
  80.                    }
  82.                    if ([0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity)) === -1) {
  83.                        params.event_nseverity = '7';
  84.                    }
  86.                    if (params.event_value === '0') {
  87.                        params.event_nseverity = '6';
  88.                    }
  90.                    priority = params['priority_' + severities[params.event_nseverity].name] || params.priority_default;
  92.                    if (isNaN(priority) || priority < -2 || priority > 2) {
  93.                        throw '"priority" should be -2..2';
  94.                    }
  96.                    if (params.event_source === '0' && isNaN(params.triggerid)) {
  97.                        throw 'field "triggerid" is not a number';
  98.                    }
  100.                    if (isNaN(params.eventid)) {
  101.                        throw 'field "eventid" is not a number';
  102.                    }
  104.                    if (typeof params.message !== 'string' || params.message.trim() === '') {
  105.                        throw 'field "message" cannot be empty';
  106.                    }
  108.                    data = {
  109.                        token: params.token,
  110.                        user: params.user,
  111.                        title: params.title,
  112.                        message: params.message,
  113.                        url: (params.event_source === '0') 
  114.                            ? params.url + '/tr_events.php?triggerid=' + params.triggerid + '&eventid=' + params.eventid
  115.                            : params.url,
  116.                        url_title: params.url_title,
  117.                        priority: priority
  118.                    };
  120.                    if (priority == 2) {
  121.                        if (isNaN(params.retry) || params.retry < 30) {
  122.                            throw 'field "retry" should be a number with value of at least 30 if "priority" is set to 2';
  123.                        }
  125.                        if (isNaN(params.expire) || params.expire > 10800) {
  126.                            throw 'field "expire" should be a number with value of at most 10800 if "priority" is set to 2';
  127.                        }
  129.                        data.retry = params.retry;
  130.                        data.expire = params.expire;
  131.                    }
  133.                    data = JSON.stringify(data);
  134.                    Zabbix.log(4, '[ Pushover Webhook ] Sending request: ' + params.endpoint + '\n' + data);
  136.                    request.addHeader('Content-Type: application/json');
  137.                    response = request.post(params.endpoint, data);
  139.                    Zabbix.log(4, '[ Pushover Webhook ] Received response with status code ' + request.getStatus() + '\n' + response);
  141.                    if (response !== null) {
  142.                        try {
  143.                            response = JSON.parse(response);
  144.                        }
  145.                        catch (error) {
  146.                            Zabbix.log(4, '[ Pushover Webhook ] Failed to parse response received from Pushover');
  147.                            response = null;
  148.                        }
  149.                    }
  151.                    if (request.getStatus() != 200 || response === null || typeof response !== 'object' || response.status !== 1) {
  152.                        if (response !== null && typeof response === 'object' && typeof response.errors === 'object'
  153.                                && typeof response.errors[0] === 'string') {
  154.                            throw response.errors[0];
  155.                        }
  156.                        else {
  157.                            throw 'Unknown error. Check debug log for more information.';
  158.                        }
  159.                    }
  161.                    return 'OK';
  162.                }
  163.                catch (error) {
  164.                    Zabbix.log(4, '[ Pushover Webhook ] Pushover notification failed: ' + error);
  165.                    throw 'Pushover notification failed: ' + error;
  166.                }
  167.              description: |
  168.                Please refer to setup guide here: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/pushover
  170.                Set token parameter with to your Pushover application key.
  171.                When assigning Pushover media to the Zabbix user - add user key into send to field.
  172.              message_templates:
  173.                - event_source: TRIGGERS
  174.                  operation_mode: PROBLEM
  175.                  subject: 'Problem: {EVENT.NAME}'
  176.                  message: |
  177.                    Problem started at {EVENT.TIME} on {EVENT.DATE}
  178.                    Problem name: {EVENT.NAME}
  179.                    Host: {HOST.NAME}
  180.                    Severity: {EVENT.SEVERITY}
  181.                    Operational data: {EVENT.OPDATA}
  182.                    Original problem ID: {EVENT.ID}
  183.                    {TRIGGER.URL}
  184.                - event_source: TRIGGERS
  185.                  operation_mode: RECOVERY
  186.                  subject: 'Resolved in {EVENT.DURATION}: {EVENT.NAME}'
  187.                  message: |
  188.                    Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
  189.                    Problem name: {EVENT.NAME}
  190.                    Problem duration: {EVENT.DURATION}
  191.                    Host: {HOST.NAME}
  192.                    Severity: {EVENT.SEVERITY}
  193.                    Original problem ID: {EVENT.ID}
  194.                    {TRIGGER.URL}
  195.                - event_source: TRIGGERS
  196.                  operation_mode: UPDATE
  197.                  subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
  198.                  message: |
  199.                    {USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
  200.                    {EVENT.UPDATE.MESSAGE}
  202.                    Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
  203.                - event_source: DISCOVERY
  204.                  operation_mode: PROBLEM
  205.                  subject: 'Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
  206.                  message: |
  207.                    Discovery rule: {DISCOVERY.RULE.NAME}
  209.                    Device IP: {DISCOVERY.DEVICE.IPADDRESS}
  210.                    Device DNS: {DISCOVERY.DEVICE.DNS}
  211.                    Device status: {DISCOVERY.DEVICE.STATUS}
  212.                    Device uptime: {DISCOVERY.DEVICE.UPTIME}
  214.                    Device service name: {DISCOVERY.SERVICE.NAME}
  215.                    Device service port: {DISCOVERY.SERVICE.PORT}
  216.                    Device service status: {DISCOVERY.SERVICE.STATUS}
  217.                    Device service uptime: {DISCOVERY.SERVICE.UPTIME}
  218.                - event_source: AUTOREGISTRATION
  219.                  operation_mode: PROBLEM
  220.                  subject: 'Autoregistration: {HOST.HOST}'
  221.                  message: |
  222.                    Host name: {HOST.HOST}
  223.                    Host IP: {HOST.IP}
  224.                    Agent port: {HOST.PORT}

导出的元素

导出的元素在下表中进行了解释。

元素类型描述
namestring(必需)媒体类型名称。
typestring(必需)媒体类型使用的传输方式。
可能的取值：1EMAIL(0),SMS(1),SCRIPT(2),WEBHOOK(4)。
statusstring媒体类型是否启用。
可能的取值：1ENABLED(0,默认),DISABLED(1)。
max_sessionsinteger可以并行处理的最大警报数。
SMS的可能取值：11(默认)。
其他媒体类型的可能取值：10-100(其中0表示无限制)。
attemptsinteger发送警报的最大尝试次数。
可能的取值：11-10(默认为3)。
attempt_intervalstring重试尝试之间的间隔（使用秒或时间后缀）。
可能的取值：10-60s(默认为10s)。
descriptionstring媒体类型描述。
message_templates用于媒体类型消息模板的根元素。
event_sourcestring(必需)事件来源。
可能的取值：1TRIGGERS(0),DISCOVERY(1),AUTOREGISTRATION(2),INTERNAL(3),SERVICE(4)。
operation_modestring操作模式。
可能的取值：1PROBLEM(0),RECOVERY(1),UPDATE(2)。
subjectstring消息主题。
messagestring消息正文。

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

Email

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

元素类型描述
providerstring邮件提供商。
smtp_serverstringSMTP服务器。
smtp_portinteger连接的SMTP服务器端口。
默认值：25。
smtp_helostringSMTP的HELO参数。
smtp_emailstring用于发送通知的电子邮件地址。
smtp_securitystring要使用的SMTP连接安全级别。
可能的取值：1NONE(0,默认),STARTTLS(1),SSL_OR_TLS(2)。
smtp_verify_hoststringSMTP的SSL主机验证。
可能的取值：1NO(0,默认),YES(1)。
smtp_verify_peerstringSMTP的SSL对等验证。
可能的取值：1NO(0,默认),YES(1)。
smtp_authenticationstring要使用的SMTP认证方法。
可能的取值：1NONE(0,默认),PASSWORD(1)。
usernamestring用户名。
passwordstring认证密码。
message_formatstring消息格式。
可能的取值：1TEXT(0),HTML(1,默认)。

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

SMS

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

元素类型描述
gsm_modemstring(必需)GSM模块的串行设备名称。

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

脚本

以下附加元素仅针对脚本媒体类型进行导出。

元素类型描述
scriptnamestring(必需)脚本名称。
parameters脚本参数的根元素。
sortorderstring(必需)传递给脚本的参数的排序顺序。
valuestring脚本参数的值。

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

Webhook

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

元素类型描述
scriptstring脚本。
timeoutstringJavaScript脚本HTTP请求超时时间间隔。
可能的值：11-60s（默认为30s）。
process_tagsstring是否处理返回的标签。
可能的值：1NO(0,默认),YES(1)。
show_event_menustring如果在event_menu_url和event_menu_name字段中成功解析了{EVENT.TAGS.}宏，则指示事件菜单中存在条目。
可能的值：1NO(0,默认),YES(1)。
event_menu_urlstring事件菜单条目的URL。支持{EVENT.TAGS.}宏。
event_menu_namestring事件菜单条目的名称。支持{EVENT.TAGS.*}宏。
parametersWebhook媒体类型参数的根元素。
namestring(必需)Webhook参数的名称。
valuestringWebhook参数的值。

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

附注

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