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

Skip to content

# DataAcquisitionService 子类方法

1. redfish_acquisition_query_dataacquisitionservice
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    params:(dict): 输入参数

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_query_dataacquisitionservice()

2. redfish_acquisition_modify_dataacquisitionservice
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3

    enable: 数据采集服务开关状态，可以取的合法值为：
    true:数据采集服务打开
    false:数据采集服务关闭

> 返回值：

    1

    response(dict): 数据采集服务资源

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_modify_dataacquisitionservice(enable)

3. redfish_acquisition_export_data_table
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    data_source: 需要导出的表格名

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_export_data_table(data_source)

4. redfish_acquisition_query_data_export_progress
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    taskid: 待查询任务的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_query_data_export_progress(task_id)

5. redfish_acquisition_query_data_exported
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    task_id: 待查询任务的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_query_data_exported(task_id)

6. redfish_acquisition_clear_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    None

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_clear_data()

7. redfish_acquisition_query_data_clear_progress
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    task_id: 待查询任务的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_query_data_clear_progress(task_id)

8. redfish_acquisition_query_data_table
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3
    4

    component: 需要查询的部件名，未指定时默认查询所有部件
    metric: 需要查询的指标类型，未指定时默认查询所有指标
    start_time: 起始时间
    end_time: 结束时间

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_query_data_table(component, metric, start_time, end_time)

9. redfish_acquisition_create_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1
    2
    3
    4

    componenttype: 需要查询的部件名，未指定时默认查询所有部件
    metrictype: 需要查询的指标类型，未指定时默认查询所有指标
    starttime: 起始时间
    endtime: 结束时间

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1
    2

    self.redfish_api.redfish_acquisition_create_data(componenttype,
    metrictype, starttime, endtime)

10. redfish_acquisition_query_data
> 描述：

    1
    2
    3
    4
    5

    方法功能：

    命令格式：

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

> 参数：

    1

    task_id: 待查询任务的ID

> 返回值：

    1

    response(str): 命令的返回值

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_acquisition_query_data(task_id)