5 媒介类型

概述

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

导出时

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

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

5 媒介类型 - 图1

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

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

导入时

导入媒介类型步骤如下:

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

5 媒介类型 - 图2

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

导入规则:

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

导出格式

导出到YAML:

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

元素标签

下表解释了元素标签值。

元素元素属性是否必须类型适用范围1描述
media_types-媒体类型的根元素。
namexstring媒介类型的名称。
typexstring0 - EMAIL
1 - SMS
2 - SCRIPT
4 - WEBHOOK
媒体类型所使用的数据传输方式。
status-string0 - ENABLED (默认)
1 - DISABLED
是否启用媒体类型。
max_sessions-integerPossible values for SMS: 1 - (默认)

其他媒体类型的可能值:0- 100,0 - unlimited
可并行处理的警报的最大数量。
attempts-integer1-10 (默认: 3)发送警报的最大尝试次数。
attempt_interval-string0-60s (默认: 10s)重试间隔时间。

接受带后缀的秒和时间单位。
description-string媒体类型描述。
message_templates-媒体类型消息模板的根元素。
event_sourcexstring0 - TRIGGERS
1 - DISCOVERY
2 - AUTOREGISTRATION
3 - INTERNAL
事件源。
operation_modexstring0 - PROBLEM
1 - RECOVERY
2 - UPDATE
操作模式。
subject-string信息主题。
message-string信息主体。
仅用于 e-mail 媒介类型
smtp_serverxstringSMTP 服务。
smtp_port-integer默认: 25SMTP服务器连接的端口。
smtp_heloxstringSMTP helo。
smtp_emailxstring将发送通知的电子邮件地址。
smtp_security-string0 - NONE (默认)
1 - STARTTLS
2 - SSL_OR_TLS
要使用的SMTP连接安全级别。
smtp_verify_host-string0 - NO (默认)
1 - YES
SSL验证SMTP主机。 如果smtp_security为STARTTLS或SSL_OR_TLS,可选。
smtp_verify_peer-string0 - NO (默认)
1 - YES
SSL验证peer SMTP。 如果smtp_security为STARTTLS或SSL_OR_TLS,可选。
smtp_authentication-string0 - NONE (默认)
1 - PASSWORD
SMTP身份验证方法使用。
username-string用户名。
password-string认证密码。
content_type-string0 - TEXT
1 - HTML (默认)
信息格式。
仅 SMS 媒介类型使用
gsm_modemxstringGSM modem的序列号。
仅脚本媒介类型使用
script namexstring脚本名称。
parameters-脚本参数的根元素。
仅webhook 媒介类型使用
scriptxstring脚本。
timeout-string1-60s (默认: 30s)Javascript 脚本 HTTP 请求超时间隔。
process_tags-string0 - NO (默认)
1 - YES
是否处理返回的标签。
show_event_menu-string0 - NO (默认)
1 - YES
如果{EVENT.TAGS.}在事件_menu_url和事件_menu_name字段中成功解析了,该字段表示在事件菜单中存在条目。
event_menu_url-string事件菜单入口的URL。支持{EVENT.TAGS.} 宏。
event_menu_name-string事件菜单项的名称。支持{EVENT.TAGS.*} 宏。
parameters-webhook媒体类型参数的根元素。
namexstringWebhook参数名称。
value-stringWebhook参数值。
附注

1 对于字符串值,只有字符串将被导出(例如“EMAIL”),而不使用该表中使用的编号。 该表中的范围值(对应于API值)的编号仅用于排序。