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
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
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 Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"ServiceEnabled": true,
"SubordinateResourcesSupported": true,
"Subscriptions": {
"@odata.id": "/redfish/v1/EventService/Subscriptions"
},
"Status": {
"State": "Enabled",
"Health": "OK"
},
"DeliveryRetryAttempts": 3,
"ResourceTypes": [
"LogService"
],
"SSEFilterPropertiesSupported": {
"EventFormatType": true,
"RegistryPrefix": true,
"MetricReportDefinition": true,
"SubordinateResources": true,
"MessageId": true,
"ResourceType": true,
"OriginResource": true
},
"EventFormatTypes": [
"Event",
"MetricReport"
],
"SMTP": {
"ServiceEnabled": true,
"Authentication": "None",
"Username": "",
"Port": 25,
"Password": null,
"FromAddress": null,
"ConnectionProtocol@Redfish.AllowableValues": [
"AutoDetect"
],
"Authentication@Redfish.AllowableValues": [
"None",
"Login",
"CRAM_MD5"
],
"ServerAddress": "0.0.0.0",
"ConnectionProtocol": "AutoDetect"
},
"Description": "This resource represents an event service for a Redfish implementation.",
"Actions": {
"#EventService.SubmitTestEvent": {
"target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent",
"title": "SubmitTestEvent"
}
},
"IncludeOriginOfConditionSupported": true,
"@odata.context": "/redfish/v1/$metadata#EventService.EventService",
"ServerSentEventUri": "/redfish/v1/EventService/ServerSentEvent",
"Id": "EventService",
"Name": "Event Service",
"@odata.type": "#EventService.v1_7_2.EventService",
"@odata.id": "/redfish/v1/EventService",
"RegistryPrefixes": [
"Base",
"EventRegistry",
"ExtendedError",
"HeartbeatEvent",
"LenovoExtendedWarning",
"LenovoFirmwareUpdateRegistry",
"License",
"LogService",
"ResourceEvent",
"Update"
],
"DeliveryRetryIntervalSeconds": 60,
"@odata.etag": "\"c27bc313923931dafbb82\""
}