媒介类型是与所有相关对象和对象关系一起导出的。
导出媒体类型,请执行以下操作:
根据选择的格式,媒体类型被导出到一个默认名称的本地文件:
导入媒介类型步骤如下:
导入规则:
规则 | 描述 |
---|---|
Update existing | 从导入文件中获取的数据更新。否则它们将不会被更新。 |
Create new | 文件中的数据添加新元素。否则将不会添加它们。 |
导入成功或失败的消息将在前端页面上显示。
以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 | (必需)媒体类型使用的传输方式。 可能的取值:1EMAIL(0),SMS(1),SCRIPT(2),WEBHOOK(4)。 |
|
status | string | 媒体类型是否启用。 可能的取值:1ENABLED(0,默认),DISABLED(1)。 |
|
max_sessions | integer | 可以并行处理的最大警报数。 SMS的可能取值:11(默认)。 其他媒体类型的可能取值:10-100(其中0表示无限制)。 |
|
attempts | integer | 发送警报的最大尝试次数。 可能的取值:11-10(默认为3)。 |
|
attempt_interval | string | 重试尝试之间的间隔(使用秒或时间后缀)。 可能的取值:10-60s(默认为10s)。 |
|
description | string | 媒体类型描述。 | |
message_templates | 用于媒体类型消息模板的根元素。 | ||
event_source | string | (必需)事件来源。 可能的取值:1TRIGGERS(0),DISCOVERY(1),AUTOREGISTRATION(2),INTERNAL(3),SERVICE(4)。 |
|
operation_mode | string | 操作模式。 可能的取值:1PROBLEM(0),RECOVERY(1),UPDATE(2)。 |
|
subject | string | 消息主题。 | |
message | string | 消息正文。 |
另请参阅:媒体类型对象(查看相关属性与匹配名称)。
以下附加元素仅针对Email媒体类型进行导出。
元素 | 类型 | 描述 | |
---|---|---|---|
provider | string | 邮件提供商。 | |
smtp_server | string | SMTP服务器。 | |
smtp_port | integer | 连接的SMTP服务器端口。 默认值:25。 |
|
smtp_helo | string | SMTP的HELO参数。 | |
smtp_email | string | 用于发送通知的电子邮件地址。 | |
smtp_security | string | 要使用的SMTP连接安全级别。 可能的取值:1NONE(0,默认),STARTTLS(1),SSL_OR_TLS(2)。 |
|
smtp_verify_host | string | SMTP的SSL主机验证。 可能的取值:1NO(0,默认),YES(1)。 |
|
smtp_verify_peer | string | SMTP的SSL对等验证。 可能的取值:1NO(0,默认),YES(1)。 |
|
smtp_authentication | string | 要使用的SMTP认证方法。 可能的取值:1NONE(0,默认),PASSWORD(1)。 |
|
username | string | 用户名。 | |
password | string | 认证密码。 | |
message_format | string | 消息格式。 可能的取值:1TEXT(0),HTML(1,默认)。 |
另请参阅:媒体类型对象(查看相关属性与匹配名称)。
SMS
以下附加元素仅针对SMS媒体类型进行导出。
元素 | 类型 | 描述 | |
---|---|---|---|
gsm_modem | string | (必需)GSM模块的串行设备名称。 |
另请参阅:媒体类型对象(查看相关属性与匹配名称)。
脚本
以下附加元素仅针对脚本媒体类型进行导出。
元素 | 类型 | 描述 | |
---|---|---|---|
scriptname | string | (必需)脚本名称。 | |
parameters | 脚本参数的根元素。 | ||
sortorder | string | (必需)传递给脚本的参数的排序顺序。 | |
value | string | 脚本参数的值。 |
另请参阅:媒体类型对象(查看相关属性与匹配名称)。
Webhook
以下附加元素仅针对Webhook媒体类型进行导出。
元素 | 类型 | 描述 | |
---|---|---|---|
script | string | 脚本。 | |
timeout | string | JavaScript脚本HTTP请求超时时间间隔。 可能的值:11-60s(默认为30s)。 |
|
process_tags | string | 是否处理返回的标签。 可能的值:1NO(0,默认),YES(1)。 |
|
show_event_menu | string | 如果在event_menu_url 和event_menu_name 字段中成功解析了{EVENT.TAGS.*}宏,则指示事件菜单中存在条目。可能的值:1NO(0,默认),YES(1)。 |
|
event_menu_url | string | 事件菜单条目的URL。支持{EVENT.TAGS.*}宏。 | |
event_menu_name | string | 事件菜单条目的名称。支持{EVENT.TAGS.*}宏。 | |
parameters | Webhook媒体类型参数的根元素。 | ||
name | string | (必需)Webhook参数的名称。 | |
value | string | Webhook参数的值。 |
另请参阅:媒体类型对象(查看相关属性与匹配名称)。
1 API 中的整数值在括号中,例如,ENABLED (0),仅供参考。 有关更多信息,请参阅表中每个条目的链接 API 对象页面或各节末尾。