华为乾坤-配置SNMP Trap参数:请求参数

时间:2025-02-17 11:36:46

请求参数

表2 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

trap

REFERENCE

详细请参见表3

设备SNMP Trap参数配置。

-

表3 TrapInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

config-status

string

  • reserved

  • initial

  • configuring-database

  • configured-database-success

  • configured-database-failed

  • configuring-device

  • configured-device-success

  • configured-device-failed

reserved

1:配置状态;

2:查询接口返回业务数据配置状态结果;

3:创建、修改、删除不返回状态;

4:入参设置此字段无效;

5:取值范围:

reserved:保留未用,

initial:初始状态,

configuring-database:数据库存储中,

configured-database-success:预配置,

configured-database-failed:数据库存储失败,

configuring-device:部署中,

configured-device-success:成功,

configured-device-failed:失败。

"reserved"

errorInfo

string

0~1000个字符。

-

配置下发结果错误描述。

""

trapSwitch

boolean

  • true

  • false

-

使能Trap发送。true表示开启全部Trap发送,false表示关闭全部Trap发送,参数不传表示恢复Trap开关至设备缺省状态。V600系列设备不支持关闭全部Trap发送。对于V600设备,当使能所有特性告警开关后,不需要再配置具体特性告警消息。

true

trapQueueSize

int32

[1-1000]

100

用来设置发往目的主机(Host)的Trap报文的消息队列的长度。只有V300系列设备支持该参数。默认值为100。

1000

trapSourceInterfaceName

string

0~63个字符。

-

发送Trap信息的接口名称,接口名称需要已经存在。

"GE0/0/0"

serverSource

string

0~64个字符。

-

引擎监听的IP地址。只有V300系列设备支持该参数。

"192.168.1.1"

targetHosts

REFERENCE

详细请参见表4

目标主机列表。

-

traps

REFERENCE

详细请参见表6

配置Trap. 仅V600系列设备支持该参数。

-

表4 TargetHosts对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

targetHost

ARRAY_REFERENCE

1-20个列表项,详细请参见表5

目标主机。

-

表5 TargetHost对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

name

string

1~32个字符。

-

指定SNMP目标主机名,主键字段。

"hostName"

address

string

0~64个字符。

-

IP地址。V300系列设备支持IPv4地址。V600系列设备支持IPv4,IPv6地址。

"192.168.2.1"

isPublicNet

boolean

  • true

  • false

false

使能目标主机公网管理。仅V600系列设备支持该参数。默认值为false,配置为true时,VPN实例名必须是_public_。

false

notifyType

string

  • trap

  • inform

-

告警 消息通知 类型,如果该字段的值不在枚举值范围,则参数变为null。 取值范围trap或者inform。 该参数是必填项。仅V600系列设备支持该参数。

"trap"

portNumber

int32

[1-65535]

162

网管用来接收告警信息的UDP端口号。默认值是162。

162

vpnInstanceName

string

0~31个字符。

-

VPN实例,VPN实例需要已经存在。

"underlay_1"

interfaceName

string

0~63个字符。

-

接口名。仅V600系列设备支持该参数。

"GE0/0/1"

userName

string

1~32个字符。

-

用户名。

"user"

securityLevel

string

  • noAuthNoPriv

  • authentication

  • privacy

-

指示是否使用身份验证和加密的安全级别,如果该字段的值不在枚举值范围,则参数变为null。

"privacy"

表6 Traps对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

trap

ARRAY_REFERENCE

1-1000个列表项,详细请参见表7

trap。

-

表7 Trap对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

featureName

string

1~32个字符。

-

Trap所属模块,联合主键。

"IFNET"

trapName

string

1~63个字符。

-

Trap名称,联合主键。

"linkdown"

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000001870548621.html