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.
DeliveryRetryAttempts			Integer	3
DeliveryRetryIntervalSeconds			Integer	60 (Unit: seconds)
EventFormatTypes			Array	Item: string Item count: 2
	EventFormatTypes[N]		String	Valid values: “Event” or “MetricReport”
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
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
IncludeOriginOfConditionSupported			Boolean	True
SubordinateResourcesSupported			Boolean	Indicate if the service supports the SubordinateResource property on Event Subscriptions.
SSEFilterPropertiesSupported			Object	Expanded.
	EventFormatType		Boolean	True
	MessageId		Boolean	True
	MetricReportDefinition		Boolean	True
	OriginResource		Boolean	True
	RegistryPrefix		Boolean	True
	ResourceType		Boolean	True
	SubordinateResources		Boolean	True
ServerSentEventUri			Link	/redfish/v1/EventService/ServerSentEvent
Subscriptions			Link	Reference to event subscriptions of EventDestinationCollection type.
ServiceEnabled			Boolean	True
Status			Object	Expanded.
	State		String	“Enabled”
	Health		String	“OK”
Actions			Object	Expanded.
	#EventService.SubmitTestEvent		Object	Refer to Actions
	title		String	SubmitTestEvent
	target		Link	/redfish/v1/EventService/Actions/EventService.SubmitTestEvent
SMTP			Object	Expanded.
	Authentication		String	The authentication method for the SMTP server.
	Authentication@Redfish.AllowableValues		Array	Items: string Item count: 3
		Authentication @Redfish.AllowableValues[N]	String	"None", "Login", "CRAM_MD5".
	ConnectionProtocol		String	The connection type to the outgoing SMTP server.
	ConnectionProtocol@Redfish.AllowableValues		Array	Items: string Item count: 1
		ConnectionProtocol @Redfish.AllowableValues[N]	String	"AutoDetect"
	FromAddress		String	The from email address of the outgoing email.
	Password		String	The password for authentication with the SMTP server. The value is null` in responses.
	Port		Number	The destination SMTP port.
	ServerAddress		String	The address of the SMTP server.
	ServiceEnabled		Boolean	An indication if SMTP for event delivery is enabled.
	Username		String	The username for authentication with the SMTP server.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#EventService.EventService",
    "@odata.etag": "\"E1C416CD\"",
    "@odata.id": "/redfish/v1/EventService",
    "@odata.type": "#EventService.v1_8_0.EventService",
    "Actions": {
        "#EventService.SubmitTestEvent": {
            "target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent",
            "title": "SubmitTestEvent"
        }
    },
    "DeliveryRetryAttempts": 3,
    "DeliveryRetryIntervalSeconds": 30,
    "Description": "This resource represents an event service for                     a Redfish implementation.",
    "EventFormatTypes": [
        "Event",
        "MetricReport"
    ],
    "Id": "EventService",
    "IncludeOriginOfConditionSupported": true,
    "Name": "Event Service",
    "RegistryPrefixes": [
        "Base",
        "TaskEvent",
        "EventRegistry",
        "UEFIEventRegistry",
        "LXPMEventRegistry"
    ],
    "ResourceTypes": [
        "Task",
        "Fan",
        "PowerSupply",
        "PowerSubsystem",
        "ComputerSystem",
        "Memory"
    ],
    "SMTP": {
        "Authentication": "None",
        "Authentication@Redfish.AllowableValues": [
            "Login",
            "CRAM_MD5",
            "None"
        ],
        "ConnectionProtocol": "AutoDetect",
        "ConnectionProtocol@Redfish.AllowableValues": [
            "AutoDetect"
        ],
        "FromAddress": "",
        "Password": null,
        "Port": 25,
        "ServerAddress": "0.0.0.0",
        "ServiceEnabled": true,
        "Username": ""
    },
    "SSEFilterPropertiesSupported": {
        "EventFormatType": true,
        "MessageId": true,
        "MetricReportDefinition": true,
        "OriginResource": true,
        "RegistryPrefix": true,
        "ResourceType": true,
        "SubordinateResources": true
    },
    "ServerSentEventUri": "/redfish/v1/EventService/ServerSentEvent",
    "ServiceEnabled": true,
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "SubordinateResourcesSupported": true,
    "Subscriptions": {
        "@odata.id": "/redfish/v1/EventService/Subscriptions"
    }
}

Give documentation feedback

GET – Event service properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example