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

Skip to content

# Sms 子类方法

1. redfish_sms_query_upgrade_service
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    sms_id: 资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_upgrade_service(sms_id)

2. redfish_sms_perform_inband_software_firmware_upgrade
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    sms_id: 资源ID,
    image_uri: 升级包URL地址
    signal_uri: 升级包数字签名地址
    crl_uri: 升级包公钥文件地址
    image_type: 升级包类型
    transfer_protocol:传输协议
    user: URI访问用户名
    password: URI访问密码
    parameter: 升级参数
    active_method: 升级生效方式

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2
    3

    self.redfish_api.redfish_sms_perform_inband_software_firmware_upgrade(image_uri,
    signal_uri, crl_uri, image_type, transfer_protocol,
    user, password, parameter, active_method, sms_id)

3. redfish_sms_query_upgrade_progress
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    sms_id: 资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_upgrade_progress(sms_id)

4. redfish_sms_query_inband_upgrade_software
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    sms_id: 资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_inband_upgrade_software(sms_id)

5. redfish_sms_query_inband_upgrade_software_id
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2

    sms_id: 资源ID,
    item: 软件资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_inband_upgrade_software_id(item, sms_id)

6. redfish_sms_query_inband_upgrade_firmware
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    sms_id: 资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_inband_upgrade_firmware(params)

7. redfish_sms_query_inband_firmware_upgrade_id
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2

    sms_id: 资源ID,
    item: 软件资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_inband_firmware_upgrade_id(item, sms_id)

8. redfish_sms_perform_asynchronous_upgrade
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

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

    sms_id: 资源ID,
    Name:软件名称,多个名称使用半角逗号隔开，仅软件升级时使用
    ImageURI:升级包URL地址
    SignalURI:升级包数字签名地址
    CrlURI:升级包公钥文件地址
    ImageType:升级包类型
    User:URI访问用户名
    Password:URI访问密码
    Parameter:升级参数
    ActiveMethod:升级生效方式
    CrlURI:升级包Crl地址
    DownloadViaiBMC:是否通过iBMC下载
    AllowStop:是否允许停止

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_perform_asynchronous_upgrade(**params)

9. redfish_sms_make_asynchronous_upgrade
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3
    4

    sms_id: 资源ID,
    image_type: 升级类型
    active_method: 生效方式
    parameter: 生效接口参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    self.redfish_api.redfish_sms_make_asynchronous_upgrade(image_type,
    active_method, parameter, sms_id)

10. redfish_sms_upload_file
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    sms_id: 资源ID,
    ImageURI:文件包URL地址
    ChecksumType:校验和类型
    ChecksumData:校验和数值
    ITransferProtocol:使用的传输协议
    User:URI访问用户名
    Password:URI访问密码
    AllowStop:是否允许停止
    AllowOverwrite:是否允许覆盖
    DownloadViaiBMC:是否通过iBMC上传

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_upload_file(**params)

11. redfish_sms_query_task_service
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    sms_id: 资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_task_service(sms_id)

12. redfish_sms_query_task_information
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    sms_id: 资源ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_task_information(sms_id)

13. redfish_sms_query_task_information_id
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2

    sms_id: 资源ID,
    taskid: 待查询任务的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_query_task_information_id(taskid, sms_id)

14. redfish_sms_collect_logs
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10

    sms_id: 资源ID,
    Type:日志类型
    TargetDevice:目标设备IP地址
    MaxLogSizeMib 数字 日志最大限制
    Protocol:传输协议类型
    Port:数字 传输端口号
    User:用户名
    Password:密码
    LogPath:日志存放路径
    UploadViaiBMC:是否通过iBMC上传

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_sms_collect_logs(**params)