配置eSight本地信息
通过配置北向SNMP接口参数，实现与第三方系统的对接。
当前部分北向SNMP对象信息配置分别支持通过界面与配置文件两种方式配置，如表 1所示。通过配置文件配置后需要重启eSight才能生效，建议使用界面配置。
任务 |
界面配置 |
配置文件配置 |
|---|---|---|
配置第三方系统信息 |
|
路径为eSight安装目录/AppBase/etc/nbi/snmp/snmpagent.xml。 配置方法请参见本章节详情。 |
配置SNMP Agent信息 |
|
|
配置v3协议信息 |
|
|
配置心跳周期 |
不支持。 |
|
配置SNMP Inform模式 |
|
配置SNMP Agent信息
SNMP Agent运行在eSight网管系统中，根据第三方系统的请求对eSight进行相应操作，并实时上报告警给第三方系统。SNMP Agent的参数包括eSight接收第三方系统请求的地址和端口、发送Trap的地址和端口及相关通用配置信息。
配置项说明
<common name="common"> <param name="Agent_IP">127.0.0.1</param> <param name="Agent_Port">4700</param> <param name="TrapSendIP">127.0.0.1</param> <param name="TrapSendPort">31920</param> <param name="SupportedMIB">MIB2</param> <param name="TrapSendInterval">0</param> <param name="TimeType">0</param> <param name="TimeFormat">3</param> <param name="StringSize">4096</param> <param name="ActiveAlarm">1</param> <param name="TrapCoding">UTF-8</param> <param name="PDUTrace">0</param> <param name="SupportRootAlarm">0</param> </common>
参数介绍
参数 |
配置项路径 |
描述 |
默认值 |
|---|---|---|---|
Agent_IP |
“snmpagent/common/Agent_IP” |
表示SNMP服务运行的IP地址。
|
127.0.0.1 |
Agent_Port |
“snmpagent/common/Agent_ Port” |
表示SNMP服务运行的端口，一般不需修改。 |
4700 |
TrapSendIP |
“snmpagent/common/TrapSendIP” |
表示发送trap通知和inform通知的源IP地址。当操作系统有多个IP地址，此参数需要配置为与第三方系统物理地址相通的IP地址。 |
127.0.0.1 |
TrapSendPort |
“snmpagent/common/TrapSendPort” |
表示发送trap通知和inform通知的源端口，如果配置无效值，将随机获取端口。 |
31920 |
TrapSendInterval |
“snmpagent/common/TrapSendInterval” |
表示向第三方系统发送Trap通知时，trap间的等待时间间隔。取值范围为0ms到1000ms。 对于inform类型通知，不存在连续inform间的等待时间间隔，此配置项无效。 |
0 |
TimeFormat |
“snmpagent/common/TimeFormat” |
表示告警时间VB字段的时间格式，取值情况如下：
|
3 |
TimeType |
“snmpagent/common/TimeType” |
表示告警上报的时间类型，其值可以是0或者1。
|
0 |
StringSize |
“snmpagent/common/StringSize” |
VB中可修复字符串的最大长度。 |
4096 |
ActiveAlarm |
“snmpagent/common/ActiveAlarm” |
表示查询当前告警还是查询活动告警。
|
1 |
TrapCoding |
“snmpagent/common/TrapCoding” |
表示上报的告警Trap的字符集编码格式。取值可以是UTF-8、GBK、ISO-8859-1 |
UTF-8 |
SupportRootAlarm |
“snmpagent/common/SupportRootAlarm” |
表示是否支持根因告警。
当前eSight仅支持0，即上报、查询所有告警。 |
0 |
NEFDNDelimiter |
snmpagent/common/NEFDNDelimiter |
NEFDN告警过滤分隔符，与NEFDNFilter字段配合使用，用于识别NEFDNFilter字段中的多个NEFDN信息。该配置项在配置文件中默认不体现。当网管用户通过前台SNMP北向配置页面配置SNMP信息时，SNMP进程会在snmpagent.xml配置文件中增加该配置项，并下发参数值作为NEFDNFilter字段分隔符。 |
- |
PDUTrace |
"snmpagent/common/PDUTrace" |
表示是否记录北向发送给第三方系统的数据。
|
0 |
由于Linux操作系统对小于1024的端口有使用限制，所以配置项Agent_Port和TrapSendPort不能配置小于1024的端口，否则会导致功能不可用，建议使用默认配置端口。
配置v3协议信息
在配置第三方系统信息中配置了使用SNMPv3协议时，需要配置安全级别、鉴权协议和加密协议。
配置项说明
<v3trap name="v3trap"> <param name="Level">3</param> <param name="AuthProtocol">3</param> <param name="PrivProtocol">3</param> <param name="EngineID"></param> <param name="EngineIDMatchRFC">1</param> </v3trap>
参数介绍
参数 |
配置项路径 |
描述 |
缺省值 |
|---|---|---|---|
Level |
“snmpagent/v3trap/Level” |
可选三个安全级别其中之一，分别为：
|
3 |
AuthProtocol |
“snmpagent/v3trap/AuthProtocol” |
该参数用于配置SNMPv3的鉴权协议，取值如下：
说明：
MD5、SHA有安全风险，建议使用安全加密算法SHA2-256 。 |
3 |
PrivProtocol |
“snmpagent/v3trap/PrivProtocol” |
该参数用于配置SNMPv3的加密协议，取值如下：
说明：
鉴于AES-256协议比DES、AES协议有更多的安全保证，建议配置协议时选择AES-256协议。 |
3 |
EngineID |
“snmpagent/v3trap/EngineID” |
该参数用于配置SNMPv3的EngineID，可以配置为一个IPv4或者一个字符串。 说明：
如果配置EngineID参数，其长度范围为[5,27]，否则取默认值空 。 对于HA系统，建议配置EngineID为一个有效字符串，保证倒换后EngineID一致。 |
空 |
EngineIDMatchRFC |
“snmpagent/v3trap/EngineIDMatchRFC” |
该参数用于配置EngineID上报方法，取值如下：
|
1 |
配置心跳周期
北向SNMP接口支持定期发送心跳信息给第三方系统。通过心跳信息，第三方系统可以判断与北向SNMP接口的通信是否正常。
配置项说明
<heartbeat name="heartbeat"> <param name="Enable">1</param> <param name="Interval">60</param> <param name="Lable">SNMP Agent</param> </heartbeat>
参数介绍
参数 |
配置项路径 |
描述 |
缺省值 |
|---|---|---|---|
Enable |
“/snmpagent/heartbeat/Enable” |
表示启动还是关闭心跳通知上报。取值如下：
|
1 |
Interval |
“/snmpagent/heartbeat/Interval” |
表示发送心跳通知的周期，有效值围是3秒～3600秒，如果配置错误或者配置为0的情况，都将采用缺省的配置值60秒。 |
60 |
Lable |
“/snmpagent/heartbeat/Lable” |
心跳Trap上报标识。 |
SNMP Agent |
配置SNMP Inform模式
通知上报有Trap和Inform两种工作模式。在Trap方式下，一接收到告警就进行上报，不管是否接收到第三方系统的响应就会上报后续告警。在Inform方式，一接收到告警就进行上报，但是只有接收到第三方系统的响应后才会上报后续告警。第三方系统设置的参数不正确时，Inform方式会试图多次连接，因此会占用大量资源，导致SNMP Agent效率变低。
配置项说明
<inform name="inform"> <param name="Enable">0</param> <param name="Timeout">5</param> <param name="Retries">3</param> <param name="CacheSize">10000</param> </inform>
参数介绍
参数 |
配置项路径 |
描述 |
缺省值 |
|---|---|---|---|
Enable |
snmpagent/inform/Enable |
表示是否采用inform方式上报告警。取值如下：
|
0 |
Timeout |
snmpagent/inform/Timeout |
SNMP inform协议规定的参数。表示inform报文发送超时时间。缺省值是5，单位是秒，最小值是1秒。 |
5 |
Retries |
snmpagent/inform/Retries |
这是SNMP inform协议规定的参数。表示inform报文重发次数。最小值是0。 |
3 |
CacheSize |
snmpagent/inform/CacheSize |
表示实时告警缓存大小。最大值是50000，最小值是10000。 |
10000 |
- 实际实现中，北向SNMP会不断地重发inform报文，直到发送成功。
配置告警属性
eSight向上层网管提供实时告警Trap功能。要上报实时告警Trap，需要配置上报的告警字段。
配置项说明
<MIB2 name="MIB2"> <param name="CsnType">0</param> <param name="isInternational">0</param> </MIB2>
参数介绍
参数 |
配置项路径 |
描述 |
缺省值 |
|---|---|---|---|
CsnType |
snmpagent/MIB2/CsnType |
表示告警流水号Csn的上报类型。
|
0 |
isInternational |
snmpagent/MIB2/isInternational |
表示告警级别上报的遵循标准。
|
0 |
omsCompatibility |
snmpagent/MIB2/omsCompatibility |
表示兼容性，当前仅影响AlarmType和AlarmClearCategory。 如果该项没有配置，表示使用eSight的当前规格。
其他非0、1取值当0处理，修改后需要重启网管。 |
0 |
定制告警功能配置 |
|||
SupportCDNStandard |
snmpagent/MIB2/SupportCDNStandard |
表示是否支持中国电信CDN（content delivery network ）网络管理标准。 缺省配置文件中不设置。
|
- |
- 只有在配置北向SNMP接口信息中配置为加载使用MIB2时，配置上述上报字段才有效。
- 上述定制功能参数在配置文件中默认不提供，若要开启定制功能，需在文件中增加对应参数配置项。例如：<param name="SupportCDNStandard">1</param>。
SNMP告警字段
eSight向上层网管提供实时告警Trap功能。本章节仅说明eSight上报告警的各个字段格式，不允许配置。
配置项说明
<MIB2 name="MIB2"> <Mib name="Mib"> <param name="VB1">Csn</param> <param name="VB2">Category</param> <param name="VB3">OccurTime</param> <param name="VB4">MOName</param> <param name="VB5">ProductID</param> <param name="VB6">NEType</param> <param name="VB7">NEDevID</param> <param name="VB8">DevCsn</param> <param name="VB9">ID</param> <param name="VB10">Type</param> <param name="VB11">Level</param> <param name="VB12">Restore</param> <param name="VB13">Confirm</param> <param name="VB14">AckTime</param> <param name="VB15">RestoreTime</param> <param name="VB16">Operator</param> <param name="VB17">ExtendInfo</param> <param name="VB18">Probablecause</param> <param name="VB19">Proposedrepairactions</param> <param name="VB20">SpecificProblems</param> <param name="VB21">ClearOperator</param> <param name="VB22">ObjectInstanceType</param> <param name="VB23">ClearCategory</param> <param name="VB24">ClearType</param> <param name="VB25">ServiceAffectFlag</param> <param name="VB26">AdditionalInfo</param> <param name="VB27">GroupID</param> <param name="VB28">ExtendProductItem7</param> <param name="VB29">ExtendProductItem8</param> </Mib> </MIB2>
参数介绍
参数 |
配置项路径 |
OID |
描述 |
缺省值 |
|---|---|---|---|---|
告警上报VB字段配置（VB必须按+1方式顺序增长） |
||||
VB1 |
“/snmpagent/MIB2/Mib/VB1” |
x.1 |
告警的网络流水号。 |
Csn |
VB2 |
“/snmpagent/MIB2/Mib/VB2” |
x.2 |
告警的分类。 |
Category |
VB3 |
“/snmpagent/MIB2/Mib/VB3” |
x.3 |
告警发生时间。 |
OccurTime |
VB4 |
“/snmpagent/MIB2/Mib/VB4” |
x.4 |
发生告警的设备名称。 |
MOName |
VB5 |
“/snmpagent/MIB2/Mib/VB5” |
x.5 |
发生告警的设备所属的产品系列。 |
ProductID |
VB6 |
“/snmpagent/MIB2/Mib/VB6” |
x.6 |
发生告警的设备所属某种产品系列下的某种设备类型。 |
NEType |
VB7 |
“/snmpagent/MIB2/Mib/VB7” |
x.7 |
设备ID。 |
NEDevID |
VB8 |
“/snmpagent/MIB2/Mib/VB8” |
x.8 |
故障设备的独有序列号。 |
DevCsn |
VB9 |
“/snmpagent/MIB2/Mib/VB9” |
x.9 |
告警种类ID。 |
ID |
VB10 |
“/snmpagent/MIB2/Mib/VB10” |
x.10 |
告警类型。 |
Type |
VB11 |
“/snmpagent/MIB2/Mib/VB11” |
x.11 |
告警级别。 |
Level |
VB12 |
“/snmpagent/MIB2/Mib/VB12” |
x.12 |
清除标志。 |
Restore |
VB13 |
“/snmpagent/MIB2/Mib/VB13” |
x.13 |
确认标志。 |
Confirm |
VB14 |
“/snmpagent/MIB2/Mib/VB14” |
x.14 |
确认时间。 |
AckTime |
VB15 |
“/snmpagent/MIB2/Mib/VB15” |
x.15 |
清除时间。 |
RestoreTime |
VB16 |
“/snmpagent/MIB2/Mib/VB16” |
x.16 |
确认操作者。 |
Operator |
VB17 |
“/snmpagent/MIB2/Mib/VB17” |
x.27 |
告警定位信息。 |
ExtendInfo |
VB18 |
“/snmpagent/MIB2/Mib/VB18” |
x.28 |
告警原因。 |
Probablecause |
VB19 |
“/snmpagent/MIB2/Mib/VB19” |
x.29 |
修复建议。 |
Proposedrepairactions |
VB20 |
“/snmpagent/MIB2/Mib/VB20” |
x.30 |
告警详细原因。 |
Specificproblems |
VB21 |
“/snmpagent/MIB2/Mib/VB21” |
x.46 |
清除告警的操作员。 |
ClearOperator |
VB22 |
“/snmpagent/MIB2/Mib/VB22” |
x.47 |
告警对象实例类型。 |
ObjectInstanceType |
VB23 |
“/snmpagent/MIB2/Mib/VB23” |
x.48 |
告警清除类别。 |
ClearCategory |
VB24 |
“/snmpagent/MIB2/Mib/VB24” |
x.49 |
告警清除类型。 |
ClearType |
VB25 |
“/snmpagent/MIB2/Mib/VB25” |
x.50 |
告警业务影响标记。 |
ServiceAffectFlag |
VB26 |
“/snmpagent/MIB2/Mib/VB26” |
x.51 |
告警附加信息。 |
AdditionalInfo |
VB27 |
“/snmpagent/MIB2/Mib/VB27” |
x.17 |
告警分组标识。对应TRAP属性：IMAPNorthboundAlarmParas1 |
GroupID |
VB28 |
“/snmpagent/MIB2/Mib/VB28” |
x.37 |
上报告警当前值 |
ExtendProductItem7 |
VB29 |
“/snmpagent/MIB2/Mib/VB29” |
x.38 |
上报告警阈值 |
ExtendProductItem8 |
