sushy.resources.eventservice 包

子模块

sushy.resources.eventservice.constants 模块

class sushy.resources.eventservice.constants.EventType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基础: Enum

ALERT = 'Alert'

需要关注的条件。

METRIC_REPORT = 'MetricReport'

遥测服务正在发送指标报告。

OTHER = 'Other'

由于 EventType 在 Redfish 规范 v1.6 中已弃用,因此事件基于注册表或资源,而不是 EventType。

RESOURCE_ADDED = 'ResourceAdded'

已添加资源。

RESOURCE_REMOVED = 'ResourceRemoved'

已删除资源。

RESOURCE_UPDATED = 'ResourceUpdated'

已更新资源。

STATUS_CHANGE = 'StatusChange'

资源的 status 已更改。

sushy.resources.eventservice.eventdestination 模块

class sushy.resources.eventservice.eventdestination.EventDestination(connector, identity, redfish_version=None, registries=None, root=None)

基类: ResourceBase

context = <sushy.resources.base.Field object>

一个客户端提供的字符串,存储在事件目标订阅中

delete()

删除 EventDestination

引发:

ConnectionError

引发:

HTTPError

description = <sushy.resources.base.Field object>

EventDestination 资源的描述

destination = <sushy.resources.base.Field object>

Event Service 目标的 URI

event_types = <sushy.resources.base.Field object>

将发送到目标的事件类型

http_headers = <sushy.resources.base.Field object>

用于设置 HTTP 标头,例如授权信息。在 GET 请求时,此对象将为空。

identity = <sushy.resources.base.Field object>

EventDestination 资源的身份

name = <sushy.resources.base.Field object>

EventDestination 资源的名称

protocol = <sushy.resources.base.Field object>

包含事件将用于将事件发送到目标的协议类型。应使用 Redfish 值来指示事件类型应遵循 Redfish 规范中定义的规范

class sushy.resources.eventservice.eventdestination.EventDestinationCollection(connector, identity, redfish_version=None, registries=None, root=None)

基类: ResourceCollectionBase

create(payload)

创建订阅

参数:

payload – 表示订阅的有效负载。

引发:

ConnectionError

引发:

HTTPError

返回值:

新的订阅

description = <sushy.resources.base.Field object>

EventDestination 集合的描述

name = <sushy.resources.base.Field object>

EventDestination 集合的名称

sushy.resources.eventservice.eventservice 模块

class sushy.resources.eventservice.eventservice.ActionsField(*args, **kwargs)

基类: CompositeField

submit_test_event = <sushy.resources.common.ActionField object>
class sushy.resources.eventservice.eventservice.EventService(connector, identity, redfish_version=None, registries=None, root=None)

基类: ResourceBase

delivery_retry_attempts = <sushy.resources.base.Field object>

在终止订阅之前,重试发布事件的次数。此重试在服务级别进行,这意味着 HTTP POST 到 Event Destination 由于 HTTP 操作返回了不成功(4xx 或 5xx 返回代码)或发生了 HTTP 超时而失败了这么多次

delivery_retry_interval = <sushy.resources.base.Field object>

重试发送任何给定事件的秒数间隔

event_types_for_subscription = <sushy.resources.base.Field object>

可以订阅的事件类型

get_event_types_for_subscription()

获取可以订阅的事件类型

返回值:

可以订阅的事件类型的集合。

identity = <sushy.resources.base.Field object>

EventService 资源的身份

name = <sushy.resources.base.Field object>

EventService 资源的名称

service_enabled = <sushy.resources.base.Field object>

指示 EventService 是否已启用

status = <sushy.resources.common.StatusField object>

EventService 的状态

submit_test_event(event_id, event_timestamp, event_type, message, message_args, message_id, origin, severity)

提交测试事件用于将测试事件发送到 BMC

参数:
  • event_id – 要添加的事件的 ID。

  • event_timestamp – 要添加的事件的时间戳。

  • event_type – 要添加的事件的类型。

  • message – 要添加的事件的人类可读消息。

  • message_args – 要添加的事件的消息参数数组。

  • message_id – 要添加的事件的消息 ID。

  • origin – 要添加的事件的 OriginOfCondition 属性中的 URL 字符串

  • severity – 要添加的事件的严重程度。

  • target – 调用操作的链接。

引发:

如果 EvenService 没有该操作,则会引发 MissingActionError。

property subscriptions

指向事件目标资源集合的引用

模块内容