Trap 子类方法 - KPTest框架开放资料

Skip to content

# Trap 子类方法

1. cli_query_set_snmp_trap_state
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    method: 执行命令方式，查询或者配置，参数为query/set。
    destination: 表示SNMP trap目标项。
    value:
    disabled: 表示禁用SNMP trap功能。
    enabled: 表示启用SNMP trap功能。

> 返回值：

    1

> 异常：

    1

> 举例：

    1

2. cli_set_snmp_trap_port_number
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d port命令用于设置iBMC的SNMP trap上报端口号。

    命令格式：ipmcset -t trap -d port -v <destination> <portvalue>

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    destination(str): 表示SNMP trap目标项。
    portvalue(str): 表示SNMP trap端口号。

> 返回值：

    1

    result(str): 设置iBMC的SNMP trap上报端口号后命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_snmp_trap_port_number(params["destination"], params["portvalue"])

3. cli_set_snmp_trap_community_name
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d community命令用于设置iBMC的SNMP trap团体名称。

    命令格式：ipmcset -t trap -d community

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    Community(str): 表示SNMP trap团体名称。

> 返回值：

    1

    result(str): 设置iBMC的SNMP trap团体名称后命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_snmp_trap_community_name(params["community"])

4. cli_set_snmp_trap_ip_address
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d address命令用于设置SNMP trap上报信息的目的IP地址。

    命令格式：ipmcset -t trap -d address -v <destination> <ipaddr>

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    destination(str): 表示SNMP trap目标项。
    ipaddr(str): 表示接收事件信息上报的IP地址。

> 返回值：

    1

    result(str): 设置SNMP trap上报信息的目的IP地址后命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_snmp_trap_ip_address(params["destination"], params["ipaddr"])

5. cli_query_snmp_trap_destination
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d trapiteminfo命令用于查询SNMP trap上报信息的目的IP地址、上报端口、使能状态。

    命令格式：ipmcget -t trap -d trapiteminfo

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1

    None

> 返回值：

    1

    result(str): SNMP trap上报信息的目的IP地址、上报端口、使能状态。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_snmp_trap_destination()

6. cli_query_set_snmp_trap_version
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d version命令用于查询和设置SNMP trap版本信息。

    命令格式：ipmcget -t trap -d version

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2
    3
    4
    5

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    value(str):
    V1: 表示SNMP trap版本号为V1。
    V2C: 表示SNMP trap版本号为V2C。
    V3: 表示SNMP trap版本号为V3。

> 返回值：

    1

    result(str): SNMP trap版本信息，或者设置SNMP trap版本信息后的命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_snmp_trap_version(params["method"])

7. cli_query_set_snmp_trap_alarm_severities
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d severity命令用于查询和设置SNMP trap的告警发送级别。

    命令格式：ipmcget -t trap -d severity

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    level(str): 表示SNMP trap的告警发送级别。

> 返回值：

    1

    result(str): SNMP trap的告警发送级别，或者设置SNMP trap的告警发送级别命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_snmp_trap_alarm_severities(params["method"])

8. cli_query_set_snmpv3_trap_user
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d user命令用于查询和设置SNMP trap V3用户。

    命令格式：ipmcget -t trap -d user

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    username(str): 表示SNMP trap V3用户。

> 返回值：

    1

    result(str): SNMP trap V3用户信息，或者设置SNMP trap V3用户命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_snmpv3_trap_user(params["method"])

9. cli_query_set_snmpv3_authentication_privacy_protocols
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d protocol命令用于查询和设置SNMP trap V3的鉴权和加密协议。

    命令格式：ipmcget -t trap -d protocol

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(str): 表示SNMP trap V3采用的加密协议。

> 返回值：

    1

    result(str): SNMP trap V3的鉴权和加密协议信息，或者设置SNMP trap V3的鉴权和加密协议命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_snmpv3_authentication_privacy_protocols(params["method"])

10. cli_query_set_snmp_trap_mode
> 描述：

    1
    2
    3
    4
    5

    方法功能：trap -d mode命令用于查询和设置SNMP trap模式。

    命令格式：ipmcget -t trap -d mode

    支持Host类型：HostType.BMC, HostType.HMM

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(str): 表示SNMP trap模式类型。

> 返回值：

    1

    result(str): SNMP trap模式信息，或者设置SNMP trap模式命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_snmp_trap_mode(params["method"])