配置系统事件通知

本节介绍如何配置 NetQ 以通过第三方应用程序（例如 syslog、PagerDuty、Slack、电子邮件或通用 webhook 渠道）发送事件通知。NetQ 可以为系统和阈值交叉事件生成通知，或根据预定义的规则键集生成通知。

您可以实施一个代理服务器（位于 NetQ 设备或 VM 与集成渠道之间），该服务器接收、处理和分发通知，而不是直接将通知发送到集成渠道。如果您使用此类代理，则必须使用代理信息配置 NetQ。

事件消息格式

消息具有以下结构：<message-type><timestamp><opid><hostname><severity><message>

元素	描述
消息类型	事件类别
时间戳	事件发生的日期和时间
opid	生成事件的服务或进程的标识符
主机名	发生事件的网络设备的主机名
严重性	严重性分类：错误或信息
消息	事件的文本描述

例如

要设置集成，您必须使用至少一个通道、一个规则和一个过滤器配置 NetQ。要细化您想要查看的消息以及要将消息发送到何处，您可以添加其他规则和过滤器，并在支持的事件类型上设置阈值。您还可以配置代理服务器来接收、处理和转发消息。这是按以下顺序完成的

配置基本 NetQ 事件通知

您可以创建的最简单配置是将所有接口生成的所有事件发送到单个通知应用程序的配置。通知配置必须包含一个通道、一个规则和一个过滤器。配置的创建遵循相同的路径

创建一个通道。
创建一个接受选定事件集的规则。
创建一个将此规则与新创建的通道关联的过滤器。

创建通道

第一步是创建一个 Slack、PagerDuty、syslog、电子邮件或通用通道来接收通知。

Slack

NetQ UI

展开菜单，然后选择 通知通道。
默认情况下显示 Slack 选项卡。
添加通道。
- 当未指定任何通道时，单击 添加 Slack 通道。
- 当至少指定一个通道时，单击表上方的添加。
为通道提供唯一的名称。请注意，不允许使用空格——请改用破折号或 camelCase。
按照 Slack 文档中的描述创建传入 webhook。然后在Webhook URL 字段中复制并粘贴它。
（可选）选择切换开关以将所有通知发送到此通道。
单击添加。
（可选）要验证通道配置，请单击测试。

NetQ CLI

要创建和验证 Slack 通道，请运行

netq add notification channel slack <text-channel-name> webhook <text-webhook-url> [severity info|severity error] [tag <text-slack-tag>] [default]
netq show notification channel [json]

选项	描述
<text-channel-name>	用户指定的 Slack 通道名称
webhook <text-webhook-url>	所需通道的 WebHook URL。例如：https://hooks.slack.com/services/text/moretext/evenmoretext
severity <level>	日志级别，info 或 error。如果未指定，则严重性默认为 info。
tag <text-slack-tag>	附加到 Slack 通知的可选标记，用于突出显示特定通道或人员。@ 符号必须位于标记值之前。例如，@netq-info。
default	将通道设置为默认通道，并将所有通知发送到此通道

以下示例显示了 slk-netq-events 通道的创建并验证了配置。

按照您的 Slack 版本文档中的描述创建传入 webhook。

创建通道。

cumulus@switch:~$ netq add notification channel slack slk-netq-events webhook https://hooks.slack.com/services/text/moretext/evenmoretext
Successfully added/updated channel slk-netq-events

验证配置。

cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity Channel Info               Is Default
--------------- ---------------- -------- -------------------------- ------------
slk-netq-events slack            info     webhook:https://hooks.s    False
                                            lack.com/services/text/ 
                                            moretext/evenmoretext.

PagerDuty

NetQ UI

展开菜单，然后选择 通知通道。
单击 PagerDuty。
添加通道。
- 当未指定任何通道时，单击 添加 PagerDuty 通道。
- 当至少指定一个通道时，单击表上方的添加。
为通道提供唯一的名称。请注意，不允许使用空格。请改用破折号或 camelCase。
获取并输入集成密钥（也称为服务密钥或路由密钥）。
（可选）选择切换开关以将所有通知发送到此通道。
单击添加。
（可选）要验证通道配置，请单击测试。

NetQ CLI

要创建和验证 PagerDuty 通道，请运行

netq add notification channel pagerduty <text-channel-name> integration-key <text-integration-key> [severity info|severity error] [default]
netq show notification channel [json]

选项	描述
<text-channel-name>	用户指定的 PagerDuty 通道名称
integration-key <text-integration-key>	集成密钥也称为 service_key 或 routing_key。默认值为空字符串 ("")。
severity <level>	日志级别，info 或 error。如果未指定，则严重性默认为 info。
default	将通道设置为默认通道，并将所有通知发送到此通道

以下示例显示了 *pd-netq-events* 通道的创建并验证了配置。

按照此 PagerDuty 支持页面中的描述获取集成密钥。

创建通道。

cumulus@switch:~$ netq add notification channel pagerduty pd-netq-events integration-key c6d666e210a8425298ef7abde0d1998
Successfully added/updated channel pd-netq-events

验证配置。

cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity         Channel Info              Is Default
--------------- ---------------- ---------------- ------------------------  ------------
pd-netq-events  pagerduty        info             integration-key: c6d666e  False
                                                210a8425298ef7abde0d1998

Syslog

NetQ UI

展开菜单，然后选择 通知通道。
单击 Syslog。
添加通道。
- 当未指定任何通道时，单击 添加 syslog 通道。
- 当至少指定一个通道时，单击表上方的添加。
为通道提供唯一的名称。请注意，不允许使用空格。请改用破折号或 camelCase。
输入 syslog 服务器的 IP 地址和端口。
（可选）选择切换开关以将所有通知发送到此通道。
单击添加。
（可选）要验证通道配置，请单击测试。

NetQ CLI

要创建和验证 syslog 通道，请运行

netq add notification channel syslog <text-channel-name> hostname <text-syslog-hostname> port <text-syslog-port> [severity info | severity error] [default]
netq show notification channel [json]

选项	描述
<text-channel-name>	用户指定的 syslog 通道名称
hostname <text-syslog-hostname>	接收通知的 syslog 服务器的主机名或 IP 地址
port <text-syslog-port>	syslog 服务器上接收通知的端口
severity <level>	日志级别，info 或 error。如果未指定，则严重性默认为 info。
default	将通道设置为默认通道，并将所有通知发送到此通道

以下示例显示了 syslog-netq-events 通道的创建并验证了配置。

获取 syslog 服务器主机名（或 IP 地址）和端口。

创建通道。

cumulus@switch:~$ netq add notification channel syslog syslog-netq-events hostname syslog-server port 514
Successfully added/updated channel syslog-netq-events

验证配置。

cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity Channel Info           Is Default
--------------- ---------------- -------- ---------------------- ------------
syslog-netq-eve syslog            info     host:syslog-server    False
nts                                        port: 514

电子邮件

NetQ UI

展开菜单，然后选择 通知通道。
单击 电子邮件。
添加通道。
- 当未指定任何通道时，单击 添加电子邮件通道。
- 当至少指定一个通道时，单击表上方的添加。
为通道提供唯一的名称。请注意，不允许使用空格。请改用破折号或 camelCase。
输入收件人电子邮件地址列表，以逗号分隔，且不带空格。例如：user1@domain.com,user2@domain.com,user3@domain.com
（可选）选择切换开关以将所有通知发送到此通道。
首次配置电子邮件通道时，您还必须指定 SMTP 服务器信息
- 主机：SMTP 服务器的主机名或 IP 地址
- 端口：SMTP 服务器的端口（通常为 587）
- 用户 ID/密码：您的管理凭据
- 发件人：指示谁发送通知的电子邮件地址
在初始设置之后，您创建的任何其他电子邮件通道都可以通过单击现有来使用此配置。
单击添加。
（可选）要验证通道配置，请单击测试。

NetQ CLI

要创建和验证电子邮件通道的规范，请运行

netq add notification channel email <text-channel-name> to <text-email-toids> [smtpserver <text-email-hostname>] [smtpport <text-email-port>] [login <text-email-id>] [password <text-email-password>] [severity info | severity error] [default]
netq add notification channel email <text-channel-name> to <text-email-toids> [default]
netq show notification channel [json]

配置因您使用的是 NetQ 的本地部署版本还是云版本而异。请勿为云部署配置 SMTP，因为 NetQ 云服务使用 NetQ SMTP 服务器推送电子邮件通知。

对于本地部署

设置 SMTP 服务器。服务器可以是内部服务器或公共服务器。
在 SMTP 服务器上创建一个用户帐户（登录名和密码）。NetQ 将通知发送到此地址。

使用以下命令创建通知通道

netq add notification channel email <text-channel-name> to <text-email-toids>  [smtpserver <text-email-hostname>] [smtpport <text-email-port>] [login <text-email-id>] [password <text-email-password>] [severity info | severity error] [default]

例如

cumulus@switch:~$ netq add notification channel email onprem-email to netq-notifications@domain.com smtpserver smtp.domain.com smtpport 587 login smtphostlogin@domain.com password MyPassword123
Successfully added/updated channel onprem-email

验证配置。

cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity         Channel Info             Is Default
--------------- ---------------- ---------------- ------------------------ ---------------
onprem-email    email            info             password: MyPassword123, False
                                                  port: 587,
                                                  isEncrypted: True,
                                                  host: smtp.domain.com,
                                                  from: smtphostlogin@doma
                                                  in.com,
                                                  id: smtphostlogin@domain
                                                  .com,
                                                  to: netq-notifications@d
                                                  omain.com

对于云部署

使用以下命令创建通知通道

netq add notification channel email <text-channel-name> to <text-email-toids>

例如

cumulus@switch:~$ netq add notification channel email cloud-email to netq-cloud-notifications@domain.com
Successfully added/updated channel cloud-email

验证配置。

cumulus@switch:~$ netq show notification channel Matching config_notify records: Name Type Severity Channel Info Is Default --------------- ---------------- ---------------- ------------------------ -------------- cloud-email email info password: TEiO98BOwlekUP False TrFev2/Q==, port: 587, isEncrypted: True, host: netqsmtp.domain.com, from: netqsmtphostlogin@doma in.com, id: smtphostlogin@domain .com, to: netq-notifications@d omain.com

通用

NetQ UI

单击菜单，然后单击 通知通道。
单击通用。
添加通道。
- 当未指定任何通道时，单击 添加通用通道。
- 当至少指定一个通道时，单击表上方的添加。
为通道提供唯一的名称。请注意，不允许使用空格。请改用破折号或 camelCase。
指定 webhook URL。
为此通道设置所需的通知严重性、SSL 和身份验证参数。
（可选）选择切换开关以将所有通知发送到此通道。
单击添加。
（可选）要验证通道配置，请单击测试。

NetQ CLI

要创建和验证通用通道，请运行

netq add notification channel generic <text-channel-name> webhook <text-webhook-url> [severity info | severity error ] [use-ssl True | use-ssl False] [auth-type basic-auth generic-username <text-generic-username> generic-password <text-generic-password> | auth-type api-key key-name <text-api-key-name> key-value <text-api-key-value>] [default]
netq show notification channel [json]

选项	描述
<text-channel-name>	用户指定的通用通道名称
webhook <text-webhook-url>	接收通知的远程应用程序的 URL
severity <level>	日志级别，info 或 error。如果未指定，则严重性默认为 info。
use-ssl [True \| False]	启用或禁用 SSL
auth-type [basic-auth \| api-key]	设置身份验证参数。使用 basic-auth 以及 generic-username 和 generic-password 或使用 api-key 以及 key-name 和 key-value
default	将通道设置为默认通道，并将所有通知发送到此通道

创建规则

第二步是创建和验证接受一组事件的规则。您可以使用 NetQ CLI 为系统事件创建规则。

要创建和验证规则，请运行

netq add notification rule <text-rule-name> key <text-rule-key> value <text-rule-value>
netq show notification rule [json]

有关可用键和值的列表，请参阅规则键和值参考。

要删除通知规则，请运行

netq del notification rule <text-rule-name-anchor>

▼ 规则示例

此示例创建一个名为 all-interfaces 的规则，使用键 ifname 和值 ALL，这将来自所有接口的所有事件发送到具有此规则的任何通道。

cumulus@switch:~$ netq add notification rule all-interfaces key ifname value ALL
Successfully added/updated rule all-ifs

cumulus@switch:~$ netq show notification rule
Matching config_notify records:
Name            Rule Key         Rule Value
--------------- ---------------- --------------------
all-interfaces  ifname           ALL

基于主机名创建 BGP 规则

cumulus@switch:~$ netq add notification rule bgpHostname key hostname value spine-01
Successfully added/updated rule bgpHostname

基于配置文件状态更改创建规则

cumulus@switch:~$ netq add notification rule sysconf key configdiff value updated
Successfully added/updated rule sysconf

基于 VNI 创建 EVPN 规则

cumulus@switch:~$ netq add notification rule evpnVni key vni value 42
Successfully added/updated rule evpnVni

基于 FEC 支持创建接口规则

cumulus@switch:~$ netq add notification rule fecSupport key new_supported_fec value supported
Successfully added/updated rule fecSupport

基于状态更改创建服务规则

cumulus@switch:~$ netq add notification rule svcStatus key new_status value down
Successfully added/updated rule svcStatus

基于阈值创建传感器规则

cumulus@switch:~$ netq add notification rule overTemp key new_s_crit value 24
Successfully added/updated rule overTemp

基于端口创建接口规则

cumulus@switch:~$ netq add notification rule swp52 key port value swp52
Successfully added/updated rule swp52

创建过滤器

最后一步是创建一个过滤器，将规则与通道关联起来。您可以使用 NetQ CLI 为系统事件创建过滤器。

要创建和验证过滤器，请运行

netq add notification filter <text-filter-name> rule <text-rule-name-anchor> channel <text-channel-name-anchor>
netq show notification filter [json]

这些示例使用在前面部分中创建的通道和规则。创建此过滤器后，NetQ 会将所有接口事件发送到您指定的通道。

PagerDuty

cumulus@switch:~$ netq add notification filter notify-all-ifs rule all-interfaces channel pd-netq-events
Successfully added/updated filter notify-all-ifs

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
notify-all-ifs  1          info             pd-netq-events   all-interfaces

Slack

cumulus@switch:~$ netq add notification filter notify-all-ifs rule all-interfaces channel slk-netq-events
Successfully added/updated filter notify-all-ifs

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
notify-all-ifs  1          info             slk-netq-events   all-interfaces

Syslog

cumulus@switch:~$ netq add notification filter notify-all-ifs rule all-interfaces channel syslog-netq-events
Successfully added/updated filter notify-all-ifs

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
notify-all-ifs  1          info             syslog-netq-events all-ifs

电子邮件

cumulus@switch:~$ netq add notification filter notify-all-ifs rule all-interfaces channel onprem-email
Successfully added/updated filter notify-all-ifs

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
notify-all-ifs  1          info             onprem-email all-ifs

▼ 其他过滤器示例

为特定设备上的 BGP 事件创建过滤器

cumulus@switch:~$ netq add notification filter bgpSpine rule bgpHostname channel pd-netq-events
Successfully added/updated filter bgpSpine

为您的 EVPN 叠加网络中的给定 VNI 创建过滤器

cumulus@switch:~$ netq add notification filter vni42 severity warning rule evpnVni channel pd-netq-events
Successfully added/updated filter vni42

为配置文件更新时创建过滤器

cumulus@switch:~$ netq add notification filter configChange severity info rule sysconf channel slk-netq-events
Successfully added/updated filter configChange

创建过滤器以监控具有 FEC 支持的端口

cumulus@switch:~$ netq add notification filter newFEC rule fecSupport channel slk-netq-events
Successfully added/updated filter newFEC

创建过滤器以监控更改为关闭状态的服务

cumulus@switch:~$ netq add notification filter svcDown severity error rule svcStatus channel slk-netq-events
Successfully added/updated filter svcDown

创建过滤器以监控过热平台

cumulus@switch:~$ netq add notification filter critTemp severity error rule overTemp channel onprem-email
Successfully added/updated filter critTemp

创建过滤器以删除来自给定接口的消息，并在任何其他过滤器之前与此过滤器匹配。要创建删除样式过滤器，请勿指定通道。要首先列出过滤器，请使用 before 选项。

cumulus@switch:~$ netq add notification filter swp52Drop severity error rule swp52 before bgpSpine
Successfully added/updated filter swp52Drop

过滤器名称可以包含空格，但必须用单引号括起来。最好使用破折号代替空格或混合大小写以提高可读性。例如，使用 bgpSessionChanges 或 BGP-session-changes 或 BGPsessions，而不是 'BGP Session Changes'。过滤器名称也区分大小写。

当您创建过滤器时，它们会被添加到过滤器列表的底部。默认情况下，NetQ 会针对过滤器列表顶部的过滤器处理事件消息，并向下处理，直到找到匹配项。NetQ 应用与事件消息匹配的第一个过滤器，忽略其他过滤器。然后，它移动到下一个事件消息并重新运行该过程，从过滤器列表的顶部开始。NetQ 忽略与任何过滤器都不匹配的事件。

您可能必须更改过滤器在列表中的顺序，以确保捕获所需的事件并删除不需要的事件。这可以使用 before 或 after 关键字来实现，以确保在一个规则之前或之后处理另一个规则。

要删除通知过滤器，请运行

netq del notification filter <text-filter-name-anchor>

删除通道

如果通道不是现有通知配置的一部分，则可以删除它们。

NetQ UI

要删除通知通道

展开菜单，然后选择 通知通道。
选择要删除的通道类型的选项卡。
选择一个或多个通道。
单击删除。

NetQ CLI

要删除通知通道，请运行

netq del notification channel <text-channel-name-anchor>

此示例删除 Slack 集成并验证它是否不再在配置中

cumulus@switch:~$ netq del notification channel slk-netq-events

cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity         Channel Info
--------------- ---------------- ---------------- ------------------------
pd-netq-events  pagerduty        info             integration-key: 1234567
                                                    890

配置代理服务器

要通过代理服务器发送通知消息，而不是直接发送到通知通道，请使用代理服务器的主机名（可选）和端口配置 NetQ。如果您未指定端口，则 NetQ 默认为端口 80。NetQ 支持一个代理服务器。为了简化部署，请在配置通道、规则或过滤器之前配置代理服务器。

要配置和验证代理服务器，请运行

netq add notification proxy <text-proxy-hostname> [port <text-proxy-port>]
netq show notification proxy

此示例配置并验证端口 80 上的 proxy4 服务器充当事件通知的代理。

cumulus@switch:~$ netq add notification proxy proxy4
Successfully configured notifier proxy proxy4:80

cumulus@switch:~$ netq show notification proxy
Matching config_notify records:
Proxy URL          Slack Enabled              PagerDuty Enabled
------------------ -------------------------- ----------------------------------
proxy4:80          yes                        yes

您可以使用 netq del notification proxy 删除代理服务器。这会将 NetQ 行为更改为直接将事件发送到通知通道。

规则键和值参考

单个键值对构成每个规则。键值对指示要包含在发送到通知通道的事件信息中或从中删除的消息。您可以为单个过滤器创建多个规则。为给定过滤器创建多个规则可以提供非常明确的过滤器。例如，您可以围绕主机名或接口名称指定规则，从而允许您过滤特定于这些主机或接口的消息。只有在设置通知通道后，才能创建规则。

NetQ 包括一组预定义的固定有效规则键。您以正则表达式形式输入值，这些值因您的部署而异。

服务	规则键	描述	规则值示例
BGP	message_type	网络协议或服务标识符	bgp
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf11、exit01、spine-4
	peer	用户定义的、基于文本的对等交换机或主机名称	server4、leaf-3、exit02、spine06
	desc	文本描述
	vrf	VRF 接口的名称	mgmt、default
	old_state	BGP 服务的先前状态	已建立、失败
	new_state	BGP 服务的当前状态	已建立、失败
	old_last_reset_time	BGP 服务上次重置的先前时间	2019 年 4 月 3 日下午 4:17
	new_last_reset_time	BGP 服务上次重置的最新时间	2019 年 4 月 8 日上午 11:38
ConfigDiff	message_type	网络协议或服务标识符	configdiff
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf11、exit01、spine-4
	vni	虚拟网络实例标识符	12, 23
	old_state	配置文件的先前状态	已创建、已修改
	new_state	配置文件的当前状态	已创建、已修改
EVPN	message_type	网络协议或服务标识符	evpn
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf-9、exit01、spine04
	vni	虚拟网络实例标识符	12, 23
	old_in_kernel_state	先前的 VNI 状态，在内核中或不在内核中	true、false
	new_in_kernel_state	当前的 VNI 状态，在内核中或不在内核中	true、false
	old_adv_all_vni_state	先前的 VNI 广告状态，是否广告所有	true、false
	new_adv_all_vni_state	当前的 VNI 广告状态，是否广告所有	true、false
LCM	message_type	网络协议或服务标识符	clag
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf-9、exit01、spine04
	old_conflicted_bonds	冲突绑定中的先前接口对	swp7 swp8、swp3 swp4
	new_conflicted_bonds	冲突绑定中的当前接口对	swp11 swp12、swp23 swp24
	old_state_protodownbond	绑定的先前状态	protodown、up
	new_state_protodownbond	绑定的当前状态	protodown、up
链路	message_type	网络协议或服务标识符	link
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf-6、exit01、spine7
	ifname	软件接口名称	eth0、swp53
LLDP	message_type	网络协议或服务标识符	lldp
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf41、exit01、spine-5、tor-36
	ifname	软件接口名称	eth1、swp12
	old_peer_ifname	先前的软件接口名称	eth1、swp12、swp27
	new_peer_ifname	当前的软件接口名称	eth1、swp12、swp27
	old_peer_hostname	用户定义的、基于文本的对等交换机或主机的先前名称	server02、leaf41、exit01、spine-5、tor-36
	new_peer_hostname	用户定义的、基于文本的对等交换机或主机的当前名称	server02、leaf41、exit01、spine-5、tor-36
MLAG (CLAG)	message_type	网络协议或服务标识符	clag
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf-9、exit01、spine04
	old_conflicted_bonds	冲突绑定中的先前接口对	swp7 swp8、swp3 swp4
	new_conflicted_bonds	冲突绑定中的当前接口对	swp11 swp12、swp23 swp24
	old_state_protodownbond	绑定的先前状态	protodown、up
	new_state_protodownbond	绑定的当前状态	protodown、up
节点	message_type	网络协议或服务标识符	node
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf41、exit01、spine-5、tor-36
	ntp_state	NTP 服务的当前状态	同步、未同步
	db_state	数据库的当前状态	添加、更新、删除、死机
NTP	message_type	网络协议或服务标识符	ntp
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf-9、exit01、spine04
	old_state	服务的先前状态	同步、未同步
	new_state	服务的当前状态	同步、未同步
端口	message_type	网络协议或服务标识符	port
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf13、exit01、spine-8、tor-36
	ifname	接口名称	eth0、swp14
	old_speed	端口的先前速度等级	10 G、25 G、40 G、未知
	old_transreceiver	先前的收发器	40G Base-CR4、25G Base-CR
	old_vendor_name	已安装端口模块的先前供应商名称	Amphenol、OEM、NVIDIA、Fiberstore、Finisar
	old_serial_number	已安装端口模块的先前序列号	MT1507VS05177、AVE1823402U、PTN1VH2
	old_supported_fec	先前的正向纠错 (FEC) 支持状态	无、Base R、RS
	old_advertised_fec	先前的 FEC 广告状态	true、false、未报告
	old_fec	先前的 FEC 功能	无
	old_autoneg	自动协商的先前激活状态	开启、关闭
	new_speed	端口的当前速度等级	10 G、25 G、40 G
	new_transreceiver	当前的收发器	40G Base-CR4、25G Base-CR
	new_vendor_name	已安装端口模块的当前供应商名称	Amphenol、OEM、NVIDIA、Fiberstore、Finisar
	new_part_number	已安装端口模块的当前部件号	SFP-H10GB-CU1M、MC3309130-001、603020003
	new_serial_number	已安装端口模块的当前序列号	MT1507VS05177、AVE1823402U、PTN1VH2
	new_supported_fec	当前的 FEC 支持状态	无、Base R、RS
	new_advertised_fec	当前的 FEC 广告状态	true、false
	new_fec	当前的 FEC 功能	无
	new_autoneg	自动协商的当前激活状态	开启、关闭
传感器	sensor	网络协议或服务标识符	风扇：fan1、fan-2 电源装置：psu1、psu2 温度：psu1temp1、temp2
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf-26、exit01、spine2-4
	old_state	风扇、电源装置或热传感器的先前状态	风扇：正常、缺失、不良 PSU：正常、缺失、不良温度：正常、爆裂、不良、危急
	new_state	风扇、电源装置或热传感器的当前状态	风扇：正常、缺失、不良 PSU：正常、缺失、不良温度：正常、爆裂、不良、危急
	old_s_state	风扇或电源装置的先前状态。	风扇：正常、故障 PSU：正常、故障
	new_s_state	风扇或电源装置的当前状态。	风扇：正常、故障 PSU：正常、故障
	new_s_max	当前最高温度阈值	温度：110
	new_s_crit	当前临界高温阈值	温度：85
	new_s_lcrit	当前临界低温阈值	温度：-25
	new_s_min	当前最低温度阈值	温度：-50
服务	message_type	网络协议或服务标识符	services
	主机名	用户定义的、基于文本的交换机或主机名称	server02、leaf03、exit01、spine-8
	name	服务名称	clagd、lldpd、ssh、ntp、netqd、netq-agent
	old_pid	先前的进程或服务标识符	12323, 52941
	new_pid	当前的进程或服务标识符	12323, 52941
	old_status	服务的先前状态	正常、故障
	new_status	服务的当前状态	正常、故障

高级通知配置示例

以下部分列出了高级通知配置的示例。

为选定交换机的 BGP 事件创建通知

此示例创建一个与名为 pd-netq-events 的 PagerDuty 通道的通知集成。然后，它为来自 spine-01 的任何通知创建规则 bgpHostname 和名为 4bgpSpine 的过滤器。结果是，来自 Spine-01 的任何信息严重性事件消息都会被过滤到 pd-netq-events 通道。

▼ 显示示例

cumulus@switch:~$ netq add notification channel pagerduty pd-netq-events integration-key 1234567890
Successfully added/updated channel pd-netq-events
cumulus@switch:~$ netq add notification rule bgpHostname key node value spine-01
Successfully added/updated rule bgpHostname
 
cumulus@switch:~$ netq add notification filter bgpSpine rule bgpHostname channel pd-netq-events
Successfully added/updated filter bgpSpine
cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity         Channel Info
--------------- ---------------- ---------------- ------------------------
pd-netq-events  pagerduty        info             integration-key: 1234567
                                                  890   

cumulus@switch:~$ netq show notification rule
Matching config_notify records:
Name            Rule Key         Rule Value
--------------- ---------------- --------------------
bgpHostname     hostname         spine-01
 
cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
bgpSpine        1          info             pd-netq-events   bgpHostnam
                                                             e

为给定 EVPN VNI 上的错误创建通知

此示例创建一个与名为 pd-netq-events 的 PagerDuty 通道的通知集成。然后，它为来自 EVPN 叠加网络上 VNI 42 的任何错误消息创建规则 evpnVni 和名为 3vni42 的过滤器。结果是，来自 VNI 42 且严重性级别为“错误”的任何事件消息都会被过滤到 pd-netq-events 通道。

▼ 显示示例

cumulus@switch:~$ netq add notification channel pagerduty pd-netq-events integration-key 1234567890
Successfully added/updated channel pd-netq-events
 
cumulus@switch:~$ netq add notification rule evpnVni key vni value 42
Successfully added/updated rule evpnVni
 
cumulus@switch:~$ netq add notification filter vni42 rule evpnVni channel pd-netq-events
Successfully added/updated filter vni42
 
cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity         Channel Info
--------------- ---------------- ---------------- ------------------------
pd-netq-events  pagerduty        info             integration-key: 1234567
                                                  890   

cumulus@switch:~$ netq show notification rule
Matching config_notify records:
Name            Rule Key         Rule Value
--------------- ---------------- --------------------
bgpHostname     hostname         spine-01
evpnVni         vni              42
 
cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
bgpSpine        1          info             pd-netq-events   bgpHostnam
                                                             e
vni42           2          error            pd-netq-events   evpnVni

为配置文件更改创建通知

此示例创建一个与名为 slk-netq-events 的 Slack 通道的通知集成。然后，它为任何配置文件更新消息创建规则 sysconf 和名为 configChange 的过滤器。结果是，任何配置更新消息都会被过滤到 slk-netq-events 通道。

▼ 显示示例

cumulus@switch:~$ netq add notification channel slack slk-netq-events webhook https://hooks.slack.com/services/text/moretext/evenmoretext
Successfully added/updated channel slk-netq-events
 
cumulus@switch:~$ netq add notification rule sysconf key message_type value configdiff
Successfully added/updated rule sysconf
 
cumulus@switch:~$ netq add notification filter configChange severity info rule sysconf channel slk-netq-events
Successfully added/updated filter configChange
 
cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity Channel Info
--------------- ---------------- -------- ----------------------
slk-netq-events slack            info     webhook:https://hooks.s
                                          lack.com/services/text/
                                          moretext/evenmoretext     
 
cumulus@switch:~$ netq show notification rule
Matching config_notify records:
Name            Rule Key         Rule Value
--------------- ---------------- --------------------
bgpHostname     hostname         spine-01
evpnVni         vni              42
sysconf         message_type     configdiff 

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
bgpSpine        1          info             pd-netq-events   bgpHostnam
                                                             e
vni42           2          error            pd-netq-events   evpnVni
configChange    3          info             slk-netq-events  sysconf

为服务关闭时创建通知

此示例创建一个与名为 slk-netq-events 的 Slack 通道的通知集成。然后，它为指示服务不再运行的任何服务状态消息创建规则 svcStatus 和名为 svcDown 的过滤器。结果是，任何服务关闭消息都会被过滤到 slk-netq-events 通道。

▼ 显示示例

cumulus@switch:~$ netq add notification channel slack slk-netq-events webhook https://hooks.slack.com/services/text/moretext/evenmoretext
Successfully added/updated channel slk-netq-events
 
cumulus@switch:~$ netq add notification rule svcStatus key new_status value down
Successfully added/updated rule svcStatus
 
cumulus@switch:~$ netq add notification filter svcDown severity error rule svcStatus channel slk-netq-events
Successfully added/updated filter svcDown
 
cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity Channel Info
--------------- ---------------- -------- ----------------------
slk-netq-events slack            info     webhook:https://hooks.s
                                          lack.com/services/text/
                                          moretext/evenmoretext     
 
cumulus@switch:~$ netq show notification rule
Matching config_notify records:
Name            Rule Key         Rule Value
--------------- ---------------- --------------------
bgpHostname     hostname         spine-01
evpnVni         vni              42
svcStatus       new_status       down
sysconf         configdiff       updated

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
bgpSpine        1          info             pd-netq-events   bgpHostnam
                                                             e
vni42           2          error            pd-netq-events   evpnVni
configChange    3          info             slk-netq-events  sysconf
svcDown         4          error            slk-netq-events  svcStatus

创建过滤器以删除来自给定接口的通知

此示例创建一个与名为 slk-netq-events 的 Slack 通道的通知集成。然后，它创建规则 swp52 和名为 swp52Drop 的过滤器，该过滤器会删除来自接口 swp52 的事件的所有通知。

▼ 显示示例

cumulus@switch:~$ netq add notification channel slack slk-netq-events webhook https://hooks.slack.com/services/text/moretext/evenmoretext
Successfully added/updated channel slk-netq-events
 
cumulus@switch:~$ netq add notification rule swp52 key port value swp52
Successfully added/updated rule swp52
 
cumulus@switch:~$ netq add notification filter swp52Drop severity error rule swp52 before bgpSpine
Successfully added/updated filter swp52Drop
 
cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity Channel Info
--------------- ---------------- -------- ----------------------
slk-netq-events slack            info     webhook:https://hooks.s
                                          lack.com/services/text/
                                          moretext/evenmoretext     
 
cumulus@switch:~$ netq show notification rule
Matching config_notify records:
Name            Rule Key         Rule Value
--------------- ---------------- --------------------
bgpHostname     hostname         spine-01
evpnVni         vni              42
svcStatus       new_status       down
swp52           port             swp52
sysconf         configdiff       updated

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
swp52Drop       1          error            NetqDefaultChann swp52
                                            el
bgpSpine        2          info             pd-netq-events   bgpHostnam
                                                             e
vni42           3          error            pd-netq-events   evpnVni
configChange    4          info             slk-netq-events  sysconf
svcDown         5          error            slk-netq-events  svcStatus

为给定设备创建过热趋势的通知（使用多个规则）

此示例在交换机 leaf04 超过高温阈值时创建通知。创建此通知需要两个规则，一个用于标识特定设备，另一个用于标识温度触发器。然后，NetQ 将消息发送到 pd-netq-events 通道。

▼ 显示示例

cumulus@switch:~$ netq add notification channel pagerduty pd-netq-events integration-key 1234567890
Successfully added/updated channel pd-netq-events
 
cumulus@switch:~$ netq add notification rule switchLeaf04 key hostname value leaf04
Successfully added/updated rule switchLeaf04
cumulus@switch:~$ netq add notification rule overTemp key new_s_crit value 24
Successfully added/updated rule overTemp
 
cumulus@switch:~$ netq add notification filter critTemp rule switchLeaf04 channel pd-netq-events
Successfully added/updated filter critTemp
cumulus@switch:~$ netq add notification filter critTemp severity critical rule overTemp channel pd-netq-events
Successfully added/updated filter critTemp
 
cumulus@switch:~$ netq show notification channel
Matching config_notify records:
Name            Type             Severity         Channel Info
--------------- ---------------- ---------------- ------------------------
pd-netq-events  pagerduty        info             integration-key: 1234567
                                                  890

cumulus@switch:~$ netq show notification rule
Matching config_notify records:
Name            Rule Key         Rule Value
--------------- ---------------- --------------------
bgpHostname     hostname         spine-01
evpnVni         vni              42
overTemp        new_s_crit       24
svcStatus       new_status       down
switchLeaf04    hostname         leaf04
swp52           port             swp52
sysconf         configdiff       updated

cumulus@switch:~$ netq show notification filter
Matching config_notify records:
Name            Order      Severity         Channels         Rules
--------------- ---------- ---------------- ---------------- ----------
swp52Drop       1          error            NetqDefaultChann swp52
                                            el
bgpSpine        2          info             pd-netq-events   bgpHostnam
                                                             e
vni42           3          error            pd-netq-events   evpnVni
configChange    4          info             slk-netq-events  sysconf
svcDown         5          error            slk-netq-events  svcStatus
critTemp        6          error            pd-netq-events   switchLeaf
                                                             04
                                                             overTemp

配置系统事件通知

事件消息格式

配置基本 NetQ 事件通知

创建通道

创建规则

创建过滤器

删除通道

配置代理服务器

规则键和值参考

高级通知配置示例

为选定交换机的 BGP 事件创建通知

为给定 EVPN VNI 上的错误创建通知

为配置文件更改创建通知

为服务关闭时创建通知

创建过滤器以删除来自给定接口的通知

为给定设备创建过热趋势的通知（使用多个规则）

产品

解决方案

学习