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

Skip to content

# Public 子类方法

1. redfish_public_get_version
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询Redfish版本信息

    命令格式：PATCH执行https://device_ip/redfish/v1

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): Redfish版本信息

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_get_version()

2. redfish_public_get_root_service_resource
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询当前根服务资源

    命令格式：https://device_ip/redfish/v1

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): 根服务资源

> 异常：

    1

    None

> 举例：

    1

    ret = redfish_api.redfish_public_get_root_service_resource()

3. redfish_public_modify_root_service_resource
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改当前根服务资源

    命令格式：PATCH执行https://device_ip/redfish/v1

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

> 参数：

    1

    modify_params(dict): {"UUID": uuid_value}

> 返回值：

    1

    result(dict): 根服务资源

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_modify_root_service_resource(modify_params=params)

4. redfish_public_query_metadata_doc
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询Metadata文档

    命令格式：https://device_ip/redfish/v1/$metadata

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): Metadata文档内容

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_metadata_doc()

5. redfish_public_query_schema
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询所有资源的Schema文件

    命令格式：https://device_ip/redfish/v1/JSONSchemas

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): 服务器当前所有资源的Schema文件

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_schema()

6. redfish_public_query_singe_schema
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询单个Schema文件归档地址

    命令格式：https://device_ip/redfish/v1/JSONSchemas/member_id

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

> 参数：

    1

    member_id(str): 需要查询的Schema文件名

> 返回值：

    1

    result(dict): 单个Schema文件归档资源详情

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_singe_schema("HwSmsService.v1_0_0")

7. redfish_public_query_single_schema_file_resource
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询单个Schema文件资源

    命令格式：https://device_ip/redfish/v1/SchemaStore/language_id/file_id

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

> 参数：

    1
    2

    language_id(str): 模式所在文件的语言代码
    file_id(str): 需要查询的Schema文件名

> 返回值：

    1

    result(dict): 单个Schema文件资源

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_single_schema_file_resource("en", "Volume.v1_0_0.json")

8. redfish_public_query_all_registries
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询所有归档资源

    命令格式：https://device_ip/redfish/v1/Registries

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): 所有的归档文件资源

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_all_registries()

9. redfish_public_query_single_registries
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询单个归档资源

    命令格式：https://device_ip/redfish/v1/Registries/registries_id

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

> 参数：

    1

    registries_id(str): 归档资源ID,通过查询所有归档资源获得。

> 返回值：

    1

    result(dict): 具体的消息归档文件资源

> 异常：

    1

    None

> 举例：

    1

    registries_info = self.redfish_api.redfish_public_query_single_registries(bios_attr_file_name)

10. redfish_public_query_odata_service
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询OData服务文档

    命令格式：https://device_ip/redfish/v1/odata

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): OData服务文档

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_odata_service()

11. redfish_public_query_system_overview
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询系统概览信息

    命令格式：https://device_ip/redfish/v1/SystemOverview

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): 系统概览信息

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_system_overview()

12. redfish_public_query_single_registries_json
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询单个注册资源文件

    命令格式：https://device_ip/redfish/v1/RegistryStore/AttributeRegistries/en/registries_file_name/

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

> 参数：

    1

    registries_file_name(str): 归档资源文件名，通过查询单个归档资源接口获取

> 返回值：

    1

    result(dict): 归档资源文件信息

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_public_query_single_registries_json(language, registries_file_name)