Skip to main content

GET – Event Service

Request

GET https://{{IP}}/redfish/v1/EventService
Content-Type: application/json

Response

  1. The Event Service resource contains properties for managing event subscriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations).

  2. The response of the request will be in JSON format. The properties are mentioned in the following.

Table 1. EventService Properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support.

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types.

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

ServiceEnabled(C)

Boolean

False

This indicates whether this service is enabled.

DeliveryRetryAttempts(C)

Number

False

  1. The number of retries attempted for any given event to the subscription destination before the subscription is terminated.

  2. The default value is 3.

  3. The value which should be within the range 1-10.

DeliveryRetryIntervalSeconds(C)

Number

False

  1. The interval in seconds between the retry attempts for any given event to the subscription destination.

  2. The default value is 60.

  3. The value which should be within the range 30-300.

EventFormatTypes

Array

True

Enum

Description

MetricReport

The Subscription destination will receive JSON bodies as MetricReport format only when the TelemetryService has generated a new Metric Report or updated an existing Metric Report.

Event

The Subscription destination will receive JSON bodies as Event format for all other types of Events.

RegistryPrefixes

Array

True

Prefixes of Message Registries that shall be allowed for an Event Subscription.

Supported values are: ["EventLog", "SyncAgent", "Security", "IPMI", "HttpStatus", "Base", "Task"]

ResourceTypes

Array

True

ResourceTypes values that shall be allowed for an Event Subscription.

Supported values are: ["Systems", "Chassis", "AccountService", "TelemetryService", "Managers", "EventService", "TaskService"]

SubordinateResourcesSupported

Boolean

True

Indicated Support the SubordinateResource property on Event Subscription.

Note
Default value is false.

Actions

Object

True

The Actions object contains the available custom actions on this resource like SubmitTestEvent or any Oem Action.

Status

Object

True

Refer to Resource Complex Types

Subscriptions(N)

Object

True

This is a reference to a collection of Event Destination resources. The value of this property shall contain the link to a collection of type EventDestinationCollection.

ServerSentEventUriString

True

Indicates the link to a URI for receiving Server-Sent Event representation for the events.

SSEFilterPropertiesSupported

Object

True

Set of properties that are supported in the $filter query parameter for the ServerSentEventUri.

Server Sent Event Filter properties

Supported

EventFormatType

True

MessageId

True

MetricReportDefinition

False

OriginResource

True

RegistryPrefix

True

ResourceType

True

SubordinateResources

False