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

Skip to content

# ChassisDevice 子类方法

1. ipmi_get_chassis_capabilities_chassis
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.1 获取机箱功能机箱00h 00h用户
        Get Chassis Capabilities Chassis App 00h 00h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_chassis_capabilities_chassis(params)

2. ipmi_get_chassis_status_chassis
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.2 获取机箱状态机箱00h 01h用户
                  Get Chassis Status Chassis App 00h 01h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): {'opt': 'status'}

> 返回值：

    1
    2
    3
    4
    5
    6
    7

    response(list): [{
    'parser'  :(dict)执行命令的返回值
    'partial' : 0,
    'rc'      : 0,
    'stderr'  : (list),
    'stdout'  :(list)
    }]

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_chassis_status_chassis(params)

3. ipmi_chassis_control_chassis
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.3 底盘控制底盘00h 02h操作员
                  Chassis Control Chassis App 00h 02h Operator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_chassis_control_chassis(params)

4. ipmi_chassis_identify_chassis_chassis_identify_control
> 描述：

    1
    2
    3
    4
    5
    6
    7

    方法功能：4.4 机箱识别应用00h 04h操作员
                  Chassis Identify App 00h 04h Operator
                  ipmi标准命令点灯控制

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1
    2
    3

    params:(dict):
    interval(str): 控制点灯周期, 00h = Turn off Identify
    force_on(str): 强制控制点灯on

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_chassis_identify_chassis_chassis_identify_control(params)

5. ipmi_set_power_restore_policy_chassis
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.6 设置电源恢复策略机箱00h 06h操作员
                  Set Power Restore Policy Chassis App 00h 06h Operator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_power_restore_policy_chassis(params)

6. ipmi_get_system_restart_cause_chassis
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.7 获取系统重新启动原因机箱00h 07h用户
                   Get System Restart Cause Chassis App 00h 07h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_system_restart_cause_chassis(params)

7. ipmi_set_system_boot_options_chassis_boot_mode_config_mode
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置系统启动项

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1
    2
    3
    4
    5
    6
    7

    boot_option(str): 'None/Pxe/Hdd/Cd/BiosSetup/Floppy/empty/default',系统启动项
    option(str) : 'legacy: 启动模式自动更改为传统bios(legacy)
    uefi: 启动模式为uefi不变
    Once:生效次数为1次
    Continuos:生效次数为永久有效
    Disabled:生效次数为0次
    unvailable:无效值，异常测试时使用'}

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_boot_options_chassis_boot_mode_config_mode(boot_option, option)

8. ipmi_set_system_boot_progress
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置系统启动项为设置进行中

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    boot_options(str): 设置系统启动项的设置进行中,可以取0x00(设置完成）/0x01(设置中)

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_boot_progress(params)

9. ipmi_set_system_boot_selector
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置系统启动项的服务分区选择器

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    boot_options(str): 设置系统启动项的服务分区选择器,取值不做限制,可以取0x00-0xff

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_boot_selector(boot_options)

10. ipmi_set_system_boot_scan
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置系统启动项的业务分区扫描

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    boot_options(str): 设置系统启动项的业务分区扫描,取值不做限制,可以取0x00-0xff

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_boot_scan(boot_options)

11. ipmi_set_system_boot_clearing
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置系统启动项的清除BMC启动标志有效位

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    boot_options(str): 设置系统启动项的清除BMC启动标志有效位,取值不做限制，可以取0x00-0xff

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_boot_clearing(boot_options)

12. ipmi_set_system_boot_acknowledge
> 描述：

    1
    2
    3
    4
    5

    方法功能：设置系统启动项的引导信息确认

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    boot_options(str): 设置系统启动项的引导信息确认,取值不做限制,可以取0x00-0xff

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_boot_acknowledge(boot_options)

13. ipmi_get_system_boot_options
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询服务器启动项信息

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    boot_options(str): 'Progress/Selector/Scan/Clearing/Acknowledge/Bootdev',系统启动项

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_system_boot_options(boot_options)

14. ipmi_set_system_boot_options_chassis_power_on_delay
> 描述：

    1
    2
    3
    4
    5

    方法功能：4.8.2 设置系统启动选项机箱00h 08h操作员

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1
    2
    3
    4

    params:(dict):
    delay_mode:(int) 上电延迟模式,00(默认延迟),01(二分延迟）
    02(固定延迟),03(随机延迟）
    delay_time:(float)延迟时间

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_system_boot_options_chassis_power_on_delay(params)

15. ipmi_get_system_boot_options_chassis_power_on_delay
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.9 获取系统引导选项机箱00h 09h用户
                   Get System Boot Options Chassis App 00h 09h User

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_system_boot_options_chassis_power_on_delay(params)

16. ipmi_set_power_cycle_interval_chassis
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：4.11 设置电源循环间隔底盘00h 0Bh操作员
                  Set Power Cycle Interval Chassis App 00h 0Bh Operator

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_power_cycle_interval_chassis(params)

17. ipmi_get_bootparam
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：查看启动顺序
                 Get the boot sequence.

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_get_bootparam(params)

18. ipmi_set_bootparam
> 描述：

    1
    2
    3
    4
    5

    方法功能：IPMI设置Boot重启选项

    命令格式：

    支持Host类型：HostType.Local, HostType.HostOS

> 参数：

    1

    boot_flag:(str)系统启动项['force_pxe', 'force_disk', 'force_safe', 'force_diag', 'force_cdrom', 'force_bios']

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.ipmi_api.ipmi_set_bootparam(params)