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