1d125652eSGunnar Mills{
2d125652eSGunnar Mills    "$id": "http://redfish.dmtf.org/schemas/v1/EventService.v1_11_0.json",
3d125652eSGunnar Mills    "$ref": "#/definitions/EventService",
4d125652eSGunnar Mills    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5d125652eSGunnar Mills    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6d125652eSGunnar Mills    "definitions": {
7d125652eSGunnar Mills        "Actions": {
8d125652eSGunnar Mills            "additionalProperties": false,
9d125652eSGunnar Mills            "description": "The available actions for this resource.",
10d125652eSGunnar Mills            "longDescription": "This type shall contain the available actions for this resource.",
11d125652eSGunnar Mills            "patternProperties": {
12d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
14d125652eSGunnar Mills                    "type": [
15d125652eSGunnar Mills                        "array",
16d125652eSGunnar Mills                        "boolean",
17d125652eSGunnar Mills                        "integer",
18d125652eSGunnar Mills                        "number",
19d125652eSGunnar Mills                        "null",
20d125652eSGunnar Mills                        "object",
21d125652eSGunnar Mills                        "string"
22d125652eSGunnar Mills                    ]
23d125652eSGunnar Mills                }
24d125652eSGunnar Mills            },
25d125652eSGunnar Mills            "properties": {
26d125652eSGunnar Mills                "#EventService.SubmitTestEvent": {
27d125652eSGunnar Mills                    "$ref": "#/definitions/SubmitTestEvent"
28d125652eSGunnar Mills                },
29d125652eSGunnar Mills                "#EventService.TestEventSubscription": {
30d125652eSGunnar Mills                    "$ref": "#/definitions/TestEventSubscription"
31d125652eSGunnar Mills                },
32d125652eSGunnar Mills                "Oem": {
33d125652eSGunnar Mills                    "$ref": "#/definitions/OemActions",
34d125652eSGunnar Mills                    "description": "The available OEM-specific actions for this resource.",
35d125652eSGunnar Mills                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
36d125652eSGunnar Mills                }
37d125652eSGunnar Mills            },
38d125652eSGunnar Mills            "type": "object"
39d125652eSGunnar Mills        },
40d125652eSGunnar Mills        "EventService": {
41d125652eSGunnar Mills            "additionalProperties": false,
42d125652eSGunnar Mills            "description": "The `EventService` schema contains properties for managing event subscriptions and generates the events sent to subscribers.  The resource has links to the actual collection of subscriptions, which are called event destinations.",
43d125652eSGunnar Mills            "longDescription": "This resource shall represent an event service for a Redfish implementation.",
44d125652eSGunnar Mills            "patternProperties": {
45d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
46d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
47d125652eSGunnar Mills                    "type": [
48d125652eSGunnar Mills                        "array",
49d125652eSGunnar Mills                        "boolean",
50d125652eSGunnar Mills                        "integer",
51d125652eSGunnar Mills                        "number",
52d125652eSGunnar Mills                        "null",
53d125652eSGunnar Mills                        "object",
54d125652eSGunnar Mills                        "string"
55d125652eSGunnar Mills                    ]
56d125652eSGunnar Mills                }
57d125652eSGunnar Mills            },
58d125652eSGunnar Mills            "properties": {
59d125652eSGunnar Mills                "@odata.context": {
60d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
61d125652eSGunnar Mills                },
62d125652eSGunnar Mills                "@odata.etag": {
63d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
64d125652eSGunnar Mills                },
65d125652eSGunnar Mills                "@odata.id": {
66d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
67d125652eSGunnar Mills                },
68d125652eSGunnar Mills                "@odata.type": {
69d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
70d125652eSGunnar Mills                },
71d125652eSGunnar Mills                "Actions": {
72d125652eSGunnar Mills                    "$ref": "#/definitions/Actions",
73d125652eSGunnar Mills                    "description": "The available actions for this resource.",
74d125652eSGunnar Mills                    "longDescription": "This property shall contain the available actions for this resource."
75d125652eSGunnar Mills                },
76d125652eSGunnar Mills                "DeliveryRetryAttempts": {
77d125652eSGunnar Mills                    "description": "The number of times that the `POST` of an event is retried before the subscription terminates or is suspended.  This retry occurs at the service level, which means that the HTTP `POST` to the event destination fails with an HTTP `4XX` or `5XX` status code or an HTTP timeout occurs this many times before the event destination subscription terminates or is suspended.",
78d125652eSGunnar Mills                    "longDescription": "This property shall contain the number of times that the `POST` of an event is retried before the subscription terminates or is suspended.  This retry occurs at the service level, which means that the HTTP `POST` to the event destination fails with an HTTP `4XX` or `5XX` status code or an HTTP timeout occurs this many times before the event destination subscription terminates or is suspended.  The service shall delete the `EventDestination` resource to terminate the subscription.  The service shall set the value of the `State` property within `Status` of the `EventDestination` resource to `Disabled` for a suspended subscription.",
79d125652eSGunnar Mills                    "readonly": false,
80d125652eSGunnar Mills                    "type": "integer"
81d125652eSGunnar Mills                },
82d125652eSGunnar Mills                "DeliveryRetryIntervalSeconds": {
83d125652eSGunnar Mills                    "description": "The interval, in seconds, between retry attempts for sending any event.",
84d125652eSGunnar Mills                    "longDescription": "This property shall contain the interval, in seconds, between the retry attempts for any event sent to the subscription destination.",
85d125652eSGunnar Mills                    "readonly": false,
86d125652eSGunnar Mills                    "type": "integer",
87d125652eSGunnar Mills                    "units": "s"
88d125652eSGunnar Mills                },
89d125652eSGunnar Mills                "Description": {
90d125652eSGunnar Mills                    "anyOf": [
91d125652eSGunnar Mills                        {
92d125652eSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
93d125652eSGunnar Mills                        },
94d125652eSGunnar Mills                        {
95d125652eSGunnar Mills                            "type": "null"
96d125652eSGunnar Mills                        }
97d125652eSGunnar Mills                    ],
98d125652eSGunnar Mills                    "readonly": true
99d125652eSGunnar Mills                },
100d125652eSGunnar Mills                "EventFormatTypes": {
101d125652eSGunnar Mills                    "description": "The content types of the message that this service can send to the event destination.",
102d125652eSGunnar Mills                    "items": {
103d125652eSGunnar Mills                        "anyOf": [
104d125652eSGunnar Mills                            {
105d125652eSGunnar Mills                                "$ref": "http://redfish.dmtf.org/schemas/v1/EventDestination.json#/definitions/EventFormatType"
106d125652eSGunnar Mills                            },
107d125652eSGunnar Mills                            {
108d125652eSGunnar Mills                                "type": "null"
109d125652eSGunnar Mills                            }
110d125652eSGunnar Mills                        ]
111d125652eSGunnar Mills                    },
112d125652eSGunnar Mills                    "longDescription": "This property shall contain the content types of the message that this service can send to the event destination.  If this property is not present, the `EventFormatType` shall be assumed to be `Event`.",
113d125652eSGunnar Mills                    "readonly": true,
114d125652eSGunnar Mills                    "type": "array",
115d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
116d125652eSGunnar Mills                },
117d125652eSGunnar Mills                "EventTypesForSubscription": {
118d125652eSGunnar Mills                    "deprecated": "This property has been deprecated.  Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the `RegistryPrefix` and `ResourceType` properties and not on the `EventType` property.",
119d125652eSGunnar Mills                    "description": "The types of events to which a client can subscribe.",
120d125652eSGunnar Mills                    "items": {
121d125652eSGunnar Mills                        "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType"
122d125652eSGunnar Mills                    },
123d125652eSGunnar Mills                    "longDescription": "This property shall contain the types of events to which a client can subscribe.  The semantics associated with the enumeration values are defined in the Redfish Specification.",
124d125652eSGunnar Mills                    "readonly": true,
125d125652eSGunnar Mills                    "type": "array",
126d125652eSGunnar Mills                    "versionDeprecated": "v1_3_0"
127d125652eSGunnar Mills                },
128d125652eSGunnar Mills                "ExcludeMessageId": {
129d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `ExcludeMessageIds` property.",
130d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `ExcludeMessageIds` property.",
131d125652eSGunnar Mills                    "readonly": true,
132d125652eSGunnar Mills                    "type": "boolean",
133d125652eSGunnar Mills                    "versionAdded": "v1_8_0"
134d125652eSGunnar Mills                },
135d125652eSGunnar Mills                "ExcludeRegistryPrefix": {
136d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `ExcludeRegistryPrefixes` property.",
137d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `ExcludeRegistryPrefixes` property.",
138d125652eSGunnar Mills                    "readonly": true,
139d125652eSGunnar Mills                    "type": "boolean",
140d125652eSGunnar Mills                    "versionAdded": "v1_8_0"
141d125652eSGunnar Mills                },
142d125652eSGunnar Mills                "Id": {
143d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
144d125652eSGunnar Mills                    "readonly": true
145d125652eSGunnar Mills                },
146d125652eSGunnar Mills                "IncludeOriginOfConditionSupported": {
147d125652eSGunnar Mills                    "description": "An indication of whether the service supports including the resource payload of the origin of condition in the event payload.",
148d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether the service supports including the resource payload of the origin of condition in the event payload.  If `true`, event subscriptions are allowed to specify the `IncludeOriginOfCondition` property.",
149d125652eSGunnar Mills                    "readonly": true,
150d125652eSGunnar Mills                    "type": [
151d125652eSGunnar Mills                        "boolean",
152d125652eSGunnar Mills                        "null"
153d125652eSGunnar Mills                    ],
154d125652eSGunnar Mills                    "versionAdded": "v1_6_0"
155d125652eSGunnar Mills                },
156d125652eSGunnar Mills                "Name": {
157d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
158d125652eSGunnar Mills                    "readonly": true
159d125652eSGunnar Mills                },
160d125652eSGunnar Mills                "Oem": {
161d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
162d125652eSGunnar Mills                    "description": "The OEM extension property.",
163d125652eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
164d125652eSGunnar Mills                },
165d125652eSGunnar Mills                "RegistryPrefixes": {
166d125652eSGunnar Mills                    "description": "The list of the prefixes of the message registries that can be used for the `RegistryPrefixes` or `ExcludeRegistryPrefixes` properties on a subscription.  If this property is absent or contains an empty array, the service does not support registry prefix-based subscriptions.",
167d125652eSGunnar Mills                    "items": {
168d125652eSGunnar Mills                        "type": [
169d125652eSGunnar Mills                            "string",
170d125652eSGunnar Mills                            "null"
171d125652eSGunnar Mills                        ]
172d125652eSGunnar Mills                    },
173d125652eSGunnar Mills                    "longDescription": "This property shall contain the array of the prefixes of the message registries that shall be allowed or excluded for an event subscription.",
174d125652eSGunnar Mills                    "readonly": true,
175d125652eSGunnar Mills                    "type": "array",
176d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
177d125652eSGunnar Mills                },
178d125652eSGunnar Mills                "ResourceTypes": {
179d125652eSGunnar Mills                    "description": "The list of `@odata.type` values, or schema names, that can be specified in the `ResourceTypes` array in a subscription.  If this property is absent or contains an empty array, the service does not support resource type-based subscriptions.",
180d125652eSGunnar Mills                    "items": {
181d125652eSGunnar Mills                        "type": [
182d125652eSGunnar Mills                            "string",
183d125652eSGunnar Mills                            "null"
184d125652eSGunnar Mills                        ]
185d125652eSGunnar Mills                    },
186d125652eSGunnar Mills                    "longDescription": "This property shall specify an array of the valid `@odata.type` values that can be used for an event subscription.",
187d125652eSGunnar Mills                    "readonly": true,
188d125652eSGunnar Mills                    "type": "array",
189d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
190d125652eSGunnar Mills                },
191d125652eSGunnar Mills                "SMTP": {
192d125652eSGunnar Mills                    "$ref": "#/definitions/SMTP",
193d125652eSGunnar Mills                    "description": "Settings for SMTP event delivery.",
194d125652eSGunnar Mills                    "longDescription": "This property shall contain settings for SMTP event delivery.",
195d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
196d125652eSGunnar Mills                },
197d125652eSGunnar Mills                "SSEFilterPropertiesSupported": {
198d125652eSGunnar Mills                    "$ref": "#/definitions/SSEFilterPropertiesSupported",
199d125652eSGunnar Mills                    "description": "The set of properties that are supported in the `$filter` query parameter for the `ServerSentEventUri`.",
200d125652eSGunnar Mills                    "longDescription": "This property shall contain the properties that are supported in the `$filter` query parameter for the URI indicated by the `ServerSentEventUri` property, as described by the Redfish Specification.",
201d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
202d125652eSGunnar Mills                },
203d125652eSGunnar Mills                "SSEIncludeOriginOfConditionSupported": {
204d125652eSGunnar Mills                    "description": "An indication of whether the service supports the `includeoriginofcondition` query parameter for the `ServerSentEventUri`.",
205d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether the service supports the `includeoriginofcondition` query parameter for the `ServerSentEventUri`, as described by the Redfish Specification.",
206d125652eSGunnar Mills                    "readonly": true,
207d125652eSGunnar Mills                    "type": [
208d125652eSGunnar Mills                        "boolean",
209d125652eSGunnar Mills                        "null"
210d125652eSGunnar Mills                    ],
211d125652eSGunnar Mills                    "versionAdded": "v1_11_0"
212d125652eSGunnar Mills                },
213d125652eSGunnar Mills                "ServerSentEventUri": {
214d125652eSGunnar Mills                    "description": "The link to a URI for receiving Server-Sent Event representations for the events that this service generates.",
215d125652eSGunnar Mills                    "format": "uri-reference",
216d125652eSGunnar Mills                    "longDescription": "This property shall contain a URI that specifies an HTML5 Server-Sent Event-conformant endpoint.",
217d125652eSGunnar Mills                    "readonly": true,
218d125652eSGunnar Mills                    "type": "string",
219d125652eSGunnar Mills                    "versionAdded": "v1_1_0"
220d125652eSGunnar Mills                },
221d125652eSGunnar Mills                "ServiceEnabled": {
222d125652eSGunnar Mills                    "description": "An indication of whether this service is enabled.  If `false`, events are no longer published, new SSE connections cannot be established, and existing SSE connections are terminated.",
223d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service is enabled.  If `false`, events are no longer published, new SSE connections cannot be established, and existing SSE connections are terminated.",
224d125652eSGunnar Mills                    "readonly": false,
225d125652eSGunnar Mills                    "type": [
226d125652eSGunnar Mills                        "boolean",
227d125652eSGunnar Mills                        "null"
228d125652eSGunnar Mills                    ]
229d125652eSGunnar Mills                },
230d125652eSGunnar Mills                "Severities": {
231d125652eSGunnar Mills                    "description": "The list of severities that can be specified in the `Severities` array in a subscription.",
232d125652eSGunnar Mills                    "items": {
233d125652eSGunnar Mills                        "anyOf": [
234d125652eSGunnar Mills                            {
235d125652eSGunnar Mills                                "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health"
236d125652eSGunnar Mills                            },
237d125652eSGunnar Mills                            {
238d125652eSGunnar Mills                                "type": "null"
239d125652eSGunnar Mills                            }
240d125652eSGunnar Mills                        ]
241d125652eSGunnar Mills                    },
242d125652eSGunnar Mills                    "longDescription": "This property shall specify an array of the allowable severities that can be used for an event subscription.  If this property is absent or contains an empty array, the service does not support severity-based subscriptions.",
243d125652eSGunnar Mills                    "readonly": true,
244d125652eSGunnar Mills                    "type": "array",
245d125652eSGunnar Mills                    "versionAdded": "v1_9_0"
246d125652eSGunnar Mills                },
247d125652eSGunnar Mills                "Status": {
248d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
249d125652eSGunnar Mills                    "description": "The status and health of the resource and its subordinate or dependent resources.",
250d125652eSGunnar Mills                    "longDescription": "This property shall contain any status or health properties of the resource."
251d125652eSGunnar Mills                },
252d125652eSGunnar Mills                "SubordinateResourcesSupported": {
253d125652eSGunnar Mills                    "description": "An indication of whether the service supports the `SubordinateResources` property on both event subscriptions and generated events.",
254d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether the service supports the `SubordinateResources` property on both event subscriptions and generated events.",
255d125652eSGunnar Mills                    "readonly": true,
256d125652eSGunnar Mills                    "type": [
257d125652eSGunnar Mills                        "boolean",
258d125652eSGunnar Mills                        "null"
259d125652eSGunnar Mills                    ],
260d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
261d125652eSGunnar Mills                },
262d125652eSGunnar Mills                "Subscriptions": {
263d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/EventDestinationCollection.json#/definitions/EventDestinationCollection",
264d125652eSGunnar Mills                    "description": "The link to a collection of event destinations.",
265d125652eSGunnar Mills                    "longDescription": "This property shall contain the link to a resource collection of type `EventDestinationCollection`.",
266d125652eSGunnar Mills                    "readonly": true
267d125652eSGunnar Mills                }
268d125652eSGunnar Mills            },
269d125652eSGunnar Mills            "required": [
270d125652eSGunnar Mills                "@odata.id",
271d125652eSGunnar Mills                "@odata.type",
272d125652eSGunnar Mills                "Id",
273d125652eSGunnar Mills                "Name"
274d125652eSGunnar Mills            ],
275d125652eSGunnar Mills            "type": "object"
276d125652eSGunnar Mills        },
277d125652eSGunnar Mills        "OemActions": {
278d125652eSGunnar Mills            "additionalProperties": true,
279d125652eSGunnar Mills            "description": "The available OEM-specific actions for this resource.",
280d125652eSGunnar Mills            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
281d125652eSGunnar Mills            "patternProperties": {
282d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
283d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
284d125652eSGunnar Mills                    "type": [
285d125652eSGunnar Mills                        "array",
286d125652eSGunnar Mills                        "boolean",
287d125652eSGunnar Mills                        "integer",
288d125652eSGunnar Mills                        "number",
289d125652eSGunnar Mills                        "null",
290d125652eSGunnar Mills                        "object",
291d125652eSGunnar Mills                        "string"
292d125652eSGunnar Mills                    ]
293d125652eSGunnar Mills                }
294d125652eSGunnar Mills            },
295d125652eSGunnar Mills            "properties": {},
296d125652eSGunnar Mills            "type": "object"
297d125652eSGunnar Mills        },
298d125652eSGunnar Mills        "SMTP": {
299d125652eSGunnar Mills            "additionalProperties": false,
300d125652eSGunnar Mills            "description": "Settings for SMTP event delivery.",
301d125652eSGunnar Mills            "longDescription": "This type shall contain settings for SMTP event delivery.",
302d125652eSGunnar Mills            "patternProperties": {
303d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
304d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
305d125652eSGunnar Mills                    "type": [
306d125652eSGunnar Mills                        "array",
307d125652eSGunnar Mills                        "boolean",
308d125652eSGunnar Mills                        "integer",
309d125652eSGunnar Mills                        "number",
310d125652eSGunnar Mills                        "null",
311d125652eSGunnar Mills                        "object",
312d125652eSGunnar Mills                        "string"
313d125652eSGunnar Mills                    ]
314d125652eSGunnar Mills                }
315d125652eSGunnar Mills            },
316d125652eSGunnar Mills            "properties": {
317d125652eSGunnar Mills                "Authentication": {
318d125652eSGunnar Mills                    "anyOf": [
319d125652eSGunnar Mills                        {
320d125652eSGunnar Mills                            "$ref": "#/definitions/SMTPAuthenticationMethods"
321d125652eSGunnar Mills                        },
322d125652eSGunnar Mills                        {
323d125652eSGunnar Mills                            "type": "null"
324d125652eSGunnar Mills                        }
325d125652eSGunnar Mills                    ],
326d125652eSGunnar Mills                    "description": "The authentication method for the SMTP server.",
327d125652eSGunnar Mills                    "longDescription": "This property shall contain the authentication method for the SMTP server.",
328d125652eSGunnar Mills                    "readonly": false,
329d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
330d125652eSGunnar Mills                },
331d125652eSGunnar Mills                "ConnectionProtocol": {
332d125652eSGunnar Mills                    "anyOf": [
333d125652eSGunnar Mills                        {
334d125652eSGunnar Mills                            "$ref": "#/definitions/SMTPConnectionProtocol"
335d125652eSGunnar Mills                        },
336d125652eSGunnar Mills                        {
337d125652eSGunnar Mills                            "type": "null"
338d125652eSGunnar Mills                        }
339d125652eSGunnar Mills                    ],
340d125652eSGunnar Mills                    "description": "The connection type to the outgoing SMTP server.",
341d125652eSGunnar Mills                    "longDescription": "This property shall contain the connection type to the outgoing SMTP server.",
342d125652eSGunnar Mills                    "readonly": false,
343d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
344d125652eSGunnar Mills                },
345d125652eSGunnar Mills                "FromAddress": {
346d125652eSGunnar Mills                    "description": "The 'from' email address of the outgoing email.",
347d125652eSGunnar Mills                    "longDescription": "This property shall contain the email address to use for the 'from' field in an outgoing email.",
348d125652eSGunnar Mills                    "readonly": false,
349d125652eSGunnar Mills                    "type": [
350d125652eSGunnar Mills                        "string",
351d125652eSGunnar Mills                        "null"
352d125652eSGunnar Mills                    ],
353d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
354d125652eSGunnar Mills                },
355d125652eSGunnar Mills                "Password": {
356d125652eSGunnar Mills                    "description": "The password for authentication with the SMTP server.  The value is `null` in responses.",
357d125652eSGunnar Mills                    "longDescription": "This property shall contain the password for authentication with the SMTP server.  The value shall be `null` in responses.",
358d125652eSGunnar Mills                    "readonly": false,
359d125652eSGunnar Mills                    "type": [
360d125652eSGunnar Mills                        "string",
361d125652eSGunnar Mills                        "null"
362d125652eSGunnar Mills                    ],
363d125652eSGunnar Mills                    "versionAdded": "v1_5_0",
364d125652eSGunnar Mills                    "writeOnly": true
365d125652eSGunnar Mills                },
366d125652eSGunnar Mills                "PasswordSet": {
367d125652eSGunnar Mills                    "description": "Indicates if the `Password` property is set.",
368d125652eSGunnar Mills                    "longDescription": "This property shall contain `true` if a valid value was provided for the `Password` property.  Otherwise, the property shall contain `false`.",
369d125652eSGunnar Mills                    "readonly": true,
370d125652eSGunnar Mills                    "type": "boolean",
371d125652eSGunnar Mills                    "versionAdded": "v1_9_0"
372d125652eSGunnar Mills                },
373d125652eSGunnar Mills                "Port": {
374d125652eSGunnar Mills                    "description": "The destination SMTP port.",
375d125652eSGunnar Mills                    "longDescription": "This property shall contain the destination port for the SMTP server.",
376d125652eSGunnar Mills                    "maximum": 65535,
377d125652eSGunnar Mills                    "minimum": 0,
378d125652eSGunnar Mills                    "readonly": false,
379d125652eSGunnar Mills                    "type": [
380d125652eSGunnar Mills                        "integer",
381d125652eSGunnar Mills                        "null"
382d125652eSGunnar Mills                    ],
383d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
384d125652eSGunnar Mills                },
385d125652eSGunnar Mills                "ServerAddress": {
386d125652eSGunnar Mills                    "description": "The address of the SMTP server.",
387d125652eSGunnar Mills                    "longDescription": "This property shall contain the address of the SMTP server for outgoing email.",
388d125652eSGunnar Mills                    "readonly": false,
389d125652eSGunnar Mills                    "type": [
390d125652eSGunnar Mills                        "string",
391d125652eSGunnar Mills                        "null"
392d125652eSGunnar Mills                    ],
393d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
394d125652eSGunnar Mills                },
395d125652eSGunnar Mills                "ServiceEnabled": {
396d125652eSGunnar Mills                    "description": "An indication if SMTP for event delivery is enabled.",
397d125652eSGunnar Mills                    "longDescription": "This property shall indicate if SMTP for event delivery is enabled.",
398d125652eSGunnar Mills                    "readonly": false,
399d125652eSGunnar Mills                    "type": [
400d125652eSGunnar Mills                        "boolean",
401d125652eSGunnar Mills                        "null"
402d125652eSGunnar Mills                    ],
403d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
404d125652eSGunnar Mills                },
405d125652eSGunnar Mills                "Username": {
406d125652eSGunnar Mills                    "description": "The username for authentication with the SMTP server.",
407d125652eSGunnar Mills                    "longDescription": "This property shall contain the username for authentication with the SMTP server.",
408d125652eSGunnar Mills                    "readonly": false,
409d125652eSGunnar Mills                    "type": [
410d125652eSGunnar Mills                        "string",
411d125652eSGunnar Mills                        "null"
412d125652eSGunnar Mills                    ],
413d125652eSGunnar Mills                    "versionAdded": "v1_5_0"
414d125652eSGunnar Mills                }
415d125652eSGunnar Mills            },
416d125652eSGunnar Mills            "type": "object"
417d125652eSGunnar Mills        },
418d125652eSGunnar Mills        "SMTPAuthenticationMethods": {
419d125652eSGunnar Mills            "enum": [
420d125652eSGunnar Mills                "None",
421d125652eSGunnar Mills                "AutoDetect",
422d125652eSGunnar Mills                "Plain",
423d125652eSGunnar Mills                "Login",
424d125652eSGunnar Mills                "CRAM_MD5"
425d125652eSGunnar Mills            ],
426d125652eSGunnar Mills            "enumDeprecated": {
427d125652eSGunnar Mills                "Login": "This value has been deprecated in favor of `Plain`, which supersedes the LOGIN authentication method for SASL."
428d125652eSGunnar Mills            },
429d125652eSGunnar Mills            "enumDescriptions": {
430d125652eSGunnar Mills                "AutoDetect": "Auto-detect.",
431d125652eSGunnar Mills                "CRAM_MD5": "CRAM-MD5 authentication.",
432d125652eSGunnar Mills                "Login": "LOGIN authentication.",
433d125652eSGunnar Mills                "None": "No authentication.",
434d125652eSGunnar Mills                "Plain": "PLAIN authentication."
435d125652eSGunnar Mills            },
436d125652eSGunnar Mills            "enumLongDescriptions": {
437d125652eSGunnar Mills                "AutoDetect": "This value shall indicate authentication is auto-detected.",
438d125652eSGunnar Mills                "CRAM_MD5": "This value shall indicate authentication conforms to the RFC4954-defined AUTH CRAM-MD5 mechanism.",
439d125652eSGunnar Mills                "Login": "This value shall indicate authentication conforms to the RFC4954-defined AUTH LOGIN mechanism.",
440d125652eSGunnar Mills                "None": "This value shall indicate authentication is not required.",
441d125652eSGunnar Mills                "Plain": "This value shall indicate authentication conforms to the RFC4954-defined AUTH PLAIN mechanism."
442d125652eSGunnar Mills            },
443d125652eSGunnar Mills            "enumVersionDeprecated": {
444d125652eSGunnar Mills                "Login": "v1_7_0"
445d125652eSGunnar Mills            },
446d125652eSGunnar Mills            "type": "string"
447d125652eSGunnar Mills        },
448d125652eSGunnar Mills        "SMTPConnectionProtocol": {
449d125652eSGunnar Mills            "enum": [
450d125652eSGunnar Mills                "None",
451d125652eSGunnar Mills                "AutoDetect",
452d125652eSGunnar Mills                "StartTLS",
453d125652eSGunnar Mills                "TLS_SSL"
454d125652eSGunnar Mills            ],
455d125652eSGunnar Mills            "enumDescriptions": {
456d125652eSGunnar Mills                "AutoDetect": "Auto-detect.",
457d125652eSGunnar Mills                "None": "Clear text.",
458d125652eSGunnar Mills                "StartTLS": "StartTLS.",
459d125652eSGunnar Mills                "TLS_SSL": "TLS/SSL."
460d125652eSGunnar Mills            },
461d125652eSGunnar Mills            "enumLongDescriptions": {
462d125652eSGunnar Mills                "AutoDetect": "This value shall indicate the connection is auto-detected.",
463d125652eSGunnar Mills                "None": "This value shall indicate the connection is in clear text.",
464d125652eSGunnar Mills                "StartTLS": "This value shall indicate the connection conforms to the RFC3207-defined StartTLS extension.",
465d125652eSGunnar Mills                "TLS_SSL": "This value shall indicate the connection is TLS/SSL."
466d125652eSGunnar Mills            },
467d125652eSGunnar Mills            "type": "string"
468d125652eSGunnar Mills        },
469d125652eSGunnar Mills        "SSEFilterPropertiesSupported": {
470d125652eSGunnar Mills            "additionalProperties": false,
471d125652eSGunnar Mills            "description": "The set of properties that are supported in the `$filter` query parameter for the `ServerSentEventUri`.",
472d125652eSGunnar Mills            "longDescription": "The type shall contain a set of properties that are supported in the `$filter` query parameter for the URI indicated by the `ServerSentEventUri` property, as described by the Redfish Specification.",
473d125652eSGunnar Mills            "patternProperties": {
474d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
475d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
476d125652eSGunnar Mills                    "type": [
477d125652eSGunnar Mills                        "array",
478d125652eSGunnar Mills                        "boolean",
479d125652eSGunnar Mills                        "integer",
480d125652eSGunnar Mills                        "number",
481d125652eSGunnar Mills                        "null",
482d125652eSGunnar Mills                        "object",
483d125652eSGunnar Mills                        "string"
484d125652eSGunnar Mills                    ]
485d125652eSGunnar Mills                }
486d125652eSGunnar Mills            },
487d125652eSGunnar Mills            "properties": {
488d125652eSGunnar Mills                "EventFormatType": {
489d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `EventFormatType` property.",
490d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `EventFormatType` property.",
491d125652eSGunnar Mills                    "readonly": true,
492d125652eSGunnar Mills                    "type": "boolean",
493d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
494d125652eSGunnar Mills                },
495d125652eSGunnar Mills                "EventType": {
496d125652eSGunnar Mills                    "deprecated": "This property has been deprecated.  Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the `RegistryPrefix` and `ResourceType` properties and not on the `EventType` property.",
497d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `EventTypes` property.",
498d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `EventTypes` property.",
499d125652eSGunnar Mills                    "readonly": true,
500d125652eSGunnar Mills                    "type": "boolean",
501d125652eSGunnar Mills                    "versionAdded": "v1_2_0",
502d125652eSGunnar Mills                    "versionDeprecated": "v1_3_0"
503d125652eSGunnar Mills                },
504d125652eSGunnar Mills                "MessageId": {
505d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `MessageIds` property.",
506d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `MessageIds` property.",
507d125652eSGunnar Mills                    "readonly": true,
508d125652eSGunnar Mills                    "type": "boolean",
509d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
510d125652eSGunnar Mills                },
511d125652eSGunnar Mills                "MetricReportDefinition": {
512d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `MetricReportDefinitions` property.",
513d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `MetricReportDefinitions` property.",
514d125652eSGunnar Mills                    "readonly": true,
515d125652eSGunnar Mills                    "type": "boolean",
516d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
517d125652eSGunnar Mills                },
518d125652eSGunnar Mills                "OriginResource": {
519d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `OriginResources` property.",
520d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `OriginResources` property.",
521d125652eSGunnar Mills                    "readonly": true,
522d125652eSGunnar Mills                    "type": "boolean",
523d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
524d125652eSGunnar Mills                },
525d125652eSGunnar Mills                "RegistryPrefix": {
526d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `RegistryPrefixes` property.",
527d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `RegistryPrefixes` property.",
528d125652eSGunnar Mills                    "readonly": true,
529d125652eSGunnar Mills                    "type": "boolean",
530d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
531d125652eSGunnar Mills                },
532d125652eSGunnar Mills                "ResourceType": {
533d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `ResourceTypes` property.",
534d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `ResourceTypes` property.",
535d125652eSGunnar Mills                    "readonly": true,
536d125652eSGunnar Mills                    "type": "boolean",
537d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
538d125652eSGunnar Mills                },
539d125652eSGunnar Mills                "SubordinateResources": {
540d125652eSGunnar Mills                    "description": "An indication of whether the service supports filtering by the `SubordinateResources` property.",
541d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether this service supports filtering by the `SubordinateResources` property.",
542d125652eSGunnar Mills                    "readonly": true,
543d125652eSGunnar Mills                    "type": "boolean",
544d125652eSGunnar Mills                    "versionAdded": "v1_4_0"
545d125652eSGunnar Mills                }
546d125652eSGunnar Mills            },
547d125652eSGunnar Mills            "type": "object"
548d125652eSGunnar Mills        },
549d125652eSGunnar Mills        "SubmitTestEvent": {
550d125652eSGunnar Mills            "additionalProperties": false,
551d125652eSGunnar Mills            "description": "This action generates a test event.",
552d125652eSGunnar Mills            "longDescription": "This action shall add a test event to the event service with the event data specified in the action parameters.  Then, this message should be sent to any appropriate event destinations.",
553d125652eSGunnar Mills            "parameters": {
554d125652eSGunnar Mills                "EventGroupId": {
555d125652eSGunnar Mills                    "description": "The group identifier for the event.",
556d125652eSGunnar Mills                    "longDescription": "The parameter shall contain the group identifier for the event.  It has the same semantics as the `EventGroupId` property in the `Event` schema for Redfish.  If not provided by the client, the resulting event should not contain the `EventGroupId` property.",
557d125652eSGunnar Mills                    "type": "integer",
558d125652eSGunnar Mills                    "versionAdded": "v1_3_0"
559d125652eSGunnar Mills                },
560d125652eSGunnar Mills                "EventId": {
561d125652eSGunnar Mills                    "description": "The ID for the event to add.",
562d125652eSGunnar Mills                    "longDescription": "This parameter shall have the same semantics as the `EventId` property in the `Event` schema for Redfish.  A service can ignore this value and replace it with its own.  If not provided by the client, the resulting event may contain a service-defined `EventId` property.",
563d125652eSGunnar Mills                    "type": "string"
564d125652eSGunnar Mills                },
565d125652eSGunnar Mills                "EventTimestamp": {
566d125652eSGunnar Mills                    "description": "The date and time for the event to add.",
567d125652eSGunnar Mills                    "format": "date-time",
568d125652eSGunnar Mills                    "longDescription": "This parameter shall contain the date and time for the event to add and have the same semantics as the `EventTimestamp` property in the `Event` schema for Redfish.  If not provided by the client, the resulting event should not contain the `EventTimestamp` property.",
569d125652eSGunnar Mills                    "type": "string"
570d125652eSGunnar Mills                },
571d125652eSGunnar Mills                "EventType": {
572d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType",
573d125652eSGunnar Mills                    "deprecated": "This parameter has been deprecated.  Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the `RegistryPrefix` and `ResourceType` properties and not on the `EventType` property.",
574d125652eSGunnar Mills                    "description": "The type for the event to add.",
575d125652eSGunnar Mills                    "longDescription": "This parameter shall contain the property name for which the following allowable values apply.  If not provided by the client, the resulting event should not contain the `EventType` property.",
576d125652eSGunnar Mills                    "versionDeprecated": "v1_3_0"
577d125652eSGunnar Mills                },
578d125652eSGunnar Mills                "Message": {
579d125652eSGunnar Mills                    "description": "The human-readable message for the event to add.",
580d125652eSGunnar Mills                    "longDescription": "This parameter shall have the same semantics as the `Message` property in the `Event` schema for Redfish.  If not provided by the client, the resulting event should not contain the `Message` property.",
581d125652eSGunnar Mills                    "type": "string"
582d125652eSGunnar Mills                },
583d125652eSGunnar Mills                "MessageArgs": {
584d125652eSGunnar Mills                    "description": "An array of message arguments for the event to add.",
585d125652eSGunnar Mills                    "items": {
586d125652eSGunnar Mills                        "type": "string"
587d125652eSGunnar Mills                    },
588d125652eSGunnar Mills                    "longDescription": "This parameter shall have the same semantics as the `MessageArgs` property in the `Event` schema for Redfish.  If not provided by the client, the resulting event should not contain the `MessageArgs` property.",
589d125652eSGunnar Mills                    "type": "array"
590d125652eSGunnar Mills                },
591d125652eSGunnar Mills                "MessageId": {
592d125652eSGunnar Mills                    "description": "The `MessageId` for the event to add.",
593d125652eSGunnar Mills                    "longDescription": "This parameter shall contain the `MessageId` for the event to add and have the same semantics as the `MessageId` property in the `Event` schema for Redfish.  Services should accept arbitrary values for this parameter that match that match the defined pattern.",
594d125652eSGunnar Mills                    "pattern": "^\\w+\\.\\d+\\.\\d+\\.\\w+$",
595d125652eSGunnar Mills                    "requiredParameter": true,
596d125652eSGunnar Mills                    "type": "string"
597d125652eSGunnar Mills                },
598d125652eSGunnar Mills                "MessageSeverity": {
599d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health",
600d125652eSGunnar Mills                    "description": "The severity for the event to add.",
601d125652eSGunnar Mills                    "longDescription": "This property shall contain the severity for the event to add and have the same semantics as the `MessageSeverity` property in the `Event` schema for Redfish.  If not provided by the client, the resulting event should not contain the `MessageSeverity` property.",
602d125652eSGunnar Mills                    "versionAdded": "v1_10_0"
603d125652eSGunnar Mills                },
604d125652eSGunnar Mills                "OriginOfCondition": {
605d125652eSGunnar Mills                    "description": "The URL in the `OriginOfCondition` property of the event to add.  It is not a reference object.",
606d125652eSGunnar Mills                    "format": "uri-reference",
607d125652eSGunnar Mills                    "longDescription": "This parameter shall be a string that represents the URL contained by the `OriginOfCondition` property in the `Event` schema for Redfish.  If not provided by the client, the resulting event should not contain the `OriginOfCondition` property.",
608d125652eSGunnar Mills                    "type": "string"
609d125652eSGunnar Mills                },
610d125652eSGunnar Mills                "Severity": {
611d125652eSGunnar Mills                    "description": "The severity for the event to add.",
612d125652eSGunnar Mills                    "longDescription": "This parameter shall contain the severity for the event to add and have the same semantics as the `Severity` property in the `Event` schema for Redfish.  If not provided by the client, the resulting event should not contain the `Severity` property.",
613d125652eSGunnar Mills                    "type": "string"
614d125652eSGunnar Mills                }
615d125652eSGunnar Mills            },
616d125652eSGunnar Mills            "patternProperties": {
617d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
618d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
619d125652eSGunnar Mills                    "type": [
620d125652eSGunnar Mills                        "array",
621d125652eSGunnar Mills                        "boolean",
622d125652eSGunnar Mills                        "integer",
623d125652eSGunnar Mills                        "number",
624d125652eSGunnar Mills                        "null",
625d125652eSGunnar Mills                        "object",
626d125652eSGunnar Mills                        "string"
627d125652eSGunnar Mills                    ]
628d125652eSGunnar Mills                }
629d125652eSGunnar Mills            },
630d125652eSGunnar Mills            "properties": {
631d125652eSGunnar Mills                "target": {
632d125652eSGunnar Mills                    "description": "Link to invoke action",
633d125652eSGunnar Mills                    "format": "uri-reference",
634d125652eSGunnar Mills                    "type": "string"
635d125652eSGunnar Mills                },
636d125652eSGunnar Mills                "title": {
637d125652eSGunnar Mills                    "description": "Friendly action name",
638d125652eSGunnar Mills                    "type": "string"
639d125652eSGunnar Mills                }
640d125652eSGunnar Mills            },
641d125652eSGunnar Mills            "type": "object"
642d125652eSGunnar Mills        },
643d125652eSGunnar Mills        "TestEventSubscription": {
644d125652eSGunnar Mills            "additionalProperties": false,
645d125652eSGunnar Mills            "description": "This action generates a test event using the pre-defined test message.",
646d125652eSGunnar Mills            "longDescription": "This action shall send an event containing the `TestMessage` message from the Resource Event Message Registry to all appropriate event destinations.",
647d125652eSGunnar Mills            "parameters": {},
648d125652eSGunnar Mills            "patternProperties": {
649d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
650d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
651d125652eSGunnar Mills                    "type": [
652d125652eSGunnar Mills                        "array",
653d125652eSGunnar Mills                        "boolean",
654d125652eSGunnar Mills                        "integer",
655d125652eSGunnar Mills                        "number",
656d125652eSGunnar Mills                        "null",
657d125652eSGunnar Mills                        "object",
658d125652eSGunnar Mills                        "string"
659d125652eSGunnar Mills                    ]
660d125652eSGunnar Mills                }
661d125652eSGunnar Mills            },
662d125652eSGunnar Mills            "properties": {
663d125652eSGunnar Mills                "target": {
664d125652eSGunnar Mills                    "description": "Link to invoke action",
665d125652eSGunnar Mills                    "format": "uri-reference",
666d125652eSGunnar Mills                    "type": "string"
667d125652eSGunnar Mills                },
668d125652eSGunnar Mills                "title": {
669d125652eSGunnar Mills                    "description": "Friendly action name",
670d125652eSGunnar Mills                    "type": "string"
671d125652eSGunnar Mills                }
672d125652eSGunnar Mills            },
673d125652eSGunnar Mills            "type": "object",
674d125652eSGunnar Mills            "versionAdded": "v1_10_0"
675d125652eSGunnar Mills        }
676d125652eSGunnar Mills    },
677d125652eSGunnar Mills    "language": "en",
678d125652eSGunnar Mills    "owningEntity": "DMTF",
679d125652eSGunnar Mills    "release": "2025.1",
680d125652eSGunnar Mills    "title": "#EventService.v1_11_0.EventService"
681d125652eSGunnar Mills}