1<?xml version="1.0" encoding="UTF-8"?> 2<!----> 3<!--################################################################################ --> 4<!--# Redfish Schema: EventDestination v1.8.1 --> 5<!--# --> 6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, --> 7<!--# available at http://www.dmtf.org/standards/redfish --> 8<!--# Copyright 2014-2020 DMTF. --> 9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright --> 10<!--################################################################################ --> 11<!----> 12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0"> 13 14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml"> 15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/> 16 </edmx:Reference> 17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml"> 18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/> 19 </edmx:Reference> 20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml"> 21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/> 22 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/> 23 </edmx:Reference> 24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml"> 25 <edmx:Include Namespace="Resource"/> 26 <edmx:Include Namespace="Resource.v1_0_0"/> 27 </edmx:Reference> 28 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Event_v1.xml"> 29 <edmx:Include Namespace="Event"/> 30 </edmx:Reference> 31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportDefinition_v1.xml"> 32 <edmx:Include Namespace="MetricReportDefinition"/> 33 </edmx:Reference> 34 35 <edmx:DataServices> 36 37 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination"> 38 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 39 40 <EntityType Name="EventDestination" BaseType="Resource.v1_0_0.Resource" Abstract="true"> 41 <Annotation Term="OData.Description" String="The EventDestination schema defines the target of an event subscription, including the event types and context to provide to the target in the Event payload."/> 42 <Annotation Term="OData.LongDescription" String="This Resource shall represent the target of an event subscription, including the event types and context to provide to the target in the Event payload."/> 43 <Annotation Term="Capabilities.InsertRestrictions"> 44 <Record> 45 <PropertyValue Property="Insertable" Bool="false"/> 46 </Record> 47 </Annotation> 48 <Annotation Term="Capabilities.UpdateRestrictions"> 49 <Record> 50 <PropertyValue Property="Updatable" Bool="true"/> 51 <Annotation Term="OData.Description" String="Writable properties, such as Context, can be updated for an event destination."/> 52 </Record> 53 </Annotation> 54 <Annotation Term="Capabilities.DeleteRestrictions"> 55 <Record> 56 <PropertyValue Property="Deletable" Bool="true"/> 57 <Annotation Term="OData.Description" String="When client no longer needs to received event notifications, it can delete an event destination."/> 58 </Record> 59 </Annotation> 60 <Annotation Term="Redfish.Uris"> 61 <Collection> 62 <String>/redfish/v1/EventService/Subscriptions/{EventDestinationId}</String> 63 </Collection> 64 </Annotation> 65 </EntityType> 66 67 <Action Name="ResumeSubscription" IsBound="true"> 68 <Annotation Term="OData.Description" String="This action resumes a suspended event subscription."/> 69 <Annotation Term="OData.LongDescription" String="This action shall resume a suspended event subscription, which affects the subscription status."/> 70 <Parameter Name="EventDestination" Type="EventDestination.v1_2_0.Actions"/> 71 </Action> 72 73 <EnumType Name="EventFormatType"> 74 <Annotation Term="Redfish.Revisions"> 75 <Collection> 76 <Record> 77 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 78 <PropertyValue Property="Version" String="v1_4_0"/> 79 </Record> 80 </Collection> 81 </Annotation> 82 <Member Name="Event"> 83 <Annotation Term="OData.Description" String="The subscription destination receives JSON bodies of the Resource of type Event."/> 84 </Member> 85 <Member Name="MetricReport"> 86 <Annotation Term="OData.Description" String="The subscription destination receives JSON bodies of the Resource of type MetricReport."/> 87 </Member> 88 </EnumType> 89 90 </Schema> 91 92 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_0"> 93 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 94 <Annotation Term="Redfish.Release" String="1.0"/> 95 96 <EntityType Name="EventDestination" BaseType="EventDestination.EventDestination"> 97 <Property Name="Destination" Type="Edm.String" Nullable="false"> 98 <Annotation Term="Redfish.RequiredOnCreate"/> 99 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 100 <Annotation Term="OData.Description" String="The URI of the destination event receiver."/> 101 <Annotation Term="OData.LongDescription" String="This property shall contain a URI to the destination where the events are sent. If Protocol is `SMTP`, the URI shall follow the RFC6068-described format. SNMP URIs shall be consistent with RFC4088. Specifically, for SNMPv3, if a username is specified in the SNMP URI, the SNMPv3 authentication and encryption configuration associated with that user shall be utilized in the SNMPv3 traps. For other URIs, such as HTTP or HTTPS, they shall be consistent with RFC3986."/> 102 <Annotation Term="OData.IsURL"/> 103 </Property> 104 <Property Name="EventTypes" Type="Collection(Event.EventType)" Nullable="false"> 105 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 106 <Annotation Term="OData.Description" String="The types of events that are sent to the destination."/> 107 <Annotation Term="OData.LongDescription" String="This property shall contain an array that contains the types of events that shall be sent to the destination. To specify that a client is subscribing for Metric Reports, the EventTypes property should include 'MetricReport'. If the subscription does not include this property, the service shall use a single element with a default of `Other`."/> 108 <Annotation Term="Redfish.Revisions"> 109 <Collection> 110 <Record> 111 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/> 112 <PropertyValue Property="Version" String="v1_5_0"/> 113 <PropertyValue Property="Description" String="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. Use EventFormatType to create subscriptions for Metric Reports. If the subscription does not include this property, the service shall use a single element with a default of `Other`."/> 114 </Record> 115 </Collection> 116 </Annotation> 117 </Property> 118 <Property Name="Context" Type="Edm.String"> 119 <Annotation Term="Redfish.Required"/> 120 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 121 <Annotation Term="OData.Description" String="A client-supplied string that is stored with the event destination subscription."/> 122 <Annotation Term="OData.LongDescription" String="This property shall contain a client-supplied context that remains with the connection through the connection's lifetime."/> 123 </Property> 124 <Property Name="Protocol" Type="EventDestination.v1_0_0.EventDestinationProtocol" Nullable="false"> 125 <Annotation Term="Redfish.RequiredOnCreate"/> 126 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 127 <Annotation Term="OData.Description" String="The protocol type of the event connection."/> 128 <Annotation Term="OData.LongDescription" String="This property shall contain the protocol type that the event uses to send the event to the destination. A `Redfish` value shall indicate that the event type shall adhere to the type defined in the Redfish Specification."/> 129 </Property> 130 <Property Name="HttpHeaders" Type="Collection(EventDestination.v1_0_0.HttpHeaderProperty)" Nullable="false"> 131 <Annotation Term="OData.Description" String="An array of settings for HTTP headers, such as authorization information. This array is null or an empty array in responses. An empty array is the preferred return value on read operations."/> 132 <Annotation Term="OData.LongDescription" String="This property shall contain an object consisting of the names and values of of HTTP header to be included with every event POST to the Event Destination. This object shall be null or an empty array in responses. An empty array is the preferred return value in responses."/> 133 </Property> 134 </EntityType> 135 136 <EnumType Name="EventDestinationProtocol"> 137 <Member Name="Redfish"> 138 <Annotation Term="OData.Description" String="The destination follows the Redfish Specification for event notifications."/> 139 </Member> 140 <Member Name="SNMPv1"> 141 <Annotation Term="OData.Description" String="The destination follows the SNMPv1 protocol for event notifications."/> 142 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the RFC1157-defined SNMPv1 protocol."/> 143 <Annotation Term="Redfish.Revisions"> 144 <Collection> 145 <Record> 146 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 147 <PropertyValue Property="Version" String="v1_7_0"/> 148 </Record> 149 </Collection> 150 </Annotation> 151 </Member> 152 <Member Name="SNMPv2c"> 153 <Annotation Term="OData.Description" String="The destination follows the SNMPv2c protocol for event notifications."/> 154 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the SNMPv2c protocol as defined by RFC1441 and RFC1452."/> 155 <Annotation Term="Redfish.Revisions"> 156 <Collection> 157 <Record> 158 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 159 <PropertyValue Property="Version" String="v1_7_0"/> 160 </Record> 161 </Collection> 162 </Annotation> 163 </Member> 164 <Member Name="SNMPv3"> 165 <Annotation Term="OData.Description" String="The destination follows the SNMPv3 protocol for event notifications."/> 166 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the SNMPv3 protocol as defined by RFC3411 and RFC3418."/> 167 <Annotation Term="Redfish.Revisions"> 168 <Collection> 169 <Record> 170 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 171 <PropertyValue Property="Version" String="v1_7_0"/> 172 </Record> 173 </Collection> 174 </Annotation> 175 </Member> 176 <Member Name="SMTP"> 177 <Annotation Term="OData.Description" String="The destination follows the SMTP specification for event notifications."/> 178 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the RFC5321-defined SMTP specification."/> 179 <Annotation Term="Redfish.Revisions"> 180 <Collection> 181 <Record> 182 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 183 <PropertyValue Property="Version" String="v1_7_0"/> 184 </Record> 185 </Collection> 186 </Annotation> 187 </Member> 188 </EnumType> 189 190 <ComplexType Name="HttpHeaderProperty"> 191 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 192 <Annotation Term="OData.Description" String="The HTTP header value is the property value. The header name is the property name."/> 193 <Annotation Term="OData.LongDescription" String="This type shall contain the HTTP header name and value to include with every event POST to the event destination."/> 194 <Annotation Term="Redfish.DynamicPropertyPatterns"> 195 <Collection> 196 <Record> 197 <PropertyValue Property="Pattern" String="^[^:\\s]+$"/> 198 <PropertyValue Property="Type" String="Edm.String"/> 199 </Record> 200 </Collection> 201 </Annotation> 202 </ComplexType> 203 204 </Schema> 205 206 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_2"> 207 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 208 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 209 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_0.EventDestination"/> 210 </Schema> 211 212 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_3"> 213 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 214 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/> 215 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_2.EventDestination"/> 216 </Schema> 217 218 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_4"> 219 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 220 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 221 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_3.EventDestination"/> 222 </Schema> 223 224 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_5"> 225 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 226 <Annotation Term="OData.Description" String="This version was created to change EventType to use the unversioned definition. It was also created to add descriptions to various enumerated values."/> 227 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_4.EventDestination"/> 228 </Schema> 229 230 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_6"> 231 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 232 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/> 233 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_5.EventDestination"/> 234 </Schema> 235 236 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_7"> 237 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 238 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> 239 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_6.EventDestination"/> 240 </Schema> 241 242 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_8"> 243 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 244 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also was created to update descriptions that this schema defines."/> 245 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_7.EventDestination"/> 246 </Schema> 247 248 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_0"> 249 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 250 <Annotation Term="Redfish.Release" String="2016.2"/> 251 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_2.EventDestination"> 252 <NavigationProperty Name="OriginResources" Type="Collection(Resource.ItemOrCollection)"> 253 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 254 <Annotation Term="OData.Description" String="The array of Resources for which the service sends only related events. If this property is absent or the array is empty, the service sends the events that originate from any Resource to the subscriber."/> 255 <Annotation Term="OData.LongDescription" String="This property shall specify an array of Resources, Resource Collections, or Referenceable Members that are the only allowable values for the OriginOfCondition property within an EventRecord that the service sends to the subscriber. The service shall not send events that originate from Resources, Resource Collections, or Referenceable Members, and that this array does not contain, to the subscriber. If this property is absent or the array is empty, the service shall send events that originate from any Resource, Resource Collection, or Referenceable Member to the subscriber."/> 256 </NavigationProperty> 257 <Property Name="MessageIds" Type="Collection(Edm.String)"> 258 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 259 <Annotation Term="OData.Description" String="The list of MessageIds that the service sends. If this property is absent or the array is empty, events with any MessageId are sent to the subscriber."/> 260 <Annotation Term="OData.LongDescription" String="This property shall specify an array of MessageIds that are the only allowable values for the MessageId property within an EventRecord sent to the subscriber. Events with MessageIds that are not contained in this array shall not be sent to the subscriber. If this property is absent or the array is empty, the service shall send events with any MessageId to the subscriber."/> 261 </Property> 262 </EntityType> 263 </Schema> 264 265 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_1"> 266 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 267 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/> 268 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_0.EventDestination"/> 269 </Schema> 270 271 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_2"> 272 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 273 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 274 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_1.EventDestination"/> 275 </Schema> 276 277 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_3"> 278 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 279 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 280 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_2.EventDestination"/> 281 </Schema> 282 283 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_4"> 284 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 285 <Annotation Term="OData.Description" String="This version was created to change EventType to use the unversioned definition. It was also created to add descriptions to various enumerated values."/> 286 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_3.EventDestination"/> 287 </Schema> 288 289 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_5"> 290 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 291 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/> 292 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_4.EventDestination"/> 293 </Schema> 294 295 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_6"> 296 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 297 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> 298 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_5.EventDestination"/> 299 </Schema> 300 301 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_7"> 302 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 303 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also was created to update descriptions that this schema defines."/> 304 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_6.EventDestination"/> 305 </Schema> 306 307 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_0"> 308 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 309 <Annotation Term="Redfish.Release" String="2017.1"/> 310 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_2.EventDestination"> 311 <Property Name="Actions" Type="EventDestination.v1_2_0.Actions" Nullable="false"> 312 <Annotation Term="OData.Description" String="The available actions for this Resource."/> 313 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/> 314 </Property> 315 </EntityType> 316 317 <ComplexType Name="Actions"> 318 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 319 <Annotation Term="OData.Description" String="The available actions for this Resource."/> 320 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/> 321 <Property Name="Oem" Type="EventDestination.v1_2_0.OemActions" Nullable="false"> 322 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/> 323 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/> 324 </Property> 325 </ComplexType> 326 327 <ComplexType Name="OemActions"> 328 <Annotation Term="OData.AdditionalProperties" Bool="true"/> 329 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/> 330 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/> 331 </ComplexType> 332 </Schema> 333 334 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_1"> 335 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 336 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 337 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_0.EventDestination"/> 338 </Schema> 339 340 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_2"> 341 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 342 <Annotation Term="OData.Description" String="This version was created to change EventType to use the unversioned definition. It was also created to add descriptions to various enumerated values."/> 343 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_1.EventDestination"/> 344 </Schema> 345 346 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_3"> 347 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 348 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/> 349 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_2.EventDestination"/> 350 </Schema> 351 352 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_4"> 353 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 354 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> 355 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_3.EventDestination"/> 356 </Schema> 357 358 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_5"> 359 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 360 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also was created to update descriptions that this schema defines."/> 361 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_4.EventDestination"/> 362 </Schema> 363 364 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_0"> 365 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 366 <Annotation Term="Redfish.Release" String="2018.1"/> 367 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_2.EventDestination"> 368 <Property Name="SubscriptionType" Type="EventDestination.v1_3_0.SubscriptionType"> 369 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 370 <Annotation Term="OData.Description" String="The subscription type for events."/> 371 <Annotation Term="OData.LongDescription" String="This property shall indicate the type of subscription for events. If this property is not present, the SubscriptionType shall be assumed to be RedfishEvent."/> 372 <Annotation Term="Redfish.Required"/> 373 </Property> 374 </EntityType> 375 376 <EnumType Name="SubscriptionType"> 377 <Member Name="RedfishEvent"> 378 <Annotation Term="OData.Description" String="The subscription follows the Redfish Specification for event notifications. To send an event notification, a service sends an HTTP POST to the subscriber's destination URI."/> 379 </Member> 380 <Member Name="SSE"> 381 <Annotation Term="OData.Description" String="The subscription follows the HTML5 Server-Sent Event definition for event notifications."/> 382 </Member> 383 <Member Name="SNMPTrap"> 384 <Annotation Term="OData.Description" String="The subscription follows the various versions of SNMP Traps for event notifications."/> 385 <Annotation Term="OData.LongDescription" String="This value shall indicate the subscription follows the various versions of SNMP Traps for event notifications. EventDestinationProtocol shall specify the appropriate version of SNMP."/> 386 <Annotation Term="Redfish.Revisions"> 387 <Collection> 388 <Record> 389 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 390 <PropertyValue Property="Version" String="v1_7_0"/> 391 </Record> 392 </Collection> 393 </Annotation> 394 </Member> 395 <Member Name="SNMPInform"> 396 <Annotation Term="OData.Description" String="The subscription follows versions 2 and 3 of SNMP Inform for event notifications."/> 397 <Annotation Term="OData.LongDescription" String="This value shall indicate the subscription follows versions 2 and 3 of SNMP Inform for event notifications. EventDestinationProtocol shall specify the appropriate version of SNMP."/> 398 <Annotation Term="Redfish.Revisions"> 399 <Collection> 400 <Record> 401 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 402 <PropertyValue Property="Version" String="v1_7_0"/> 403 </Record> 404 </Collection> 405 </Annotation> 406 </Member> 407 </EnumType> 408 </Schema> 409 410 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_1"> 411 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 412 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/> 413 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_0.EventDestination"/> 414 </Schema> 415 416 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_2"> 417 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 418 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> 419 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_1.EventDestination"/> 420 </Schema> 421 422 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_3"> 423 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 424 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also was created to update descriptions that this schema defines."/> 425 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_2.EventDestination"/> 426 </Schema> 427 428 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_4_0"> 429 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 430 <Annotation Term="Redfish.Release" String="2018.2"/> 431 <Annotation Term="OData.Description" String="This version was created to add the RegistryPrefix, ResourceType and SubordinateResources method of eventing."/> 432 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_0.EventDestination"> 433 <Property Name="RegistryPrefixes" Type="Collection(Edm.String)"> 434 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 435 <Annotation Term="OData.Description" String="The list of the prefixes for the Message Registries that contain the MessageIds that are sent to this event destination."/> 436 <Annotation Term="OData.LongDescription" String="This property shall contain the array of the prefixes of the Message Registries that contain the MessageIds in the Events that shall be sent to the EventDestination. If this property is absent or the array is empty, the service shall send events with MessageIds from any Message Registry."/> 437 </Property> 438 <Property Name="ResourceTypes" Type="Collection(Edm.String)"> 439 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 440 <Annotation Term="OData.Description" String="The list of Resource Type values (Schema names) that correspond to the OriginOfCondition. The version and full namespace should not be specified."/> 441 <Annotation Term="OData.LongDescription" String="This property shall specify an array of Resource Type values. When an event is generated, if the OriginOfCondition's Resource Type matches a value in this array, the event shall be sent to the event destination (unless it would be filtered by other property conditions such as RegistryPrefix). If this property is absent or the array is empty, the service shall send Events from any Resource type to the subscriber. This property shall contain only the general namespace for the type and not the versioned value. For example, it shall not contain Task.v1_2_0.Task and instead shall contain Task. To specify that a client is subscribing to metric reports, the EventTypes property should include `MetricReport`."/> 442 </Property> 443 <Property Name="SubordinateResources" Type="Edm.Boolean"> 444 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 445 <Annotation Term="OData.Description" String="An indication of whether the subscription is for events in the OriginResources array and its subordinate Resources. If `true` and the OriginResources array is specified, the subscription is for events in the OriginResources array and its subordinate Resources. Note that Resources associated through the Links section are not considered subordinate. If `false` and the OriginResources array is specified, the subscription shall be for events in the OriginResources array only. If the OriginResources array is not present, this property shall have no relevance."/> 446 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the subscription is for events in the OriginResources array and its subordinate Resources. If `true` and the OriginResources array is specified, the subscription is for events in the OriginResources array and its subordinate Resources. Note that Resources associated through the Links section are not considered subordinate. If `false` and the OriginResources array is specified, the subscription shall be for events in the OriginResources array only. If the OriginResources array is not present, this property shall have no relevance."/> 447 </Property> 448 <Property Name="EventFormatType" Type="EventDestination.EventFormatType"> 449 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 450 <Annotation Term="OData.Description" String="The content types of the message that are sent to the EventDestination."/> 451 <Annotation Term="OData.LongDescription" String="This property shall indicate the content types of the message that this service sends to the EventDestination. If this property is not present, the EventFormatType shall be assumed to be Event."/> 452 </Property> 453 </EntityType> 454 </Schema> 455 456 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_4_1"> 457 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 458 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also created to force the regeneration of JSON Schema so that URI properties use the uri-reference format. It was also created to update the descriptions for EventTypes and ResourceTypes, regarding MetricReports."/> 459 <EntityType Name="EventDestination" BaseType="EventDestination.v1_4_0.EventDestination"/> 460 </Schema> 461 462 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_4_2"> 463 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 464 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also was created to update descriptions that this schema defines."/> 465 <EntityType Name="EventDestination" BaseType="EventDestination.v1_4_1.EventDestination"/> 466 </Schema> 467 468 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_5_0"> 469 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 470 <Annotation Term="Redfish.Release" String="2019.1"/> 471 <Annotation Term="OData.Description" String="This version was created to deprecate the EventTypes property."/> 472 <EntityType Name="EventDestination" BaseType="EventDestination.v1_4_1.EventDestination"/> 473 </Schema> 474 475 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_5_1"> 476 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 477 <Annotation Term="OData.Description" String="This version was created to update the descriptions for HttpHeaders. It was also was created to update descriptions that this schema defines."/> 478 <EntityType Name="EventDestination" BaseType="EventDestination.v1_5_0.EventDestination"/> 479 </Schema> 480 481 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_6_0"> 482 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 483 <Annotation Term="Redfish.Release" String="2019.2"/> 484 <Annotation Term="OData.Description" String="This version was created to add DeliveryRetryPolicy."/> 485 486 <EntityType Name="EventDestination" BaseType="EventDestination.v1_5_0.EventDestination"> 487 <Property Name="DeliveryRetryPolicy" Type="EventDestination.v1_6_0.DeliveryRetryPolicy"> 488 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 489 <Annotation Term="OData.Description" String="This property shall contain the subscription delivery retry policy for events, where the subscription type is RedfishEvent."/> 490 <Annotation Term="OData.LongDescription" String="This property shall indicate the subscription delivery retry policy for events where the subscription type is RedfishEvent. If this property is not present, the policy shall be assumed to be TerminateAfterRetries."/> 491 </Property> 492 <Property Name="Status" Type="Resource.Status" Nullable="false"> 493 <Annotation Term="OData.Description" String="This property shall contain the status of the subscription."/> 494 <Annotation Term="OData.LongDescription" String="This property shall contain the status of the subscription."/> 495 </Property> 496 <NavigationProperty Name="MetricReportDefinitions" Type="Collection(MetricReportDefinition.MetricReportDefinition)"> 497 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 498 <Annotation Term="OData.Description" String="A list of metric report definitions for which the service only sends related metric reports. If this property is absent or the array is empty, metric reports that originate from any metric report definition are sent to the subscriber."/> 499 <Annotation Term="OData.LongDescription" String="This property shall specify an array of metric report definitions that are the only allowable generators of metric reports for this subscription. Metric reports originating from metric report definitions not contained in this array shall not be sent to the subscriber. If this property is absent or the array is empty, the service shall send metric reports originating from any metric report definition to the subscriber."/> 500 </NavigationProperty> 501 </EntityType> 502 503 <EnumType Name="DeliveryRetryPolicy"> 504 <Member Name="TerminateAfterRetries"> 505 <Annotation Term="OData.Description" String="The subscription is terminated after the maximum number of retries is reached."/> 506 </Member> 507 <Member Name="SuspendRetries"> 508 <Annotation Term="OData.Description" String="The subscription is suspended after the maximum number of retries is reached."/> 509 </Member> 510 <Member Name="RetryForever"> 511 <Annotation Term="OData.Description" String="The subscription is not suspended or terminated, and attempts at delivery of future events shall continue even after the maximum number of retries is reached."/> 512 </Member> 513 </EnumType> 514 </Schema> 515 516 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_6_1"> 517 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 518 <Annotation Term="OData.Description" String="This version was created to correct typographic errors in DeliveryRetryPolicy."/> 519 <EntityType Name="EventDestination" BaseType="EventDestination.v1_6_0.EventDestination"/> 520 </Schema> 521 522 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_7_0"> 523 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 524 <Annotation Term="Redfish.Release" String="2019.3"/> 525 <Annotation Term="OData.Description" String="This version was created to add SMTP and SNMP to EventDestinationProtocol, and SNMP to SubscriptionType."/> 526 527 <EntityType Name="EventDestination" BaseType="EventDestination.v1_6_0.EventDestination"> 528 <Property Name="SNMP" Type="EventDestination.v1_7_0.SNMPSettings" Nullable="false"> 529 <Annotation Term="OData.Description" String="Settings for an SNMP event destination."/> 530 <Annotation Term="OData.LongDescription" String="This property shall contain the settings for an SNMP event destination."/> 531 </Property> 532 </EntityType> 533 534 <ComplexType Name="SNMPSettings"> 535 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 536 <Annotation Term="OData.Description" String="Settings for an SNMP event destination."/> 537 <Annotation Term="OData.LongDescription" String="This type shall contain the settings for an SNMP event destination."/> 538 <Property Name="TrapCommunity" Type="Edm.String"> 539 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 540 <Annotation Term="OData.Description" String="The SNMP trap community string."/> 541 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMP trap community string. The value shall be `null` in responses."/> 542 </Property> 543 <Property Name="AuthenticationKey" Type="Edm.String"> 544 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 545 <Annotation Term="OData.Description" String="The secret authentication key for SNMPv3."/> 546 <Annotation Term="OData.LongDescription" String="This property shall contain the key used for SNMPv3 authentication. The value shall be `null` in responses."/> 547 <Annotation Term="Validation.Pattern" String="(^[A-Za-z0-9]+$)|(^\*+$)"/> 548 </Property> 549 <Property Name="AuthenticationProtocol" Type="EventDestination.v1_7_0.SNMPAuthenticationProtocols"> 550 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 551 <Annotation Term="OData.Description" String="The authentication protocol for SNMPv3."/> 552 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMPv3 authentication protocol."/> 553 </Property> 554 <Property Name="EncryptionKey" Type="Edm.String"> 555 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 556 <Annotation Term="OData.Description" String="The secret authentication key for SNMPv3."/> 557 <Annotation Term="OData.LongDescription" String="This property shall contain the key for SNMPv3 encryption. The value shall be `null` in responses."/> 558 <Annotation Term="Validation.Pattern" String="(^[A-Za-z0-9]+$)|(^\*+$)"/> 559 </Property> 560 <Property Name="EncryptionProtocol" Type="EventDestination.v1_7_0.SNMPEncryptionProtocols"> 561 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 562 <Annotation Term="OData.Description" String="The encryption protocol for SNMPv3."/> 563 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMPv3 encryption protocol."/> 564 </Property> 565 </ComplexType> 566 567 <EnumType Name="SNMPAuthenticationProtocols"> 568 <Member Name="None"> 569 <Annotation Term="OData.Description" String="No authentication."/> 570 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication is not required."/> 571 </Member> 572 <Member Name="CommunityString"> 573 <Annotation Term="OData.Description" String="Trap community string authentication."/> 574 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication using SNMP community strings and the value of TrapCommunity."/> 575 </Member> 576 <Member Name="HMAC_MD5"> 577 <Annotation Term="OData.Description" String="HMAC-MD5-96 authentication."/> 578 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication conforms to the RFC3414-defined HMAC-MD5-96 authentication protocol."/> 579 </Member> 580 <Member Name="HMAC_SHA96"> 581 <Annotation Term="OData.Description" String="HMAC-SHA-96 authentication."/> 582 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication conforms to the RFC3414-defined HMAC-SHA-96 authentication protocol."/> 583 </Member> 584 </EnumType> 585 586 <EnumType Name="SNMPEncryptionProtocols"> 587 <Member Name="None"> 588 <Annotation Term="OData.Description" String="No encryption."/> 589 <Annotation Term="OData.LongDescription" String="This value shall indicate there is no encryption."/> 590 </Member> 591 <Member Name="CBC_DES"> 592 <Annotation Term="OData.Description" String="CBC-DES encryption."/> 593 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the RFC3414-defined CBC-DES encryption protocol."/> 594 </Member> 595 <Member Name="CFB128_AES128"> 596 <Annotation Term="OData.Description" String="CFB128-AES-128 encryption."/> 597 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the RFC3414-defined CFB128-AES-128 encryption protocol."/> 598 </Member> 599 </EnumType> 600 </Schema> 601 602 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_7_1"> 603 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 604 <Annotation Term="OData.Description" String="This version was created to correct typographic errors in DeliveryRetryPolicy."/> 605 <EntityType Name="EventDestination" BaseType="EventDestination.v1_7_0.EventDestination"/> 606 </Schema> 607 608 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_8_0"> 609 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 610 <Annotation Term="Redfish.Release" String="2020.1"/> 611 <Annotation Term="OData.Description" String="This version was created to add the IncludeOriginOfCondition property."/> 612 613 <EntityType Name="EventDestination" BaseType="EventDestination.v1_7_0.EventDestination"> 614 <Property Name="IncludeOriginOfCondition" Type="Edm.Boolean"> 615 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 616 <Annotation Term="OData.Description" String="An indication of whether the events subscribed to will also include the entire resource or object referenced the OriginOfCondition property in the event payload."/> 617 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the event payload sent to the subscription destination will expand the OriginOfCondition property to include the resource or object referenced by the OriginOfCondition property."/> 618 </Property> 619 </EntityType> 620 </Schema> 621 622 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_8_1"> 623 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 624 <Annotation Term="OData.Description" String="This version was created to correct typographic errors in DeliveryRetryPolicy."/> 625 <EntityType Name="EventDestination" BaseType="EventDestination.v1_8_0.EventDestination"/> 626 </Schema> 627 628 </edmx:DataServices> 629</edmx:Edmx> 630