1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/EventService.v1_4_0.json",
"$ref": "#/definitions/EventService",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this Resource.",
"longDescription": "This type shall contain the available actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"#EventService.SubmitTestEvent": {
"$ref": "#/definitions/SubmitTestEvent"
},
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this Resource."
}
},
"type": "object"
},
"EventFormatType": {
"enum": [
"Event",
"MetricReport"
],
"enumDescriptions": {
"Event": "The subscription destination receives JSON bodies of the Event type.",
"MetricReport": "The subscription destination receives JSON bodies of the MetricReport type."
},
"type": "string"
},
"EventService": {
"additionalProperties": false,
"description": "The EventService schema contains properties for managing event subcriptions and generates the events sent to subscribers. The Resource has links to the actual collection of subscriptions, which are called event destinations.",
"longDescription": "This Resource shall represent an Event Service for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this Resource.",
"longDescription": "This property shall contain the available actions for this Resource."
},
"DeliveryRetryAttempts": {
"description": "The number of times that the POST of an event is retried before the subscription terminates. 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.",
"longDescription": "This property shall contain the number of times that the POST of an event is retried before the subscription terminates. 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.",
"readonly": false,
"type": "integer"
},
"DeliveryRetryIntervalSeconds": {
"description": "The interval, in seconds, between retry attempts for sending any event.",
"longDescription": "This property shall contain the interval, in seconds, between the retry attempts for any event sent to the subscription destination.",
"readonly": false,
"type": "integer",
"units": "s"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"EventFormatTypes": {
"description": "The content types of the message that this service can send to the event destination.",
"items": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/EventDestination.json#/definitions/EventFormatType"
},
{
"type": "null"
}
]
},
"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`.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"EventTypesForSubscription": {
"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.",
"description": "The types of events to which a client can subscribe.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType"
},
"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.",
"readonly": true,
"type": "array",
"versionDeprecated": "v1_3_0"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
},
"RegistryPrefixes": {
"description": "The list of the prefixes of the Message Registries that can be used for the RegistryPrefix property on a subscription. If this property is absent or contains an empty array, the service does not support RegistryPrefix-based subscriptions.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain the array of the prefixes of the Message Registries that shall be allowed for an event subscription.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"ResourceTypes": {
"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.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall specify an array of the valid @odata.type values that can be used for an event subscription.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"SSEFilterPropertiesSupported": {
"$ref": "#/definitions/SSEFilterPropertiesSupported",
"description": "The set of properties that are supported in the $filter query parameter for the ServerSentEventUri.",
"longDescription": "This property shall contain the properties that are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property.",
"versionAdded": "v1_2_0"
},
"ServerSentEventUri": {
"description": "The link to a URI for receiving Server-Sent Event representations for the events that this service generates.",
"format": "uri-reference",
"longDescription": "This property shall contain a URI that specifies an HTML5 Server-Sent Event-conformant endpoint.",
"readonly": true,
"type": "string",
"versionAdded": "v1_1_0"
},
"ServiceEnabled": {
"description": "An indication of whether this service is enabled.",
"longDescription": "This property shall indicate whether this service is enabled.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "The status and health of the Resource and its subordinate or dependent Resources.",
"longDescription": "This property shall contain any status or health properties of the Resource."
},
"SubordinateResourcesSupported": {
"description": "An indication of whether the service supports the SubordinateResource property on both event subscriptions and generated events.",
"longDescription": "This property shall indicate whether the service supports the SubordinateResource property on both event subscriptions and generated events.",
"readonly": true,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_2_0"
},
"Subscriptions": {
"$ref": "http://redfish.dmtf.org/schemas/v1/EventDestinationCollection.json#/definitions/EventDestinationCollection",
"description": "The link to a collection of event destination Resources.",
"longDescription": "This property shall contain the link to a Resource Collection of type EventDestinationCollection.",
"readonly": true
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"SSEFilterPropertiesSupported": {
"additionalProperties": false,
"description": "The set of properties that are supported in the $filter query parameter for the ServerSentEventUri.",
"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.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"EventFormatType": {
"description": "An indication of whether the service supports the EventFormatType property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the EventFormatType property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_2_0"
},
"EventType": {
"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.",
"description": "An indication of whether the service supports the EventType property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the EventType property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_2_0",
"versionDeprecated": "v1_3_0"
},
"MessageId": {
"description": "An indication of whether the service supports the MessageId property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the MessageId property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_2_0"
},
"MetricReportDefinition": {
"description": "An indication of whether the service supports the MetricReportDefinition property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the MetricReportDefinition property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_2_0"
},
"OriginResource": {
"description": "An indication of whether the service supports the OriginResource property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the OriginResource property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_2_0"
},
"RegistryPrefix": {
"description": "An indication of whether the service supports the RegistryPrefix property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the RegistryPrefix property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_2_0"
},
"ResourceType": {
"description": "An indication of whether the service supports the ResourceType property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the ResourceType property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_2_0"
},
"SubordinateResources": {
"description": "An indication of whether the service supports the SubordinateResources property in the $filter query parameter.",
"longDescription": "This property shall indicate whether this service supports the SubordinateResources property in the $filter query parameter, as described by the Redfish Specification.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_4_0"
}
},
"type": "object"
},
"SubmitTestEvent": {
"additionalProperties": false,
"description": "This action generates a test event.",
"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.",
"parameters": {
"EventGroupId": {
"description": "The group ID for the event.",
"longDescription": "The parameter shall contain the group ID for the event. It has the same semantics as the EventGroupId property in the Event schema for Redfish.",
"type": "integer",
"versionAdded": "v1_3_0"
},
"EventId": {
"description": "The ID for the event to add.",
"longDescription": "This parameter shall have the same semantics as the EventId property in the Event schema for Redfish. A service may ignore this value and replace it with its own.",
"type": "string"
},
"EventTimestamp": {
"description": "The date and time stamp for the event to add.",
"format": "date-time",
"longDescription": "This parameter shall contain the date and time stamp for the event to add and have the same semantics as the EventTimestamp property in the Event schema for Redfish.",
"type": "string"
},
"EventType": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType",
"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.",
"description": "The type for the event to add.",
"longDescription": "This parameter shall contain the property name for which the following allowable values apply.",
"versionDeprecated": "v1_3_0"
},
"Message": {
"description": "The human-readable message for the event to add.",
"longDescription": "This parameter shall have the same semantics as the Message property in the Event schema for Redfish.",
"type": "string"
},
"MessageArgs": {
"description": "An array of message arguments for the event to add.",
"items": {
"type": "string"
},
"longDescription": "This parameter shall have the same semantics as the MessageArgs property in the Event schema for Redfish.",
"type": "array"
},
"MessageId": {
"description": "The MessageId for the event to add.",
"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.",
"requiredParameter": true,
"type": "string"
},
"OriginOfCondition": {
"description": "The URL in the OriginOfCondition property of the event to add. It is not a reference object.",
"format": "uri-reference",
"longDescription": "This parameter shall be a string that represents the URL contained by the OriginOfCondition property in the Event schema for Redfish.",
"type": "string"
},
"Severity": {
"description": "The severity for the event to add.",
"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.",
"type": "string"
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2019.2",
"title": "#EventService.v1_4_0.EventService"
}
|
