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

Skip to content

# Server 子类方法

1. cli_query_set_boot_device
> 描述：

    1
    2
    3
    4
    5

    方法功能：bootdevice用来查询和设置启动设备。

    命令格式：ipmcget -d bootdevice

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

> 参数：

    1
    2
    3
    4
    5

    method: 执行命令方式,查询或者配置,参数为query/set。
    option: 设置的启动设备编号。
    value:
    once: 系统启动项的设置仅在下一次重启时生效,重启完成后,系统启动项自动恢复为BIOS中设置的默认方式。
    permanent: 系统启动项的设置永久有效。

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_set_boot_device(params)

2. cli_set_server_reset_mode
> 描述：

    1
    2
    3
    4
    5

    方法功能：frucontrol命令设置服务器的重启方式。

    命令格式：ipmcset [-t fru0] -d frucontrol -v <option>

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

> 参数：

    1
    2

    option: 服务器重启方式
    system_id   (str): OS host id (主要用于mulutihost)

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_set_server_reset_mode(params)

3. cli_query_set_server_power_state
> 描述：

    1
    2
    3
    4
    5

    方法功能：powerstate命令用于查询和控制服务器的上电和下电状态。

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

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

> 参数：

    1
    2
    3

    method: 执行命令方式,查询或者配置,参数为query/set。
    option: 要对服务器进行的操作
    host_id: OS host id

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_set_server_power_state(params)

4. cli_query_set_server_power_off_timeout_period
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：shutdowntimeout命令用来查询和设置服务器的下电时限。
                下电时限:执行下电操作后,iBMC系统等待操作系统下电的时间。如果超过该时间操作系统仍未自动下电,iBMC会强制执行下电操作。

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

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

> 参数：

    1
    2

    method: 执行命令方式,查询或者配置,参数为query/set。
    time: l表示要关闭服务器的下电时限功能。

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_set_server_power_off_timeout_period(params)

5. cli_query_mac_address_network_interface_main_board
> 描述：

    1
    2
    3
    4
    5

    方法功能：macaddr命令用来查询服务器主板上网口的MAC地址。

    命令格式：ipmcget -d macaddr

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

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_mac_address_network_interface_main_board(params)

6. cli_query_available_network_port
> 描述：

    1
    2
    3
    4
    5

    方法功能：ethport命令用来查询服务器上可用网口信息。

    命令格式：ipmcget -d ethport

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

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_available_network_port(params)

7. cli_clear_bios_flash
> 描述：

    1
    2
    3
    4
    5

    方法功能：clearcmos命令用于清除BIOS Flash上的用户自定义信息。

    命令格式：ipmcset -d clearcmos

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

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_clear_bios_flash(params)

8. cli_query_raid_controller_card
> 描述：

    1
    2
    3
    4
    5

    方法功能：ctrlinfo用来查询RAID控制器信息。

    命令格式：ipmcget -t storage -d ctrlinfo -v <option>

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

> 参数：

    1

    option: 待查询的RAID控制器的ID。

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_raid_controller_card(params)

9. cli_query_logical_disk
> 描述：

    1
    2
    3
    4
    5

    方法功能：ldinfo用来查询RAID控制器所管理的逻辑盘的信息。

    命令格式：ipmcget -t storage -d ldinfo -v <ctrlid> <option>

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

> 参数：

    1
    2

    ctrlid: 待查询逻辑盘所属RAID控制器的ID。
    option: 待查询的逻辑盘的ID。

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_logical_disk(params)

10. cli_query_physical_disk
> 描述：

    1
    2
    3
    4
    5

    方法功能：pdinfo用来查询物理盘的信息。

    命令格式：ipmcget -t storage -d pdinfo -v <option>

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

> 参数：

    1

    option: 待查询的物理盘的ID。

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_physical_disk(params)

11. cli_query_disk_array
> 描述：

    1
    2
    3
    4
    5

    方法功能：arrayinfo用来查询磁盘组的信息。

    命令格式：ipmcget -t storage -d arrayinfo -v <control_id> <option>

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

> 参数：

    1
    2

    control_id: 磁盘组所在控制器的ID
    option: 待查询的磁盘组的ID。

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_disk_array(params)

12. cli_creat_logical_drive
> 描述：

    1
    2
    3
    4
    5

    方法功能：createld用于使用空闲物理盘创建虚拟盘。

    命令格式：ipmcset -t storage -d createld -v <control_id> -rl <raidlevel> -pd <pd_id>

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

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14

    cachecade: 命令行中包含“-cachecade”时,表示创建的逻辑盘为CacheCade逻辑盘
    control_id: RAID控制器的ID
    raidlevel: 逻辑盘的RAID级别
    pd_id: 逻辑盘的成员盘列表
    sc: 逻辑盘的子组个数
    name: 逻辑盘名称
    size: 逻辑盘容量
    ss: 逻辑盘条带大小
    rp: 逻辑盘的读策略
    wp: 逻辑盘的写策略
    iop: 逻辑盘的IO策略
    ap: 逻辑盘的访问策略
    dcp: 逻辑盘的磁盘缓存策略
    init: 逻辑盘的初始化方式

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_creat_logical_drive(params)

13. cli_add_logical_drive
> 描述：

    1
    2
    3
    4
    5

    方法功能：addld用于在已有逻辑盘的磁盘组上添加新的逻辑盘。

    命令格式：ipmcset -t storage -d addld -v <control_id> -array <arrayid> [-name <ldname>] [-size

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

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11

    arrayid: 待添加逻辑盘的磁盘组的ID
    control_id: RAID控制器的ID
    name: 逻辑盘名称
    size: 逻辑盘容量
    ss: 逻辑盘条带大小
    rp: 逻辑盘的读策略
    wp: 逻辑盘的写策略
    iop: 逻辑盘的IO策略
    ap: 逻辑盘的访问策略
    dcp: 逻辑盘的磁盘缓存策略
    init: 逻辑盘的初始化方式

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_add_logical_drive(control_id, arrayid)

14. cli_delete_logical_drive
> 描述：

    1
    2
    3
    4
    5

    方法功能：deleteld用于删除RAID卡管理的逻辑盘。

    命令格式：ipmcset -t storage -d deleteld -v <control_id> <ldid>

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

> 参数：

    1
    2

    control_id: RAID控制器的ID
    ldid: 待删除的逻辑盘的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_delete_logical_drive(params)

15. cli_modify_logical_drive_properties
> 描述：

    1
    2
    3
    4
    5

    方法功能：ldconfig用于修改逻辑盘的属性。

    命令格式：ipmcset -t storage -d ldconfig -v <control_id> <ldid> [-name <ldname>] [-rp <rpvalue>]

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

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11

    ldid: 逻辑盘的ID
    control_id: RAID控制器的ID
    name: 逻辑盘名称
    bgi: 逻辑盘的BGI使能状态
    boot: 命令行中包含“-boot”时,表示设置此逻辑盘为启动盘。
    rp: 逻辑盘的读策略
    wp: 逻辑盘的写策略
    iop: 逻辑盘的IO策略
    ap: 逻辑盘的访问策略
    dcp: 逻辑盘的磁盘缓存策略
    sscd: 逻辑盘是否开启SSD Caching功能(即是否使用CacheCade逻辑盘作为缓存)

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_modify_logical_drive_properties(ldid, control_id)

16. cli_modify_raid_controller_properties
> 描述：

    1
    2
    3
    4
    5

    方法功能：ctrlconfig用于修改RAID控制器的属性。

    命令格式：ipmcset -t storage -d ctrlconfig -v <control_id> <[-cb <cbstate>] [-smartercb <smartercbstate>]

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

> 参数：

    1
    2
    3
    4
    5

    control_id: RAID控制器的ID
    cb: RAID控制器的Copyback功能使能状态
    smartercb: RAID控制器在成员盘出现SMART错误时Copyback功能使能状态
    jbod: RAID控制器JBOD模式使能状态
    restore: 命令行中包含“-restore”时,表示将RAID控制器的属性恢复为默认值

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_modify_raid_controller_properties(params)

17. cli_modify_physical_drive_properties
> 描述：

    1
    2
    3
    4
    5

    方法功能：pdconfig用于修改RAID控制器所管理的物理盘的属性。

    命令格式：ipmcset -t storage -d pdconfig -v <pdid> [-state <pdstate>] [-hotspare <hotsparetype> [-ld <ldid>]]

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

> 参数：

    1
    2
    3
    4
    5
    6

    pdid: 物理硬盘的ID
    state: 物理盘的运行状态
    hotspare: 物理盘的热备状态
    ld: 逻辑盘ID。
    locate: 物理盘定位指示灯状态
    cryptoerase: 命令行中包含-cryptoerase时,表示将加密盘的数据擦除。

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_modify_physical_drive_properties(params)

18. cli_query_set_log_function_screw
> 描述：

    1
    2
    3
    4
    5
    6

    方法功能：raidcom命令用于查询和设置要启用日志记录功能的RAID扣卡信息。指定了RAID扣卡后,
                    可通过一键信息收集功能获取该RAID扣卡的日志,日志文件存放路径为“dump_info/LogDump/storage”

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

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

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.cli_api.cli_query_set_log_function_screw(params)