13-网络管理和监控配置指导

07-EAA配置

1.7.3 配置CLI监控策略——环境变量

1 EAA

1.1 EAA简介

EAA（Embedded Automation Architecture，嵌入式自动化架构）是集成在Comware V7平台上的一系列相关软件模块的总称。

使用EAA功能：

· 用户可以定制一系列监控策略，在策略中定义自己感兴趣的事件以及事件发生时的处理动作。监控策略被启用后，系统会实时监控设备的运行，当用户定制的事件发生时，就触发相应的监控策略并自动执行监控策略中的动作。

· 设备能够智能地监控多种事件，并做出灵活多变的响应，从而大大地提升系统的可维护性。

1.1.1 EAA框架

图1-1 EAA框架示意图

EAA框架如图1-1所示，它包括事件源、EM（Event Monitor，事件监控）模块、RTM（Real-Time Event Manager，实时事件管理）模块和EAA监控策略。

1. 事件源

事件源是系统中的软件或硬件模块，它们会触发事件。例如，CLI事件源能触发命令行事件，Syslog事件源能触发日志事件。

2. EM

EM根据用户配置对事件源中发生的事件进行过滤匹配，匹配成功则通知RTM执行相应监控策略。当用户配置了多个监控策略，系统会创建多个EM模块，每个EM组件监控一个事件。

3. RTM

RTM是EAA的核心部件，负责管理监控策略，包括监控策略的创建、状态变化和执行。

4. EAA监控策略

通过监控策略，用户可以定义自己感兴趣的事件以及事件发生时的处理动作。

监控策略有两种配置方式：一种是通过命令行来配置，一种是通过Tcl脚本来定义。通过命令行配置的监控策略称为基于CLI的监控策略，以下简称CLI监控策略；通过Tcl脚本定义的监控策略称为基于Tcl的监控策略，以下简称Tcl监控策略。

1.1.2 CLI监控策略简介

CLI监控策略通过如下命令行来定义：一条event命令、一条或多条（不超过232条）action命令、一条或多条（不超过64条）user-role命令、一条running-time命令以及一条commit命令。其中：

· event命令用来定义监控策略的触发事件。目前，EAA能够监控的事件类型如表1-1所示。

表1-1 监控事件类型描述表

事件的名称	描述
cli	监控命令行事件配置该事件后，当用户输入指定的命令并对其进行特定操作（执行、帮助或者补全）就会触发策略执行
syslog	监控日志事件配置该事件后，当系统在指定时间段内生成指定规格的日志信息时触发监控策略执行；RTM模块产生的日志不会触发策略执行
process	监控进程事件配置该事件后，当指定进程（可以为用户命令行触发的或者系统自动触发的）发生指定状态变化（异常、关闭、启动或重启时），触发监控策略执行
hotplug	监控板卡热插拔事件配置该事件后，当插入/拔出指定板卡，均会触发监控策略执行
interface	监控接口事件接口事件中存在一个触发开关： (1) 配置该事件后，触发开关立即打开 (2) 当指定接口上的指定报文的数目达到start-op start-op start-val start-val参数指定的条件时，触发监控策略执行一次（第一次执行），并关闭触发开关，但系统会继续监控接口事件 (3) 当满足restart-op restart-op restart-val restart-val参数指定的条件时，才重新开启触发开关 (4) 如果指定接口上的指定报文的数目再次达到start-op start-op start-val start-val参数指定的条件时，则再次触发监控策略执行一次（第二次执行），并关闭触发开关，系统继续监控接口事件 (5) 如此循环
snmp	监控SNMP节点值变化事件 SNMP节点值变化事件中存在一个触发开关： (1) 配置该事件后，触发开关立即打开 (2) 系统根据用户配置，定时轮询设备上某个节点的值，当该值达到start-op start-op start-val start-val指定的条件时，触发监控策略执行一次（第一次执行），并关闭触发开关，但系统会继续监控SNMP节点值变化事件 (3) 当节点值满足restart-op restart-op restart-val restart-val指定的条件时，才重新开启触发开关 (4) 当节点值再次达到start-op start-op start-val start-val指定的条件时，则再次触发监控策略执行一次（第二次执行），并关闭触发开关，系统继续监控SNMP节点值变化事件 (5) 如此循环
snmp-notification	监控SNMP Trap事件配置该事件后，当系统生成一条Trap，Trap中携带的MIB对象（由oid参数指定）的值到达oid-val oid-val op op指定的条件时，触发监控策略执行

· action命令用来定义事件发生时，监控策略将执行的动作。目前支持的动作有执行指定的命令行、生成一条指定内容的日志、主备倒换和重启。

· user-role命令用来指定执行监控策略的用户角色。用户角色中定义了允许用户操作哪些系统功能以及资源对象，设备支持的每条命令都有缺省用户角色，如果监控策略中指定的用户角色权限比命令行的缺省用户角色的权限小，则不能执行该命令以及该命令后面的所有动作。如果指定的用户角色不存在，则监控策略不能执行。如果给某个监控策略配置了多个用户角色，则使用这些用户角色权限的并集去执行该策略。例如，给某策略配置了用户角色A和B，如果策略中的动作是角色A或者B允许执行的，则策略可以执行；如果策略中存在角色A和B都不能执行的命令，则该命令以及该命令后面的所有动作都不能执行。关于用户角色的详细描述请参见“基础配置指导”中的“RBAC”。

· running-time命令用来指定监控策略的运行时间，运行时间达到时即使策略没有执行完毕，也会立即停止执行策略。该命令用于限制策略的运行时间，以免策略长时间运行占用系统资源。而策略是否会触发以及停止后是否会被再次触发则由event配置决定。

· commit命令用来启用CLI监控策略。CLI监控策略创建和定义后，必须启用才能生效。

1.1.3 Tcl监控策略简介

Tcl监控策略通过Tcl脚本来定义。按内容Tcl脚本可以分为两大部分：首行和其它部分。首行用于定义事件、用户角色和运行时间；从第二行开始，定义监控事件发生时执行的动作脚本。

用户创建Tcl监控策略并绑定Tcl脚本后，设备会首先解析Tcl脚本首行，获取监控事件、用户角色、运行时间，并立即下发以上配置且生效。当事件发生后从第二行开始执行动作脚本。

Tcl脚本首行的格式为::comware::rtm::event_register eventname arg1 arg2 arg3 …user-role rolename1 | [ user-role rolename2 | [ ] ] [ running-time running-time ]。其中：

· eventname用来指定事件的类型，Tcl监控策略中支持的事件类型同CLI监控策略，详情请参见表1-1。

· arg用来指定事件的匹配规则，具体定义与相应event命令中的参数规格一致，请参考EAA命令手册。

· user-role用来指定执行脚本的用户角色，参数含义和配置要求同CLI监控策略。

· running-time用来指定脚本运行的最大时间，参数含义和配置要求同CLI监控策略。

Tcl监控策略支持如下三类动作：

· Tcl语言标准命令。

· EAA模块的专属Tcl命令。

· 设备支持的其它命令行。

1.1.4 EAA环境变量

EAA环境变量指的是专用于监控策略的环境变量。环境变量由<环境变量名、环境变量值>字对组成。在配置监控策略的动作时，我们可以在应该输入参数的地方输入“$环境变量名”，表示此处需要引用环境变量值。系统在运行监控策略的时候，会自动用环境变量值去替代“$环境变量名”。如果要修改监控参数的值，只需在系统视图下，修改环境变量值即可，而无需进入监控策略视图，修改监控策略下的具体配置。因此，定义和使用环境变量可以简化监控策略的配置，提高监控策略的灵活性和易用性。

目前，EAA支持的环境变量包括内部环境变量和用户自定义环境变量。

(1) 内部环境变量

设备缺省支持的环境变量，用户不能创建、删除和修改。内部环境变量名均以“_”开头，内部环境变量的值由系统决定。内部环境变量又包括两类：一类是公共环境变量，另一类是非公共环境变量。

· 公共环境变量可用于所有类型的事件：其中_event_id、_event_type、_event_type_string在系统启动时生成，关联的事件类型不同，其值不同，其值一旦确定不能更改；_event_time、_event_severity在运行时产生。

· 非公共环境变量只能用于对应的事件，其值在事件触发时获得，它标示当前事件的部分信息。例如，HOTPLUG事件对应的内部环境变量为“_slot”和“_subslot”，当1号单板被插拔的时候，环境变量“_slot”的值为1；当2号单板被插拔的时候，环境变量“_slot”的值为2。

目前EAA支持内部环境变量如表1-2所示。

(2) 用户自定义环境变量

用户定义环境变量名可包含数字、字符或者“_”，但不能以“_”开头。用户自定义环境变量可用于所有类型的事件，其值由用户配置决定。用户定义环境变量可修改、删除。

表1-2 内部环境变量描述表

事件	内部环境变量的名称	描述
CLI	_cmd	匹配上的命令
SYSLOG	_syslog_pattern	匹配的日志信息的内容
HOTPLUG	_slot	发生热插拔的单板所在的槽位号
HOTPLUG	_subslot	发生热插拔的子卡所在的子槽位号
INTERFACE	_ifname	接口的名称
SNMP	_oid	SNMP操作中携带的OID
SNMP	_oid_value	OID对应节点的值
SNMP TRAP	_oid	SNMP Trap信息中携带的OID
PROCESS	_process_name	进程的名称
公共环境变量	_event_id	事件的ID
	_event_type	事件的类型
	_event_type_string	事件类型的描述
	_event_time	事件发生的时间
	_event_severity	事件的严重级别

1.2 配置EAA环境变量

使用本特性，用户可以自定义EAA环境变量的名称和值，以便定义监控策略时可以引用。引用环境变量时，环境变量名前面必须加“$”符号，表示引用，如定义了名称为“hostname”的环境变量，引用时需写成“$hostname”。

表1-3 配置EAA环境变量

配置步骤	命令	说明
进入系统视图	system-view	-
配置环境变量	rtm environment envname env-value	缺省情况下，无用户自定义的环境变量，系统中支持一系列内部环境变量，如表1-2所示

1.3 配置CLI监控策略

1.3.1 配置指导和注意事项

· 如果监控策略中要用到系统内部环境变量，请先了解相应环境变量的值；如果监控策略中要用到的环境变量不是系统缺省支持的，请先定义，具体配置请参见“1.2 配置EAA环境变量”。

· 同一设备上可创建多个CLI监控策略且其数量没有限制。请确保同时启用的策略间动作不要冲突，因为当系统同时执行多个策略，且不同策略间动作有冲突时，执行结果是随机的。

· 给CLI监控策略配置事件、动作、用户角色和运行时间后，必须执行commit命令，该策略才会启用，该策略下的配置才会生效。

· 同一个策略下，只能配置一个触发事件和运行时间。当多次执行event或者running-time命令时，则最近配置并且commit的生效。

· 同一个策略下，最多可配置232个动作。当条件满足，策略被触发时，系统会按照动作的编号由小到大顺序执行该策略下的所有动作。

· 如果新配置的动作的编号和已有动作的编号相同，则最近配置并且commit的生效。

· 同一监控策略下可配置多个用户角色，最多可以配置64个有效用户角色，超过该上限后，新配置的用户角色即便commit也不会生效。

1.3.2 配置步骤

表1-4 配置CLI监控策略

配置步骤	命令	说明
进入系统视图	system-view	-
创建CLI监控策略并进入CLI监控策略视图	rtm cli-policy policy-name	如果CLI监控策略已创建，则直接进入CLI监控策略视图
配置命令行事件	event cli { async [ skip ] \| sync } mode { execute \| help \| tab } pattern regular-exp	七种事件选其一缺省情况下，未配置任何命令行事件
配置板卡热插拔事件（独立运行模式）	event hotplug slot slot-number [ subslot subslot-number ]
配置板卡热插拔事件（IRF模式）	event hotplug chassis chassis-number slot slot-number [ subslot subslot-number ]
配置接口事件	event interface interface-type interface-number monitor-obj monitor-obj start-op start-op start-val start-val restart-op restart-op restart-val restart-val [ interval interval ]
配置进程事件（独立运行模式）	event process { exception \| restart \| shutdown \| start } [ name process-name [ instance instance-id ] ] [ slot slot-number ]
配置进程事件（IRF模式）	event process { exception \| restart \| shutdown \| start } [ name process-name [ instance instance-id ] ] [ chassis chassis-number [ slot slot-number ] ]
配置SNMP操作事件	event snmp oid oid monitor-obj { get \| next } start-op start-op start-val start-val restart-op restart-op restart-val restart-val [ interval interval ]
配置SNMP Trap事件	event snmp-notification oid oid oid-val oid-val op op [ drop ]
配置日志事件	event syslog priority level msg msg occurs times period period
配置事件发生时执行指定的命令行	action number cli command-line	缺省情况下，监控策略下未配置任何动作
配置事件发生时执行重启操作（独立运行模式）	action number reboot [ slot slot-number [ subslot subslot-number ] ]
配置事件发生时执行重启操作（IRF模式）	action number reboot [ chassis chassis-number [ slot slot-number [ subslot subslot-number ] ] ]
配置事件发生时发送指定的LOG	action syslog priority level facility local-number msg msg-body
配置事件发生时进行主备倒换	action number switchover
（可选）配置执行CLI监控策略时使用的用户角色	user-role role-name	缺省情况下，执行CLI监控策略时使用的用户角色为创建该策略的用户的角色安全日志管理员角色与其它用户角色互斥：为监控策略配置安全日志管理员角色后，系统会自动删除当前配置的其它用户角色；反之亦然
（可选）配置事件发生时CLI监控策略的运行时间	running-time time	缺省情况下，CLI监控策略的运行时间为20秒
启用CLI监控策略	commit	缺省情况下，CLI监控策略未被启用

1.4 配置Tcl监控策略

Tcl监控策略启用后，不允许修改Tcl脚本。如需修改，请先停用Tcl监控策略，修改后，再启用Tcl监控策略。否则，Tcl监控策略将不能运行。

请参照以下步骤来配置Tcl监控策略：

(1) 如果监控策略中要用到系统内部环境变量，请先了解相应环境变量的值；如果监控策略中要用到的环境变量不是系统缺省支持的，请先定义，具体配置请参见“1.2 配置EAA环境变量”。

(2) 使用Tcl脚本编辑工具或者普通文档编辑工具，编辑格式符合要求的Tcl脚本。目前支持的Tcl版本为8.5.8。

(3) 使用FTP或者TFTP功能将Tcl脚本下载到设备上，FTP及TFTP具体配置请参见“基础配置指导”中的“FTP和TFTP”。

(4) 创建Tcl监控策略。

表1-5 配置Tcl监控策略

配置步骤	命令	说明
进入系统视图	system-view	-
创建并启用Tcl监控策略，并将它和Tcl脚本绑定	rtm tcl-policy policy-name tcl-filename	缺省情况下，未创建Tcl监控策略

1.5 暂停运行监控策略

使用本特性可以暂停运行所有的监控策略。如果要将暂停运行的所有策略恢复运行，请使用undo rtm scheduler suspend命令。

表1-6 配置Tcl监控策略

配置步骤	命令	说明
进入系统视图	system-view	-
暂停运行所有的监控策略	rtm scheduler suspend	-

1.6 EAA显示和维护

在完成上述配置后，在任意视图下执行display命令可以显示配置后EAA的运行情况，通过查看显示信息验证配置的效果。

表1-7 EAA显示和维护

操作	命令
显示用户自定义的EAA环境变量配置	display rtm environment [ var-name ]
显示监控策略的相关信息	display rtm policy { active \| registered [ verbose ] } [ policy-name ]