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

Skip to content

# EventService 子类方法

1. redfish_event_query_event_service_resource
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询事件服务资源，查询服务器事件服务资源。

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

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

> 参数：

    1

    None

> 返回值：

    1

    response(Bunch): post命令返回体

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_event_query_event_service_resource()

2. redfish_event_modify_event_service_properties
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改事件服务资源，包括修改事件上报开关状态和修改事件主机标识源。

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

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

> 参数：

    1
    2

    enable_state(bool): 事件上报开关状态
    identity_source(str): 事件主机标识源

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1
    2
    3

    api_result = self.redfish_api.redfish_event_modify_event_service_properties(
    params["ServiceEnabled"], params["Oem"]["Huawei"]["ServerIdentitySource"]
    )

3. redfish_event_send_test_event
> 描述：

    1
    2
    3
    4
    5

    方法功能：模拟测试事件。

    命令格式：POST执行https://device_ip/redfish/v1/EventService/Actions/EventService.SubmitTestEvent

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

> 参数：

    1
    2
    3
    4
    5
    6
    7
    8

    event_type(str): 测试事件类型
    event_id(str): 模拟事件对应的事件码
    time_stamp(str): 模拟事件产生的时间戳
    severity(str): 模拟事件严重等级
    message(str): 模拟事件消息
    message_id(str): 模拟事件消息Id
    message_args(str): 模拟事件消息格式化参数
    origin_of_condition(str): 模拟事件关联的事件源列表

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    dispatch_result = self.host.dispatch("redfish_event_send_test_event", params=params)

4. redfish_event_resend_uncleared_events
> 描述：

    1
    2
    3
    4
    5

    方法功能：对未恢复的事件重新上报。

    命令格式：POST执行https://device_ip/redfish/v1/EventService/Actions/Oem/Huawei/EventService.Rearm

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    api_result = self.redfish_api.redfish_event_resend_uncleared_events()

5. redfish_event_simulate_component_based_alarms
> 描述：

    1
    2
    3
    4
    5

    方法功能：模拟精准告警。。

    命令格式：POST执行https://device_ip/redfish/v1/EventService/Actions/Oem/Huawei/EventService.MockPreciseAlarm

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

> 参数：

    1
    2
    3

    event_code_value(str): 事件码
    subject_index_value(int): 事件索引
    type_value(str): 操作类型

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1
    2
    3

    api_result = self.redfish_api.redfish_event_simulate_component_based_alarms(
    params["EventCode"], params["SubjectIndex"], params["Type"]
    )

6. redfish_event_query_event_subscription
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询事件订阅集合资源。

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

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

> 参数：

    1

    None

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    event_query = self.redfish_api.redfish_event_query_event_subscription()

7. redfish_event_create_event_subscription
> 描述：

    1
    2
    3
    4
    5

    方法功能：创建事件订阅资源。

    命令格式：POST执行https://device_ip/redfish/v1/EventService/Subscriptions

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

> 参数：

    1
    2
    3
    4
    5
    6
    7

    event_destination(str): 事件订阅接收地址
    event_types(list): 事件订阅监听的事件类型
    http_headers(dict): 事件订阅HTTP头参数，事件上报时携带。
    context(str): 事件订阅上下文信息
    protocal(str): 事件订阅使用的协议
    message_ids(list): 事件订阅消息Id匹配列表
    origin_resources(list): 事件订阅事件源匹配列表

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1
    2
    3
    4
    5
    6
    7
    8
    9

    api_result = self.redfish_api.redfish_event_create_event_subscription(
    params["Destination"],
    params["EventTypes"],
    params["HttpHeaders"],
    params["Context"],
    params["Protocol"],
    params["MessageIds"],
    params["OriginResources"],
    )

8. redfish_event_query_event_subscription_id
> 描述：

    1
    2
    3
    4
    5

    方法功能：查询事件订阅资源。

    命令格式：https://device_ip/redfish/v1/EventService/Subscriptions/id

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

> 参数：

    1

    id(str): 合法的事件订阅资源Id

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    event_query = self.redfish_api.redfish_event_query_event_subscription_id("1")

9. redfish_event_modify_event_subscription_properties
> 描述：

    1
    2
    3
    4
    5

    方法功能：修改事件订阅资源。

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

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

> 参数：

    1
    2
    3

    id(str): 合法的事件订阅资源ID
    http_headers(dict): 事件订阅HTTP头参数，事件上报时携带
    context(str): 事件订阅上下文

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1
    2
    3

    api_result = self.redfish_api.redfish_event_modify_event_subscription_properties(
    params["event_id"], params["HttpHeaders"], params["Context"]
    )

10. redfish_event_delete_event_subscription
> 描述：

    1
    2
    3
    4
    5

    方法功能：删除事件订阅资源。

    命令格式：DELETE执行https://device_ip/redfish/v1/EventService/Subscriptions/id

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

> 参数：

    1

    id(str): 合法的事件订阅资源Id

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    self.redfish_api.redfish_event_delete_event_subscription("1")

11. redfish_event_shield_system_event_report
> 描述：

    1
    2
    3
    4
    5

    方法功能：屏蔽系统事件上报。

    命令格式：POST执行https://device_ip/redfish/v1/EventService/Actions/Oem/Huawei/

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

> 参数：

    1
    2

    event_code_value(str): 事件码
    enabled(bool): 是否开启指定事件码的屏蔽功能

> 返回值：

    1

    result(dict): 命令返回体

> 异常：

    1

    None

> 举例：

    1

    ret = self.redfish_api.redfish_event_shield_system_event_report(params["EventCode"], params["Enabled"])