Skip to main content

GET – Event service properties

Use the GET method to retrieve properties in Event service resource for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/EventService

Request body

None

Response body

FieldTypeDescription

Id

String

“EventService”

Name

String

“Event Service”

Description

String

This resource represents an event service for a Redfish implementation.

ServiceEnabled

Boolean

True

SSEFilterPropertiesSupported

Object

Expanded

 

SubordinateResources

Boolean

True

 

ResourceType

Boolean

True

 

EventFormatType

Boolean

True

 

RegistryPrefix

Boolean

True

 

OriginResource

Boolean

True

 

MetricReportDefinition

Boolean

True

 

MessageId

Boolean

True

DeliveryRetryAttempts

Integer

3

DeliveryRetryIntervalSeconds

Integer

60 (Unit: seconds)

ResourceTypes

Array

A list of @odata.type values (Schema names) that can be specified in a ResourceType on a subscription.

 

ResourceTypes[N]

String

Array element of ResourceTypes

Note
Alert event cannot be filtered by ResourceType.

Actions

Object

Expanded

 

#EventService.SubmitTestEvent

Object

Refer to Actions

Status

Object

Expanded

 

State

String

“Enabled”

 

Health

String

“OK”

EventFormatTypes

Array

Item: string

Item count: 2

 

EventFormatTypes[N]

String

Valid values: “Event”, “MetricReport”

SubordinateResourcesSupported

Boolean

Indicate if the service supports the SubordinateResource property on Event Subscriptions

RegistryPrefixes

Array

Item: string

Item count: maps to members under the resource /redfish/v1/Registries

 

RegistryPrefixes[N]

String

Maps to members under the resource /redfish/v1/Registries

Subscriptions

Link

Reference to event subscriptions of EventDestinationCollection type

ServerSentEventUri

Link

“/redfish/v1/EventService/ServerSentEvent”

SMTP

Object

Expanded

 

Authentication

String

The authentication method for the SMTP server.

 

Port

Number

The destination SMTP port.

 

ConnectionProtocol

String

The connection type to the outgoing SMTP server.

 

Password

String

The password for authentication with the SMTP server. The value is `null` in responses.

 

ServiceEnabled

Boolean

An indication if SMTP for event delivery is enabled.

 

FromAddress

String

The 'from' email address of the outgoing email.

 

Username

String

The username for authentication with the SMTP server.

 

Authentication@Redfish.AllowableValues

Array

Items: string

Item count: 3

  

Authentication @Redfish.AllowableValues[N]

String

"None", "Login","CRAM_MD5".

 

ConnectionProtocol@Redfish.AllowableValues

Array

Items: string

Item count: 1

  

ConnectionProtocol @Redfish.AllowableValues[N]

String

"AutoDetect".

 

ServerAddress

String

The address of the SMTP server.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"IncludeOriginOfConditionSupported": true,
"DeliveryRetryIntervalSeconds": 60,
"DeliveryRetryAttempts": 3,
"RegistryPrefixes": [
"Base",
"EventRegistry",
"ExtendedError",
"LenovoExtendedWarning",
"LenovoFirmwareUpdateRegistry",
"ResourceEvent",
"TaskEvent"
],
"SubordinateResourcesSupported": true,
"EventFormatTypes": [
"Event",
"MetricReport"
],
"@odata.etag": "\"b61666f78b2b2f04398a6\"",
"SMTP": {
"Password": null,
"ServiceEnabled": true,
"ConnectionProtocol@Redfish.AllowableValues": [
"AutoDetect"
],
"Authentication@Redfish.AllowableValues": [
"None",
"Login",
"CRAM_MD5"
],
"Username": "",
"Port": 25,
"ServerAddress": "0.0.0.0",
"Authentication": "None",
"FromAddress": null,
"ConnectionProtocol": "AutoDetect"
},
"ServiceEnabled": true,
"SSEFilterPropertiesSupported": {
"RegistryPrefix": true,
"OriginResource": true,
"ResourceType": true,
"MessageId": true,
"EventFormatType": true,
"SubordinateResources": true,
"MetricReportDefinition": true
},
"@odata.type": "#EventService.v1_6_0.EventService",
"Subscriptions": {
"@odata.id": "/redfish/v1/EventService/Subscriptions"
},
"Id": "EventService",
"Actions": {
"#EventService.SubmitTestEvent": {
"target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent",
"title": "SubmitTestEvent"
}
},
"Name": "Event Service",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"@odata.id": "/redfish/v1/EventService",
"ResourceTypes": [
"LogService"
],
"Description": "This resource represents an event service for a Redfish implementation.",
"ServerSentEventUri": "/redfish/v1/EventService/ServerSentEvent"
}