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

Skip to content

# System 子类方法

1. cli_query_system_name
> 描述：

    1
    2
    3
    4
    5

    方法功能：systemname命令用来查询系统名称。

    命令格式：ipmcget -t smbios -d systemname

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 系统名称

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_system_name()

2. cli_set_time_zone
> 描述：

    1
    2
    3
    4
    5

    方法功能：timezone命令用来设置iBMC时区。

    命令格式：ipmcset -d timezone -v <timezone>

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

> 参数：

    1

    timezone(str): 时区。

> 返回值：

    1

    result(str): 设置iBMC时区是否成功。

> 异常：

    1

    None

> 举例：

    1

    api_result = self.bmccli_api.cli_set_time_zone(params["timezone"])

3. cli_query_ibmc_time
> 描述：

    1
    2
    3
    4
    5

    方法功能：time命令用来查询iBMC时间。

    命令格式：ipmcget -d time

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 查询的iBMC时间。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_ibmc_time()

4. cli_query_device_version
> 描述：

    1
    2
    3
    4
    5

    方法功能：version命令用来查询设备的版本信息。

    命令格式：ipmcget -d version

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 获取到的设备版本信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_device_version()

5. cli_query_fru
> 描述：

    1
    2
    3
    4
    5

    方法功能：fruinfo命令用于查询除电源模块之外的其它FRU的信息，包括主板、RAID卡、Mezz卡、硬盘背板、PCIe Rsier卡、GPU载板等。

    命令格式：ipmcget [-t fru0] -d fruinfo

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

> 参数：

    1
    2

    target(str): 使用-t命令的参数，默认不使用。
    system_id(str): OS host id (主要用于mulutihost)

> 返回值：

    1

    result(list): FRU的信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_fru()

6. cli_query_system_health_status
> 描述：

    1
    2
    3
    4
    5

    方法功能：health命令用来查询系统的健康状态。

    命令格式：ipmcget [-t fru0] -d health

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 系统的健康状态信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_system_health_status()

7. cli_query_system_health_event
> 描述：

    1
    2
    3
    4
    5

    方法功能：healthevents命令用来查询系统的健康事件信息。

    命令格式：ipmcget [-t fru0] -d healthevents

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

> 参数：

    1
    2

    page(int): 获取日志信息翻页数目。
    location (str | None): 查询和设置命令生效的目标部件。

> 返回值：

    1

    result(list): 系统的健康事件信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_system_health_event()

8. cli_query_of_port_80
> 描述：

    1
    2
    3
    4
    5

    方法功能：port80命令用于查询80口当前和历史信息。

    命令格式：ipmcget -d port80

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 80口当前和历史信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_of_port_80()

9. cli_query_serial_number_server
> 描述：

    1
    2
    3
    4
    5

    方法功能：serialnumber命令用来查询服务器的设备序列号。

    命令格式：ipmcget [-t smbios] -d serialnumber

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 服务器的设备序列号。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_serial_number_server()

10. cli_query_clear_sel
> 描述：

    1
    2
    3
    4
    5

    方法功能：sel命令用来查询和清除系统SEL信息。

    命令格式：ipmcget -d sel -v <option> [sel_id]

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

> 参数：

    1
    2
    3
    4
    5

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(str): 要进行的操作
    sel_id(str): 要获取处理建议的SEL的ID。
    clear(str): 清除所有SEL信息。
    page(int): 获取日志信息翻页数目。

> 返回值：

    1

    result(str): 系统的SEL信息，或者清除系统SEL信息是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_clear_sel(params["method"], params["option"])

11. cli_query_operation_logs
> 描述：

    1
    2
    3
    4
    5

    方法功能：operatelog命令用来查询系统操作日志。

    命令格式：ipmcget -d operatelog

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

> 参数：

    1

    page(int): 获取日志信息翻页数目。

> 返回值：

    1

    result(str): 系统操作日志。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_operation_logs()

12. cli_download_systemcom_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：systemcom命令用来下载系统串口数据。

    命令格式：ipmcget -d systemcom

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 下载系统串口数据是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_download_systemcom_data()

13. cli_download_black_box_file
> 描述：

    1
    2
    3
    4
    5

    方法功能：blackbox命令用来下载黑匣子数据。

    命令格式：ipmcget -d blackbox

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 下载下载黑匣子数据是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_download_black_box_file()

14. cli_download_bios
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：maintenance -d download命令用于下载BIOS文件“bios.bin”到“/tmp”目录下。
                “bios.bin”文件可用于定位OS启动异常和BIOS异常等问题。

    命令格式：ipmcset -t maintenance -d download -v <option>

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

> 参数：

    1

    option(str): 表示是否下载BIOS到“/tmp”目录下。

> 返回值：

    1

    result(str): 下载BIOS文件是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_download_bios(params["option"])

15. cli_upgrade_bios
> 描述：

    1
    2
    3
    4
    5

    方法功能：maintenance -d upgradebios命令用来升级BIOS。

    命令格式：ipmcset -t maintenance -d upgradebios -v filepath

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

> 参数：

    1

    filepath(str): BIOS升级文件的路径。

> 返回值：

    1

    result(str): 升级BIOS是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_upgrade_bios(params["filepath"])

16. cli_set_ibmc_network_port_state
> 描述：

    1
    2
    3
    4
    5

    方法功能：maintenance -d ethlink命令用来设置iBMC网口的使能状态。

    命令格式：ipmcset -t maintenance -d ethlink -v <ethname> <action>

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

> 参数：

    1
    2

    ethname(str): 待设置的网口名称。
    action(str): 网口使能状态。

> 返回值：

    1

    result(str): 设置iBMC网口的使能状态是否成功。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_ibmc_network_port_state(params["action"], params["ethname"])

17. cli_perform_one_click_collection
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：diaginfo命令用来一键收集信息，包括iBMC相关的配置信息、版本信息和日志等。
                一键收集信息的更多内容请参见本文档一键收集信息说明。

    命令格式：ipmcget -d diaginfo

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 一键收集的信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_perform_one_click_collection()

18. cli_restore_ibmc_factory_setts
> 描述：

    1
    2
    3
    4
    5

    方法功能：restore命令用来恢复iBMC出厂设置。执行此命令后iBMC会重启。

    命令格式：ipmcset -d restore

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 恢复iBMC出厂设置的命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_restore_ibmc_factory_setts()

19. cli_set_clp_notimeout_mode
> 描述：

    1
    2
    3
    4
    5
    6
    7
    8

    方法功能：notimeout命令用于设置CLP notimeout功能的使能和禁止状态，以及会话的超时时间。
                禁用或启用CLP notimeout功能后，需要退出iBMC后重新登录，才能实现CLP
                notimeout功能的禁用或启用。
                默认为禁用状态。

    命令格式：ipmcset -d notimeout -v <enabled | disabled> [value]

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

> 参数：

    1
    2
    3
    4

    option(str):
    enabled: 启用CLP notimeout功能
    disabled: 禁用CLP notimeout功能
    value(str): 会话超时时间

> 返回值：

    1

    result(list): 命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_set_clp_notimeout_mode(params["option"], params["value"])

20. cli_query_clp_notimeout_set
> 描述：

    1
    2
    3
    4
    5

    方法功能：notimeoutstate命令用于查询CLP notimeout功能的配置信息，如查询CLP notimeout功能的会话超时时间。

    命令格式：ipmcget -d notimeoutstate

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): CLP notimeout功能的配置信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_clp_notimeout_set()

21. cli_chang_system_master_keys
> 描述：

    1
    2
    3
    4
    5

    方法功能：securityenhance -d updatemasterkey命令用来更新系统主密钥。

    命令格式：ipmcset -t securityenhance -d updatemasterkey

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 更新系统主密钥后的命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_chang_system_master_keys()

22. cli_query_set_update_interval_master_keys
> 描述：

    1
    2
    3
    4
    5

    方法功能：securityenhance -d masterkeyupdateinterval命令用来查询和设置主密钥自动更新间隔。

    命令格式：ipmcget -t securityenhance -d masterkeyupdateinterval

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

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    interval(str): 表示自动更新间隔

> 返回值：

    1

    result(list): 主密钥自动更新间隔，或者设置主密钥自动更新间隔后的命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_query_set_update_interval_master_keys(params["method"], params["interval"])

23. cli_query_set_automatic_discovery_configuration
> 描述：

    1
    2
    3
    4
    5

    方法功能：autodiscovery命令用来查询和设置自动发现配置。

    命令格式：ipmcget -d autodiscovery

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

> 参数：

    1
    2
    3
    4
    5

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(str):
    enable/disable: 使能或禁用自动发现配置功能
    value(str): 网段选择
    netport(str): 端口

> 返回值：

    1

    result(list): 自动发现配置信息，或者设置自动发现配置的命令回显。

> 异常：

    1

    None

> 举例：

    1

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

24. cli_query_set_controlled_poweron_configuration
> 描述：

    1
    2
    3
    4
    5

    方法功能：poweronpermit命令用来查询和设置受控上电配置。

    命令格式：ipmcget -d poweronpermit

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

> 参数：

    1
    2
    3
    4
    5
    6

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    value(str):
    enable: 使能受控上电配置
    disable: 禁止受控上电配置
    ip(str): 服务器IP地址
    netport(str): 端口号

> 返回值：

    1

    result(list): 受控上电配置信息，或者设置受控上电配置的命令回显。

> 异常：

    1

    None

> 举例：

    1

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

25. cli_query_clear_poweron_lock
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：默认状态下，若服务器在指定时间内未完成上电，则通过iBMC为服务器上电的功能被锁定，服务器将无法通过iBMC上电。
                poweronlock命令用来查询此上电锁的锁定状态，并可清除此上电锁，取消上述限制。

    命令格式：ipmcget -t maintenance -d poweronlock

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

> 参数：

    1

    method(str): 执行命令方式，查询或者配置，参数为query/set。

> 返回值：

    1

    result(str): 上电锁的锁定状态，或者清除上电锁的命令回显。

> 异常：

    1

    None

> 举例：

    1

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

26. cli_query_set_bios_print_enablement_status
> 描述：

    1
    2
    3
    4
    5

    方法功能：biosprint命令用于查询和设置BIOS全打印开关状态。

    命令格式：ipmcget -t maintenance -d biosprint

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

> 参数：

    1
    2

    method(str): 执行命令方式，查询或者配置，参数为query/set。
    option(int): BIOS全打印开关状态

> 返回值：

    1

    result(str): BIOS全打印开关状态，或者设置BIOS全打印开关状态的命令回显。

> 异常：

    1

    None

> 举例：

    1

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

27. cli_clear_log
> 描述：

    1
    2
    3
    4
    5

    方法功能：clearlog命令用于清除iBMC的操作日志、运行日志或安全日志。

    命令格式：ipmcset -d clearlog -v <value>

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

> 参数：

    1

    value(str): 要清除的日志类型

> 返回值：

    1

    result(list): 清除iBMC的操作日志、运行日志或安全日志的命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_clear_log(params["value"])

28. cli_get_sensor
> 描述：

    1
    2
    3
    4
    5

    方法功能：sensor命令用于查询传感器信息。

    命令格式：ipmcget -t sensor -d list

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 传感器信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmc_host_api.cli_get_sensor()

29. cli_get_boardlog
> 描述：

    1
    2
    3
    4
    5

    方法功能：收集BCU板信息

    命令格式：ipmcget -t maintenance -d boardlog

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

> 参数：

    1
    2

    system_id(int): 系统id
    delay_time(int): 延迟时间

> 返回值：

    1

    result(list): BCU板信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.cli_api.cli_get_boardlog(system_id=1)

30. cli_get_lsw_all_portinfo
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取交换端口信息

    命令格式：ipmcget -t <key> -d portinfo

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

> 参数：

    1

    key(str): 要找的端口。

> 返回值：

    1

    result(str): 端口信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.cli_api.cli_get_lsw_all_portinfo(key)

31. cli_get_chassisnum
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取单板所在框号

    命令格式：ipmcget -d chassisnum

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 单板的框号信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.cli_api.cli_get_chassisnum()

32. cli_get_bmc_timezone
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取BMC时区

    命令格式：ipmcget -d time

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): BMC时区。

> 异常：

    1

    None

> 举例：

    1

    ret = self.cli_api.cli_get_bmc_timezone()

33. cli_get_lsw_itfmode
> 描述：

    1
    2
    3
    4
    5

    方法功能：获取交换itf模式

    命令格式：ipmcget -t <key> -d itfportmode

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

> 参数：

    1

    key(str): 选择itf网络。

> 返回值：

    1

    result(str): itf模式信息。

> 异常：

    1

    None

> 举例：

    1

    ret = self.cli_api.cli_get_lsw_itfmode(key='mesh')

34. cli_set_lsw_itfmode
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置itf模式

    命令格式：ipmcset -t <key> -d itfportmode -v <mode>

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

> 参数：

    1
    2

    key(str): 选择itf网络。
    mode(str): 选择itf模式。

> 返回值：

    1

    result(str): itf模式信息。

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_set_lsw_itfmode(key='mesh', mode=self.itfmode)

35. in_debug_shell
> 描述：

    1
    2
    3
    4
    5

    方法功能：交换CLI使用maint_debug_cli, 并关联到指定模块

    命令格式：maint_debug_cli

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

> 参数：

    1

    att_module(str): 关联的模块名

> 返回值：

    1

    attachDebugShell(list): 指定模块的信息

> 异常：

    1

    None

> 举例：

    1

    ret = api.bmc_cli_in_debug_shell()[0]['parser']

36. cli_set_psu_output_enabled
> 描述：

    1
    2
    3
    4
    5

    方法功能：psuoutputenabled命令用于设置PSU输出使能状态。

    命令格式：ipmcset -d psuoutputenabled -v <psuid> <outputenabled>

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

> 参数：

    1
    2

    psuid (int): 电源ID号，大于等于1的整数，最大值为机型支持的电源最大个数
    outputenabled (int): 电源输出使能状态， 0：禁用电源输出 1：使能电源输出

> 返回值：

    1

    result(list): 命令回显

> 异常：

    1

    None

> 举例：

    1

    ret = bmc_cli_api.cli_set_psu_output_enabled(psu_id, 0)

37. cli_restore_ibmc_factory_sett
> 描述：

    1
    2
    3
    4
    5

    方法功能：restore命令用来恢复iBMC出厂设置。执行此命令后iBMC会重启。

    命令格式：ipmcset -d restore

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

> 参数：

    1

    params(str): ibmc密码.

> 返回值：

    1

    result(list): 命令回显。

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_restore_ibmc_factory_sett(password=self.bmc_obj.password)

38. cli_get_redundancy
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询管理模块的主备用情况信息

    命令格式：ipmcget -d redundancy

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

> 参数：

    1

    location (str | None): 查询和设置命令生效的目标部件

> 返回值：

    1
    2

    result(dict): 管理模块的主备用情况信息。
    例如: {'SMM1': 'Present(standby)', 'SMM2': 'Present(active)*'}

> 异常：

    1

    None

> 举例：

    1

    ret = api.bmc_cli_get_redundancy()[0]['parser']

39. cli_set_failover
> 描述：

    1
    2
    3
    4
    5

    方法功能：将主用节点降为从用节点

    命令格式：ipmcget -d redundancy

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

> 参数：

    1

    location (str | None): 查询和设置命令生效的目标部件

> 返回值：

    1

    result(dict): 生效的目标部件信息，或者设置生效的目标部件命令回显。

> 异常：

    1

    None

> 举例：

    1

    ret = bmc_cli_api.cli_set_failover()

40. cli_get_datasyncstatus
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询主备数据同步情况

    命令格式：ipmcget -d datasyncstatus

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

> 参数：

    1

    location (str | None): 查询主备数据同步状态

> 返回值：

    1

    result(str): 主备数据同步信息

> 异常：

    1

    None

> 举例：

    1

    ret = bmc_cli_api.cli_get_datasyncstatus()