GET/PATCH – EventService Properties (All)
Use the GET/PATCH method to retrieve properties in Event service resource for Redfish service.
Request URL
https://<SMM_IPADDR>/redfish/v1/EventService
Request body
None
Response body
Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
Actions | Object | Expanded | ||||||
#EventService.SubmitTestEvent | Object | Expanded | ||||||
target | String | "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent" | ||||||
DeliveryRetryAttempts | Integer | The number of times that the POST of an event is retried before the subscription terminates. | ||||||
DeliveryRetryIntervalSeconds | Integer | The interval, in seconds, between retry attempts for sending any event. | ||||||
EventFormatTypes | Array | [“Event” / “MetricReport”] | ||||||
Id | String | “EventService” | ||||||
Name | String | “Event Service” | ||||||
ServiceEnabled | Boolean | An indication of whether this service is enabled. | ||||||
OEM | Object | Expanded | ||||||
Lenovo | Object | Expanded | ||||||
PlatformEventFilter | link | “/redfish/v1/EventService/Oem/Lenovo/PlatformEventFilter” | ||||||
SNMPCommunity | String | String for SNMP community | ||||||
RegistryPrefixed | Array | [“Base” / “OpenBMC” / “TaskEvent”] | ||||||
ResourceTypes | Array | [“Task”] | ||||||
SMTP | Object | Settings for SMTP event delivery. | ||||||
Authentication | String | “None”, “AutoDetect”, “Plain”, “Login”, “CRAM_MD5” | ||||||
ConnectionProtocol | String | “None”, “AutoDetect”, “StartTLS”, “TLS_SSL” | ||||||
FromAddress | String | “SMM3-088FC3A76312@lenovo.com” | ||||||
Password | String | Null | ||||||
PasswordSet | Boolean | false | ||||||
Port | Integer | 25 | ||||||
ServerAddress | String | “0.0.0.0” | ||||||
Username | String | “” | ||||||
SSEFilterPropertiesSupported | Object | The set of properties that are supported in the `$filter` query parameter for the ServerSentEventUri. | ||||||
EventFormatType | Boolean | true | ||||||
MessageId | Boolean | true | ||||||
MetricReportDefinition | Boolean | true | ||||||
OriginResource | Boolean | false | ||||||
RegistryPrefix | Boolean | true | ||||||
ResourceType | Boolean | false | ||||||
ServerSentEventUri | String | “/redfish/v1/EventService/SSE” | ||||||
ServiceEnabled | Boolean | true | ||||||
Status | Object | The status and health of the resource and its subordinate or dependent resources. | ||||||
State | String | “Enabled” | ||||||
Subscriptions | Object | A collection of EventDestination Resource instances. | ||||||
REST operation – PATCH
| Operation | Properties | Comment |
| PATCH | Oem/Lenovo/SNMPCommunity | SNMP community string |