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

Skip to content

# Ibmc 子类方法

1. cli_query_ibmc_ip
> 描述：

    1
    2
    3
    4
    5

    方法功能：ipinfo命令用来查询iBMC管理网口的IP信息。

    命令格式：ipmcget -d ipinfo

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): ip信息

> 异常：

    1

    None

> 举例：

    1

    ret = self.cli_api.cli_query_ibmc_ip()

2. cli_set_ibmc_ipv4_address
> 描述：

    1
    2
    3
    4
    5

    方法功能：ipaddr命令用于设置iBMC管理网口的IPv4地址、掩码、网关。

    命令格式：ipmcset -d ipaddr -v <ipaddr> <mask> [gateway]

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

> 参数：

    1
    2
    3

    ipaddr: 表示要设置的iBMC网口的IPv4地址。
    mask: 表示要设置的iBMC网口的子网掩码。
    gateway: 表示要设置的iBMC网口的网关地址。

> 返回值：

    1
    2
    3

    result(str): Set IPV6 address successfully.
    Set IPV6 prefix successfully.
    Set GATEWAY6 successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_ibmc_ipv4_address(ipaddr, mask)

3. cli_set_backup_ipv4_ibmc_management_network_port
> 描述：

    1
    2
    3
    4
    5

    方法功能：backupipaddr命令用于设置iBMC管理网口的备份IPv4地址。在DHCP功能开启时：

    命令格式：ipmcset -d backupipaddr -v <ipaddr> <mask>

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

> 参数：

    1
    2

    ipaddr: 表示要设置的iBMC网口的备份IPv4地址。
    mask: 表示要设置的备份IPv4地址的子网掩码。

> 返回值：

    1
    2

    result(str): Set backup IP address successfully.
    Set backup MASK address successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_backup_ipv4_ibmc_management_network_port(ipaddr, mask)

4. cli_set_ipv4_mode_ibmc
> 描述：

    1
    2
    3
    4
    5

    方法功能：ipmode命令用于设置iBMC网口的IPv4模式。

    命令格式：ipmcset -d ipmode -v <dhcp | static>

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

> 参数：

    1
    2
    3

    value:
    dhcp: 表示地址模式为dhcp
    static: 表示地址模式为static

> 返回值：

    1
    2

    result(str): Set dhcp mode successfully.
    Set static mode successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_ipv4_mode_ibmc(value)

5. cli_set_ipv4_gateway_address_ibmc
> 描述：

    1
    2
    3
    4
    5

    方法功能：gateway命令用来设置iBMC网口的IPv4网关地址。

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

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

> 参数：

    1

    gateway: 表示iBMC网口的IPv4网关地址。

> 返回值：

    1

    result(str): Set GATEWAY successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_ipv4_gateway_address_ibmc(gateway)

6. cli_set_ibmc_ipv6_address
> 描述：

    1
    2
    3
    4
    5

    方法功能：ipaddr6命令用于设置iBMC网口的IPv6地址、前缀长度和网关地址。

    命令格式：ipmcset -d ipaddr6 -v <ipaddr6/prefixlen> [gateway6]

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

> 参数：

    1
    2
    3
    4

    value:
    ipaddr6: 表示要设置的iBMC网口的IPv6地址。
    prefixlen: 表示要设置的iBMC网口的子网前缀长度。
    gateway6: 表示要设置的iBMC网口的IPv6网关地址。

> 返回值：

    1
    2
    3

    result(str): Set IPV6 address successfully.
    Set IPV6 prefix successfully.
    Set GATEWAY6 successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_ibmc_ipv6_address(value, gateway6)

7. cli_set_ipv6_mode_ibmc
> 描述：

    1
    2
    3
    4
    5

    方法功能：ipmode6命令用于设置iBMC网口的IPv6模式。

    命令格式：ipmcset -d ipmode6 -v <dhcp | static>

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

> 参数：

    1
    2
    3

    value:
    dhcp: 表示地址模式为dhcp
    static: 表示地址模式为static

> 返回值：

    1
    2

    result(str): Set dhcp mode successfully.
    Set static mode successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_ipv6_mode_ibmc(value)

8. cli_set_ipv6_gateway_address_ibmc
> 描述：

    1
    2
    3
    4
    5

    方法功能：gateway6命令用来设置iBMC网口的IPv6网关地址。

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

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

> 参数：

    1

    gateway6: 表示iBMC网口的IPv6网关地址。

> 返回值：

    1

    result(str): Set GATEWAY6 successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_ipv6_gateway_address_ibmc(gateway6)

9. cli_set_network_port_mode
> 描述：

    1
    2
    3
    4
    5

    方法功能：netmode命令用于设置网口模式。

    命令格式：ipmcset -d netmode -v <option>

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

> 参数：

    1

    option: 网口模式

> 返回值：

    1
    2

    result(str): Set net mode Manual successfully.
    Set net mode Adaptive successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_network_port_mode(option)

10. cli_set_active_ibmc_port
> 描述：

    1
    2
    3
    4
    5

    方法功能：activeport命令用于设置iBMC管理网口的激活端口。

    命令格式：ipmcset -d activeport -v <option> [portid]

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

> 参数：

    1
    2

    option: 激活端口类型
    portid: 激活端口编号

> 返回值：

    1

    result(str): Set active port successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_active_ibmc_port(option)

11. cli_set_vlan_id_network_port
> 描述：

    1
    2
    3
    4
    5

    方法功能：vlan命令用于设置网口的VLAN信息。

    命令格式：ipmcset -d vlan -v <off | id>

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

> 参数：

    1
    2
    3
    4
    5
    6

    value:
    off: 禁止VLAN
    id: 网口所属VLAN
    vlan_type: (str)
    '1' 设置专用网口vlan  专用网口vlan只支持cli和ipmi接口设置
    '0' 设置NCSI网口vlan

> 返回值：

    1

    result(str): Set vlan state successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_set_vlan_id_network_port(value)

12. cli_query_redirect_serial_port
> 描述：

    1
    2
    3
    4
    5

    方法功能：serialdir命令用来查询和设置串口方向。

    命令格式：ipmcget -d serialdir

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

> 参数：

    1
    2

    <option>: 串口方向
    system_id   (str): OS host id (主要用于mulutihost)

> 返回值：

    1

    result(str): 查询当前已连接的串口方向，其中Num值表示所设置的<option>值

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_query_redirect_serial_port(option， system_id)

13. cli_restart_ibmc
> 描述：

    1
    2
    3
    4
    5

    方法功能：reset命令用来重启iBMC管理系统。

    命令格式：ipmcset -d reset

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

> 参数：

    1

    None

> 返回值：

    1
    2

    result(str): This operation will reboot iBMC system. Continue? [Y/N]:y
    Resetting...

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_restart_ibmc(option， system_id)

14. cli_upgrade_firmware
> 描述：

    1
    2
    3
    4
    5

    方法功能：upgrade命令用于升级固件。

    命令格式：ipmcset -d upgrade -v <filepath>

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

> 参数：

    1
    2

    filepath: 表示将要升级的目标文件的绝对路径。
    system_id   (str): OS host id (主要用于mulutihost)

> 返回值：

    1
    2
    3
    4

    result(str): Please make sure the iBMC is working while upgrading!
    Updating...
    100%
    Update successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_upgrade_firmware(filepath， system_id)

15. cli_capture_screen
> 描述：

    1
    2
    3
    4
    5

    方法功能：printscreen命令用于截取服务器当前所显示的屏幕图片。

    命令格式：ipmcset -d printscreen [-v wakeup]

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

> 参数：

    1

    wakeup: 截取屏幕图片的同时唤醒系统屏保

> 返回值：

    1

    result(str): Download print screen image to /tmp/manualscreen.jpeg successfully.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_capture_screen()

16. cli_roll_back_ibmc_software
> 描述：

    1
    2
    3
    4
    5

    方法功能：rollback命令用来将iBMC固件主分区的镜像文件切换到备分区的镜像文件。

    命令格式：ipmcset -d rollback

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

> 参数：

    1

    None

> 返回值：

    1
    2
    3

    result(str): WARNING: The operation may have many adverse effects
    Do you want to continue?[Y/N]:y
    Set rollback successfully, system will reboot soon.

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_roll_back_ibmc_software()

17. cli_query_result_roll_back_ibmc_software
> 描述：

    1
    2
    3
    4
    5

    方法功能：rollbackstatus命令用来查询软件回滚状态。

    命令格式：ipmcget -d rollbackstatus

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): Last rollback success!

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli_api.cli_query_result_roll_back_ibmc_software()

18. cli_set_service_state
> 描述：

    1
    2
    3
    4
    5

    方法功能：service -d state命令用于设置iBMC的服务状态。

    命令格式：ipmcset -t service -d state -v <option> <enabled | disabled>

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

> 参数：

    1
    2
    3
    4
    5

    option(str): 服务类型
    value(str):
    enabled: 启用服务
    disabled: 禁用服务
    wait_input_yes(bool): 设置等待输出

> 返回值：

    1

    result(str): 返回各服务启动或关闭状态是否正常

> 异常：

    1
    2
    3

    None
    Example:
    return self.cli_api.cli_set_service_state(option=option, value=value, wait_input_yes=wait_input_yes)

> 举例：

    1

19. cli_set_service_port_number
> 描述：

    1
    2
    3
    4
    5

    方法功能：service -d port命令用于设置iBMC指定服务的端口号。

    命令格式：ipmcset -t service -d port -v <option> <port1value> [port2value]

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

> 参数：

    1
    2
    3

    option(srt): 服务类型
    port1value(str): 服务的端口号
    port2value(str): 服务的端口号，只有RMCP服务可以设置此端口

> 返回值：

    1

    result(str): 返回端口设置是否成功

> 异常：

    1
    2
    3

    None
    Example:
    return self.cli_api.cli_set_service_port_number(option=option, port1value=port_1, port2value=port_2)

> 举例：

    1

20. cli_query_service
> 描述：

    1
    2
    3
    4
    5

    方法功能：service -d list命令用于查询服务状态。

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

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 返回查询服务状态的列表

> 异常：

    1
    2
    3

    None
    Example:
    api_result = self.bmccli_api.cli_query_service()

> 举例：

    1

21. cli_set_enablement_status_login_security_message
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3.21 设置登录安全性信息功能的使能状态（securitybanner -d state）
                securitybanner -d state命令用于设置是否在iBMC登录界面显示安全信息。

    命令格式：ipmcset -t securitybanner -d state -v <enabled | disabled>

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

> 参数：

    1
    2
    3

    value(str): enabled: 表示在登录界面显示安全信息。
    disabled: 表示不在登录界面显示安全信息。
    get_return_info(bool): 是否需要获取返回的错误信息，默认为False

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli.cli_set_enablement_status_login_security_message("enabled")

22. cli_customiz_login_security_message
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3.22 定制登录安全信息（securitybanner -d content）
                securitybanner -d content命令用于设置在iBMC登录界面显示的安全信息的具体内容。

    命令格式：ipmcset -t securitybanner -d content -v < default | “option”>

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

> 参数：

    1
    2
    3

    value(str): default: 表示使用默认的安全信息，不做修改。
    option: 表示安全信息的具体内容
    get_return_info(bool): 是否需要获取返回的错误信息，默认为False

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.bmc_cli.cli_customiz_login_security_message("default")

23. cli_query_login_security_message
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3.23 查询登录安全信息（securitybanner -d info）
                securitybanner -d info命令用于查询iBMC登录界面显示的安全信息的详细内容。

    命令格式：ipmcget -t securitybanner -d info

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

> 参数：

    1

    None

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    init_info = self.bmc_cli.cli_query_login_security_message()

24. cli_import_ssl_certificate
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3.24 导入SSL证书（certificate -d import）
                certificate -d import命令用于导入SSL证书到iBMC系统。

    命令格式：ipmcset -t certificate -d import -v <filepath | file_URL> <type> [passphrase]

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

> 参数：

    1
    2
    3
    4
    5

    value(str):
    filepath: 待导入的SSL证书的路径
    file_URL: 待导入的远程SSL证书文件的URL
    ssl_type(str): SSL证书类型
    passphrase(str): 生成SSL证书时的密码

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.bmccli_api.cli_import_ssl_certificate(params["value"], params["ssl_type"], params["passphrase"])

25. cli_query_ssl_certificate
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3.25 查询SSL证书信息（certificate -d info）
                certificate -d info命令用于查询SSL证书的信息。

    命令格式：ipmcget -t certificate -d info

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

> 参数：

    1

    None

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.bmccli_api.cli_query_ssl_certificate()

26. cli_export_configuration_file
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3

    value(str):
    filepath: 配置文件导出后的本地存放路径
    file_URL: 配置文件导出后的远程存放路径

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.bmccli_api.cli_export_configuration_file(params["value"])

27. cli_import_configuration_file
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3.27 导入配置文件（config -d import）
                config -d import命令用于导入iBMC、BIOS和RAID控制器配置文件。

    命令格式：ipmcset -t config -d import -v <filepath | file_URL>

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

> 参数：

    1
    2
    3

    value(str):
    filepath: 待导入的配置文件所在本地路径。
    file_URL: 待导入的配置文件所在远程路径。

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.bmccli_api.cli_import_configuration_file(params["value"])

28. cli_import_crl_file
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3.28 导入CRL文件（crl）
                crl命令用于导入升级包完整性校验所使用的证书撤销列表文件。

    命令格式：ipmcset -d crl -v <localpath/URL> <type>

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

> 参数：

    1
    2
    3
    4

    value(str):
    localpath: 待导入的CRL文件的路径
    URL: 待导入的远程CRL文件的URL
    crl_type(str): CRL文件类型

> 返回值：

    1

    None

> 异常：

    1

    None

> 举例：

    1

    self.bmccli_api.cli_import_crl_file(params["value"], params["crl_type"])

29. cli_mount_file_virtual_cd_rom_drive
> 描述：

    1
    2
    3
    4
    5

    方法功能：vmm -d connect命令用于挂载文件到虚拟光驱。

    命令格式：ipmcset -t vmm -d connect -v <file_URL>

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

> 参数：

    1

    file_URL(str): 待挂载的文件所在的远程路径。

> 返回值：

    1

    result(srt): 挂载文件到虚拟光驱是否成功

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_mount_file_virtual_cd_rom_drive(params["file_URL"])

30. cli_disconnect_virtual_cd_rom_drive
> 描述：

    1
    2
    3
    4
    5

    方法功能：vmm -d disconnect命令用于断开虚拟光驱的连接。

    命令格式：ipmcset -t vmm -d disconnect

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

> 参数：

    1

    None

> 返回值：

    1

    result(srt): 断开虚拟光驱是否成功

> 异常：

    1

    None

> 举例：

    1

    ret = self.bmccli_api.cli_disconnect_virtual_cd_rom_drive()

31. cli_query_virtual_media
> 描述：

    1
    2
    3
    4
    5

    方法功能：vmm -d info命令用于查询iBMC虚拟媒体信息。

    命令格式：ipmcget -t vmm -d info

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

> 参数：

    1

    None

> 返回值：

    1

    result(list): 查询虚拟媒体信息列表

> 异常：

    1

    None

> 举例：

    1

    ret = self.vir_media_obj.redfish_cli_query_virtual_media()

32. cli_restore_default_set_fpga_card_golden_firmware
> 描述：

    1
    2
    3
    4
    5

    方法功能：fpgagoldenfwrestore命令用于FPGA卡无法正常工作时，将FPGA卡的Golden固件恢复出厂设置。

    命令格式：ipmcset -d fpgagoldenfwrestore -v <slotid> [position]

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

> 参数：

    1
    2

    slotid(str): FPGA卡的槽位号
    position(srt): FPGA卡所处的位置

> 返回值：

    1

    result(str): 恢复出厂设置是否成功

> 异常：

    1

    None

> 举例：

    1
    2

    ret = self.bmccli_api.cli_restore_default_set_fpga_card_golden_firmware(params["slotid"],
    params["position"])

33. cli_uname_info
> 描述：

    1
    2
    3
    4
    5

    方法功能：uname查看bmc系统信息

    命令格式：uname -a

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

> 参数：

    1

    None

> 返回值：

    1

    result(str): 返回ibmc系统信息

> 异常：

    1

    None

> 举例：

    1

    res = self.cli_api.cli_uname_info()

34. cli_enter_telnet_mode
> 描述：

    1
    2
    3
    4
    5

    方法功能：进入telnet模式

    命令格式：/dev/shm/busybox_x telnet localhost

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

> 参数：

    1
    2
    3

    busybox_value(bool)：1711机型telnet连接命令标志符, True -> /dev/shm/busybox_x
    loopback_ip(bool)：使用环回IP进行telnet连接的标志符 True -> xx.xx.xx.xx;False -> local_ip
    local_ip(str)：telnet 连接的地址，默认自动获取环境IP

> 返回值：

    1

    result(str): 返回telnet是否进入成功

> 异常：

    1

    None

> 举例：

    1

    ret = self.cli_api.cli_enter_telnet_mode(busybox_value=need_busybox_path, local_ip=self.bmc_host.local_ip)