1<?xml version="1.0" encoding="UTF-8"?> 2<!----> 3<!--################################################################################ --> 4<!--# Redfish Schema: EventDestination v1.10.0 --> 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 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/CertificateCollection_v1.xml"> 35 <edmx:Include Namespace="CertificateCollection"/> 36 </edmx:Reference> 37 38 <edmx:DataServices> 39 40 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination"> 41 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 42 43 <EntityType Name="EventDestination" BaseType="Resource.v1_0_0.Resource" Abstract="true"> 44 <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."/> 45 <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."/> 46 <Annotation Term="Capabilities.InsertRestrictions"> 47 <Record> 48 <PropertyValue Property="Insertable" Bool="false"/> 49 </Record> 50 </Annotation> 51 <Annotation Term="Capabilities.UpdateRestrictions"> 52 <Record> 53 <PropertyValue Property="Updatable" Bool="true"/> 54 <Annotation Term="OData.Description" String="Writable properties, such as Context, can be updated for an event destination."/> 55 </Record> 56 </Annotation> 57 <Annotation Term="Capabilities.DeleteRestrictions"> 58 <Record> 59 <PropertyValue Property="Deletable" Bool="true"/> 60 <Annotation Term="OData.Description" String="When client no longer needs to received event notifications, it can delete an event destination."/> 61 </Record> 62 </Annotation> 63 <Annotation Term="Redfish.Uris"> 64 <Collection> 65 <String>/redfish/v1/EventService/Subscriptions/{EventDestinationId}</String> 66 </Collection> 67 </Annotation> 68 </EntityType> 69 70 <Action Name="ResumeSubscription" IsBound="true"> 71 <Annotation Term="OData.Description" String="This action resumes a suspended event subscription."/> 72 <Annotation Term="OData.LongDescription" String="This action shall resume a suspended event subscription, which affects the subscription status."/> 73 <Parameter Name="EventDestination" Type="EventDestination.v1_2_0.Actions"/> 74 </Action> 75 76 <EnumType Name="EventFormatType"> 77 <Annotation Term="Redfish.Revisions"> 78 <Collection> 79 <Record> 80 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 81 <PropertyValue Property="Version" String="v1_4_0"/> 82 </Record> 83 </Collection> 84 </Annotation> 85 <Member Name="Event"> 86 <Annotation Term="OData.Description" String="The subscription destination receives an event payload."/> 87 <Annotation Term="OData.LongDescription" String="The subscription destination shall receive an event payload as defined by the value of the Protocol property."/> 88 </Member> 89 <Member Name="MetricReport"> 90 <Annotation Term="OData.Description" String="The subscription destination receives a metric report."/> 91 <Annotation Term="OData.LongDescription" String="The subscription destination shall receive a metric report payload as defined by the value of the Protocol property."/> 92 </Member> 93 </EnumType> 94 </Schema> 95 96 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_0"> 97 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 98 <Annotation Term="Redfish.Release" String="1.0"/> 99 100 <EntityType Name="EventDestination" BaseType="EventDestination.EventDestination"> 101 <Property Name="Destination" Type="Edm.String" Nullable="false"> 102 <Annotation Term="Redfish.RequiredOnCreate"/> 103 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 104 <Annotation Term="OData.Description" String="The URI of the destination event receiver."/> 105 <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. Syslog URIs shall be consistent with RFC3986 and contain the scheme `syslog://`. For other URIs, such as HTTP or HTTPS, they shall be consistent with RFC3986."/> 106 <Annotation Term="OData.IsURL"/> 107 </Property> 108 <Property Name="EventTypes" Type="Collection(Event.EventType)" Nullable="false"> 109 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 110 <Annotation Term="OData.Description" String="The types of events that are sent to the destination."/> 111 <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`."/> 112 <Annotation Term="Redfish.Revisions"> 113 <Collection> 114 <Record> 115 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/> 116 <PropertyValue Property="Version" String="v1_5_0"/> 117 <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`."/> 118 </Record> 119 </Collection> 120 </Annotation> 121 </Property> 122 <Property Name="Context" Type="Edm.String"> 123 <Annotation Term="Redfish.Required"/> 124 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 125 <Annotation Term="OData.Description" String="A client-supplied string that is stored with the event destination subscription."/> 126 <Annotation Term="OData.LongDescription" String="This property shall contain a client-supplied context that remains with the connection through the connection's lifetime."/> 127 </Property> 128 <Property Name="Protocol" Type="EventDestination.v1_0_0.EventDestinationProtocol" Nullable="false"> 129 <Annotation Term="Redfish.RequiredOnCreate"/> 130 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 131 <Annotation Term="OData.Description" String="The protocol type of the event connection."/> 132 <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."/> 133 </Property> 134 <Property Name="HttpHeaders" Type="Collection(EventDestination.v1_0_0.HttpHeaderProperty)" Nullable="false"> 135 <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."/> 136 <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."/> 137 </Property> 138 </EntityType> 139 140 <EnumType Name="EventDestinationProtocol"> 141 <Member Name="Redfish"> 142 <Annotation Term="OData.Description" String="The destination follows the Redfish Specification for event notifications."/> 143 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the Redfish Specification for event notifications. Destinations requesting EventFormatType of `Event` shall receive a Redfish resource of type Event. Destinations requesting EventFormatType of `MetricReport` shall receive a Redfish resource of type MetricReport."/> 144 </Member> 145 <Member Name="SNMPv1"> 146 <Annotation Term="OData.Description" String="The destination follows the SNMPv1 protocol for event notifications."/> 147 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the RFC1157-defined SNMPv1 protocol."/> 148 <Annotation Term="Redfish.Revisions"> 149 <Collection> 150 <Record> 151 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 152 <PropertyValue Property="Version" String="v1_7_0"/> 153 </Record> 154 </Collection> 155 </Annotation> 156 </Member> 157 <Member Name="SNMPv2c"> 158 <Annotation Term="OData.Description" String="The destination follows the SNMPv2c protocol for event notifications."/> 159 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the SNMPv2c protocol as defined by RFC1441 and RFC1452."/> 160 <Annotation Term="Redfish.Revisions"> 161 <Collection> 162 <Record> 163 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 164 <PropertyValue Property="Version" String="v1_7_0"/> 165 </Record> 166 </Collection> 167 </Annotation> 168 </Member> 169 <Member Name="SNMPv3"> 170 <Annotation Term="OData.Description" String="The destination follows the SNMPv3 protocol for event notifications."/> 171 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the SNMPv3 protocol as defined by RFC3411 and RFC3418."/> 172 <Annotation Term="Redfish.Revisions"> 173 <Collection> 174 <Record> 175 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 176 <PropertyValue Property="Version" String="v1_7_0"/> 177 </Record> 178 </Collection> 179 </Annotation> 180 </Member> 181 <Member Name="SMTP"> 182 <Annotation Term="OData.Description" String="The destination follows the SMTP specification for event notifications."/> 183 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the RFC5321-defined SMTP specification."/> 184 <Annotation Term="Redfish.Revisions"> 185 <Collection> 186 <Record> 187 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 188 <PropertyValue Property="Version" String="v1_7_0"/> 189 </Record> 190 </Collection> 191 </Annotation> 192 </Member> 193 <Member Name="SyslogTLS"> 194 <Annotation Term="OData.Description" String="The destination follows syslog TLS-based for event notifications."/> 195 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the TLS-based transport for syslog as defined in RFC5424."/> 196 <Annotation Term="Redfish.Revisions"> 197 <Collection> 198 <Record> 199 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 200 <PropertyValue Property="Version" String="v1_9_0"/> 201 </Record> 202 </Collection> 203 </Annotation> 204 </Member> 205 <Member Name="SyslogTCP"> 206 <Annotation Term="OData.Description" String="The destination follows syslog TCP-based for event notifications."/> 207 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the TCP-based transport for syslog as defined in RFC6587."/> 208 <Annotation Term="Redfish.Revisions"> 209 <Collection> 210 <Record> 211 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 212 <PropertyValue Property="Version" String="v1_9_0"/> 213 </Record> 214 </Collection> 215 </Annotation> 216 </Member> 217 <Member Name="SyslogUDP"> 218 <Annotation Term="OData.Description" String="The destination follows syslog UDP-based for event notifications."/> 219 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the UDP-based transport for syslog as defined in RFC5424."/> 220 <Annotation Term="Redfish.Revisions"> 221 <Collection> 222 <Record> 223 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 224 <PropertyValue Property="Version" String="v1_9_0"/> 225 </Record> 226 </Collection> 227 </Annotation> 228 </Member> 229 <Member Name="SyslogRELP"> 230 <Annotation Term="OData.Description" String="The destination follows syslog RELP for event notifications."/> 231 <Annotation Term="OData.LongDescription" String="This value shall indicate the destination follows the Reliable Event Logging Protocol (RELP) transport for syslog as defined by www.rsyslog.com."/> 232 <Annotation Term="Redfish.Revisions"> 233 <Collection> 234 <Record> 235 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 236 <PropertyValue Property="Version" String="v1_9_0"/> 237 </Record> 238 </Collection> 239 </Annotation> 240 </Member> 241 <Member Name="OEM"> 242 <Annotation Term="OData.Description" String="The destination follows an OEM protocol for event notifications."/> 243 <Annotation Term="OData.LongDescription" String="This value shall indicate an OEM specific protocol. The OEMProtocol property shall contain the specific OEM event destination protocol."/> 244 <Annotation Term="Redfish.Revisions"> 245 <Collection> 246 <Record> 247 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 248 <PropertyValue Property="Version" String="v1_9_0"/> 249 </Record> 250 </Collection> 251 </Annotation> 252 </Member> 253 </EnumType> 254 255 <ComplexType Name="HttpHeaderProperty"> 256 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 257 <Annotation Term="OData.Description" String="The HTTP header value is the property value. The header name is the property name."/> 258 <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."/> 259 <Annotation Term="Redfish.DynamicPropertyPatterns"> 260 <Collection> 261 <Record> 262 <PropertyValue Property="Pattern" String="^[^:\\s]+$"/> 263 <PropertyValue Property="Type" String="Edm.String"/> 264 </Record> 265 </Collection> 266 </Annotation> 267 </ComplexType> 268 269 </Schema> 270 271 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_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_0_0.EventDestination"/> 275 </Schema> 276 277 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_3"> 278 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 279 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/> 280 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_2.EventDestination"/> 281 </Schema> 282 283 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_4"> 284 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 285 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 286 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_3.EventDestination"/> 287 </Schema> 288 289 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_5"> 290 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 291 <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."/> 292 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_4.EventDestination"/> 293 </Schema> 294 295 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_6"> 296 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 297 <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."/> 298 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_5.EventDestination"/> 299 </Schema> 300 301 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_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 created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> 304 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_6.EventDestination"/> 305 </Schema> 306 307 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_8"> 308 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 309 <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."/> 310 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_7.EventDestination"/> 311 </Schema> 312 313 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_0_9"> 314 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 315 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol."/> 316 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_8.EventDestination"/> 317 </Schema> 318 319 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_0"> 320 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 321 <Annotation Term="Redfish.Release" String="2016.2"/> 322 <EntityType Name="EventDestination" BaseType="EventDestination.v1_0_2.EventDestination"> 323 <NavigationProperty Name="OriginResources" Type="Collection(Resource.ItemOrCollection)"> 324 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 325 <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."/> 326 <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."/> 327 </NavigationProperty> 328 <Property Name="MessageIds" Type="Collection(Edm.String)"> 329 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 330 <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."/> 331 <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."/> 332 </Property> 333 </EntityType> 334 </Schema> 335 336 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_1"> 337 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 338 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/> 339 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_0.EventDestination"/> 340 </Schema> 341 342 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_2"> 343 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 344 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 345 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_1.EventDestination"/> 346 </Schema> 347 348 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_3"> 349 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 350 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 351 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_2.EventDestination"/> 352 </Schema> 353 354 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_4"> 355 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 356 <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."/> 357 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_3.EventDestination"/> 358 </Schema> 359 360 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_5"> 361 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 362 <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."/> 363 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_4.EventDestination"/> 364 </Schema> 365 366 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_6"> 367 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 368 <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."/> 369 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_5.EventDestination"/> 370 </Schema> 371 372 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_7"> 373 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 374 <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."/> 375 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_6.EventDestination"/> 376 </Schema> 377 378 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_1_8"> 379 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 380 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol."/> 381 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_7.EventDestination"/> 382 </Schema> 383 384 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_0"> 385 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 386 <Annotation Term="Redfish.Release" String="2017.1"/> 387 <EntityType Name="EventDestination" BaseType="EventDestination.v1_1_2.EventDestination"> 388 <Property Name="Actions" Type="EventDestination.v1_2_0.Actions" Nullable="false"> 389 <Annotation Term="OData.Description" String="The available actions for this Resource."/> 390 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/> 391 </Property> 392 </EntityType> 393 394 <ComplexType Name="Actions"> 395 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 396 <Annotation Term="OData.Description" String="The available actions for this Resource."/> 397 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/> 398 <Property Name="Oem" Type="EventDestination.v1_2_0.OemActions" Nullable="false"> 399 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/> 400 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/> 401 </Property> 402 </ComplexType> 403 404 <ComplexType Name="OemActions"> 405 <Annotation Term="OData.AdditionalProperties" Bool="true"/> 406 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/> 407 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/> 408 </ComplexType> 409 </Schema> 410 411 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_1"> 412 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 413 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/> 414 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_0.EventDestination"/> 415 </Schema> 416 417 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_2"> 418 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 419 <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."/> 420 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_1.EventDestination"/> 421 </Schema> 422 423 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_3"> 424 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 425 <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."/> 426 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_2.EventDestination"/> 427 </Schema> 428 429 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_4"> 430 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 431 <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."/> 432 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_3.EventDestination"/> 433 </Schema> 434 435 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_5"> 436 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 437 <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."/> 438 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_4.EventDestination"/> 439 </Schema> 440 441 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_2_6"> 442 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 443 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol."/> 444 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_5.EventDestination"/> 445 </Schema> 446 447 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_0"> 448 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 449 <Annotation Term="Redfish.Release" String="2018.1"/> 450 <EntityType Name="EventDestination" BaseType="EventDestination.v1_2_2.EventDestination"> 451 <Property Name="SubscriptionType" Type="EventDestination.v1_3_0.SubscriptionType"> 452 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 453 <Annotation Term="OData.Description" String="The subscription type for events."/> 454 <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."/> 455 <Annotation Term="Redfish.Required"/> 456 </Property> 457 </EntityType> 458 459 <EnumType Name="SubscriptionType"> 460 <Member Name="RedfishEvent"> 461 <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."/> 462 </Member> 463 <Member Name="SSE"> 464 <Annotation Term="OData.Description" String="The subscription follows the HTML5 Server-Sent Event definition for event notifications."/> 465 </Member> 466 <Member Name="SNMPTrap"> 467 <Annotation Term="OData.Description" String="The subscription follows the various versions of SNMP Traps for event notifications."/> 468 <Annotation Term="OData.LongDescription" String="This value shall indicate the subscription follows the various versions of SNMP Traps for event notifications. Protocol shall specify the appropriate version of SNMP."/> 469 <Annotation Term="Redfish.Revisions"> 470 <Collection> 471 <Record> 472 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 473 <PropertyValue Property="Version" String="v1_7_0"/> 474 </Record> 475 </Collection> 476 </Annotation> 477 </Member> 478 <Member Name="SNMPInform"> 479 <Annotation Term="OData.Description" String="The subscription follows versions 2 and 3 of SNMP Inform for event notifications."/> 480 <Annotation Term="OData.LongDescription" String="This value shall indicate the subscription follows versions 2 and 3 of SNMP Inform for event notifications. Protocol shall specify the appropriate version of SNMP."/> 481 <Annotation Term="Redfish.Revisions"> 482 <Collection> 483 <Record> 484 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 485 <PropertyValue Property="Version" String="v1_7_0"/> 486 </Record> 487 </Collection> 488 </Annotation> 489 </Member> 490 <Member Name="Syslog"> 491 <Annotation Term="OData.Description" String="The subscription sends Syslog messages for event notifications."/> 492 <Annotation Term="OData.LongDescription" String="This value shall indicate the subscription forwards syslog messages to the event destination. Protocol shall specify the appropriate syslog protocol."/> 493 <Annotation Term="Redfish.Revisions"> 494 <Collection> 495 <Record> 496 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 497 <PropertyValue Property="Version" String="v1_9_0"/> 498 </Record> 499 </Collection> 500 </Annotation> 501 </Member> 502 <Member Name="OEM"> 503 <Annotation Term="OData.Description" String="The subscription is an OEM subscription."/> 504 <Annotation Term="OData.LongDescription" String="This value shall indicate an OEM subscription type. The OEMSubscriptionType property shall contain the specific OEM subscription type."/> 505 <Annotation Term="Redfish.Revisions"> 506 <Collection> 507 <Record> 508 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 509 <PropertyValue Property="Version" String="v1_9_0"/> 510 </Record> 511 </Collection> 512 </Annotation> 513 </Member> 514 </EnumType> 515 </Schema> 516 517 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_1"> 518 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 519 <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."/> 520 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_0.EventDestination"/> 521 </Schema> 522 523 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_2"> 524 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 525 <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."/> 526 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_1.EventDestination"/> 527 </Schema> 528 529 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_3"> 530 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 531 <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."/> 532 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_2.EventDestination"/> 533 </Schema> 534 535 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_3_4"> 536 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 537 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol."/> 538 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_3.EventDestination"/> 539 </Schema> 540 541 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_4_0"> 542 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 543 <Annotation Term="Redfish.Release" String="2018.2"/> 544 <Annotation Term="OData.Description" String="This version was created to add the RegistryPrefix, ResourceType and SubordinateResources method of eventing."/> 545 <EntityType Name="EventDestination" BaseType="EventDestination.v1_3_0.EventDestination"> 546 <Property Name="RegistryPrefixes" Type="Collection(Edm.String)"> 547 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 548 <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."/> 549 <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."/> 550 </Property> 551 <Property Name="ResourceTypes" Type="Collection(Edm.String)"> 552 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 553 <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."/> 554 <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`."/> 555 </Property> 556 <Property Name="SubordinateResources" Type="Edm.Boolean"> 557 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 558 <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."/> 559 <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."/> 560 </Property> 561 <Property Name="EventFormatType" Type="EventDestination.EventFormatType"> 562 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 563 <Annotation Term="OData.Description" String="The content types of the message that are sent to the EventDestination."/> 564 <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."/> 565 </Property> 566 </EntityType> 567 </Schema> 568 569 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_4_1"> 570 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 571 <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."/> 572 <EntityType Name="EventDestination" BaseType="EventDestination.v1_4_0.EventDestination"/> 573 </Schema> 574 575 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_4_2"> 576 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 577 <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."/> 578 <EntityType Name="EventDestination" BaseType="EventDestination.v1_4_1.EventDestination"/> 579 </Schema> 580 581 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_4_3"> 582 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 583 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol."/> 584 <EntityType Name="EventDestination" BaseType="EventDestination.v1_4_2.EventDestination"/> 585 </Schema> 586 587 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_5_0"> 588 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 589 <Annotation Term="Redfish.Release" String="2019.1"/> 590 <Annotation Term="OData.Description" String="This version was created to deprecate the EventTypes property."/> 591 <EntityType Name="EventDestination" BaseType="EventDestination.v1_4_1.EventDestination"/> 592 </Schema> 593 594 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_5_1"> 595 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 596 <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."/> 597 <EntityType Name="EventDestination" BaseType="EventDestination.v1_5_0.EventDestination"/> 598 </Schema> 599 600 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_5_2"> 601 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 602 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol."/> 603 <EntityType Name="EventDestination" BaseType="EventDestination.v1_5_1.EventDestination"/> 604 </Schema> 605 606 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_6_0"> 607 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 608 <Annotation Term="Redfish.Release" String="2019.2"/> 609 <Annotation Term="OData.Description" String="This version was created to add DeliveryRetryPolicy."/> 610 611 <EntityType Name="EventDestination" BaseType="EventDestination.v1_5_0.EventDestination"> 612 <Property Name="DeliveryRetryPolicy" Type="EventDestination.v1_6_0.DeliveryRetryPolicy"> 613 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 614 <Annotation Term="OData.Description" String="The subscription delivery retry policy for events, where the subscription type is RedfishEvent."/> 615 <Annotation Term="OData.LongDescription" String="This property shall indicate the subscription delivery retry policy for events where the subscription type is RedfishEvent."/> 616 </Property> 617 <Property Name="Status" Type="Resource.Status" Nullable="false"> 618 <Annotation Term="OData.Description" String="This property shall contain the status of the subscription."/> 619 <Annotation Term="OData.LongDescription" String="This property shall contain the status of the subscription."/> 620 </Property> 621 <NavigationProperty Name="MetricReportDefinitions" Type="Collection(MetricReportDefinition.MetricReportDefinition)"> 622 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 623 <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."/> 624 <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."/> 625 </NavigationProperty> 626 </EntityType> 627 628 <EnumType Name="DeliveryRetryPolicy"> 629 <Member Name="TerminateAfterRetries"> 630 <Annotation Term="OData.Description" String="The subscription is terminated after the maximum number of retries is reached."/> 631 <Annotation Term="OData.LongDescription" String="The subscription is terminated after the maximum number of retries is reached, specified by the DeliveryRetryAttempts property in the event service."/> 632 </Member> 633 <Member Name="SuspendRetries"> 634 <Annotation Term="OData.Description" String="The subscription is suspended after the maximum number of retries is reached."/> 635 <Annotation Term="OData.LongDescription" String="The subscription is suspended after the maximum number of retries is reached, specified by the DeliveryRetryAttempts property in the event service."/> 636 </Member> 637 <Member Name="RetryForever"> 638 <Annotation Term="OData.Description" String="The subscription is not suspended or terminated, and attempts at delivery of future events shall continue regardless of the number of retries."/> 639 <Annotation Term="OData.LongDescription" String="The subscription is not suspended or terminated, and attempts at delivery of future events shall continue regardless of the number of retries. The interval between retries remains constant and is specified by the DeliveryRetryIntervalSeconds property in the event service."/> 640 </Member> 641 <Member Name="RetryForeverWithBackoff"> 642 <Annotation Term="OData.Description" String="The subscription is not suspended or terminated, and attempts at delivery of future events shall continue regardless of the number of retries, but issued over time according to a service-defined backoff algorithm."/> 643 <Annotation Term="OData.LongDescription" String="The subscription is not suspended or terminated, and attempts at delivery of future events shall continue regardless of the number of retries. Retry attempts are issued over time according to a service-defined backoff algorithm. The backoff algorithm might insert an increasing amount of delay between retry attempts and might reach a maximum."/> 644 <Annotation Term="Redfish.Revisions"> 645 <Collection> 646 <Record> 647 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 648 <PropertyValue Property="Version" String="v1_10_0"/> 649 </Record> 650 </Collection> 651 </Annotation> 652 </Member> 653 </EnumType> 654 </Schema> 655 656 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_6_1"> 657 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 658 <Annotation Term="OData.Description" String="This version was created to correct typographic errors in DeliveryRetryPolicy."/> 659 <EntityType Name="EventDestination" BaseType="EventDestination.v1_6_0.EventDestination"/> 660 </Schema> 661 662 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_6_2"> 663 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 664 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol. It was also updated to allow for a service to select its own DeliveryRetryPolicy if not specified by the client."/> 665 <EntityType Name="EventDestination" BaseType="EventDestination.v1_6_1.EventDestination"/> 666 </Schema> 667 668 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_7_0"> 669 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 670 <Annotation Term="Redfish.Release" String="2019.3"/> 671 <Annotation Term="OData.Description" String="This version was created to add SMTP and SNMP to EventDestinationProtocol, and SNMP to SubscriptionType."/> 672 673 <EntityType Name="EventDestination" BaseType="EventDestination.v1_6_0.EventDestination"> 674 <Property Name="SNMP" Type="EventDestination.v1_7_0.SNMPSettings" Nullable="false"> 675 <Annotation Term="OData.Description" String="Settings for an SNMP event destination."/> 676 <Annotation Term="OData.LongDescription" String="This property shall contain the settings for an SNMP event destination."/> 677 </Property> 678 </EntityType> 679 680 <ComplexType Name="SNMPSettings"> 681 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 682 <Annotation Term="OData.Description" String="Settings for an SNMP event destination."/> 683 <Annotation Term="OData.LongDescription" String="This type shall contain the settings for an SNMP event destination."/> 684 <Property Name="TrapCommunity" Type="Edm.String"> 685 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 686 <Annotation Term="OData.Description" String="The SNMP trap community string."/> 687 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMP trap community string. The value shall be `null` in responses."/> 688 </Property> 689 <Property Name="AuthenticationKey" Type="Edm.String"> 690 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 691 <Annotation Term="OData.Description" String="The secret authentication key for SNMPv3."/> 692 <Annotation Term="OData.LongDescription" String="This property shall contain the key for SNMPv3 authentication. The value shall be `null` in responses. This property accepts a passphrase or a hex-encoded key. If the string starts with `Passphrase:`, the remainder of the string shall be the passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. If the string starts with `Hex:`, then the remainder of the string shall be the key encoded in hexadecimal notation. If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. The passphrase can contain any printable characters except for the double quotation mark."/> 693 <Annotation Term="Validation.Pattern" String="(^[ !#-~]+$)|(^Passphrase:[ ^[ !#-~]+$)|(^Hex:[0-9A-Fa-f]{24,96})|(^\*+$)"/> 694 </Property> 695 <Property Name="AuthenticationProtocol" Type="EventDestination.v1_7_0.SNMPAuthenticationProtocols"> 696 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 697 <Annotation Term="OData.Description" String="The authentication protocol for SNMPv3."/> 698 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMPv3 authentication protocol."/> 699 </Property> 700 <Property Name="EncryptionKey" Type="Edm.String"> 701 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 702 <Annotation Term="OData.Description" String="The secret authentication key for SNMPv3."/> 703 <Annotation Term="OData.LongDescription" String="This property shall contain the key for SNMPv3 encryption. The value shall be `null` in responses. This property accepts a passphrase or a hex-encoded key. If the string starts with `Passphrase:`, the remainder of the string shall be the passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. If the string starts with `Hex:`, then the remainder of the string shall be the key encoded in hexadecimal notation. If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. The passphrase can contain any printable characters except for the double quotation mark."/> 704 <Annotation Term="Validation.Pattern" String="(^[A-Za-z0-9]+$)|(^\*+$)"/> 705 </Property> 706 <Property Name="EncryptionProtocol" Type="EventDestination.v1_7_0.SNMPEncryptionProtocols"> 707 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 708 <Annotation Term="OData.Description" String="The encryption protocol for SNMPv3."/> 709 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMPv3 encryption protocol."/> 710 </Property> 711 </ComplexType> 712 713 <EnumType Name="SNMPAuthenticationProtocols"> 714 <Member Name="None"> 715 <Annotation Term="OData.Description" String="No authentication."/> 716 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication is not required."/> 717 </Member> 718 <Member Name="CommunityString"> 719 <Annotation Term="OData.Description" String="Trap community string authentication."/> 720 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication using SNMP community strings and the value of TrapCommunity."/> 721 </Member> 722 <Member Name="HMAC_MD5"> 723 <Annotation Term="OData.Description" String="HMAC-MD5-96 authentication."/> 724 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication conforms to the RFC3414-defined HMAC-MD5-96 authentication protocol."/> 725 </Member> 726 <Member Name="HMAC_SHA96"> 727 <Annotation Term="OData.Description" String="HMAC-SHA-96 authentication."/> 728 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication conforms to the RFC3414-defined HMAC-SHA-96 authentication protocol."/> 729 </Member> 730 <Member Name="HMAC128_SHA224"> 731 <Annotation Term="OData.Description" String="HMAC-128-SHA-224 authentication."/> 732 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC128SHA224AuthProtocol."/> 733 <Annotation Term="Redfish.Revisions"> 734 <Collection> 735 <Record> 736 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 737 <PropertyValue Property="Version" String="v1_10_0"/> 738 </Record> 739 </Collection> 740 </Annotation> 741 </Member> 742 <Member Name="HMAC192_SHA256"> 743 <Annotation Term="OData.Description" String="HMAC-192-SHA-256 authentication."/> 744 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC192SHA256AuthProtocol."/> 745 <Annotation Term="Redfish.Revisions"> 746 <Collection> 747 <Record> 748 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 749 <PropertyValue Property="Version" String="v1_10_0"/> 750 </Record> 751 </Collection> 752 </Annotation> 753 </Member> 754 <Member Name="HMAC256_SHA384"> 755 <Annotation Term="OData.Description" String="HMAC-256-SHA-384 authentication."/> 756 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC256SHA384AuthProtocol."/> 757 <Annotation Term="Redfish.Revisions"> 758 <Collection> 759 <Record> 760 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 761 <PropertyValue Property="Version" String="v1_10_0"/> 762 </Record> 763 </Collection> 764 </Annotation> 765 </Member> 766 <Member Name="HMAC384_SHA512"> 767 <Annotation Term="OData.Description" String="HMAC-384-SHA-512 authentication."/> 768 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC384SHA512AuthProtocol."/> 769 <Annotation Term="Redfish.Revisions"> 770 <Collection> 771 <Record> 772 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 773 <PropertyValue Property="Version" String="v1_10_0"/> 774 </Record> 775 </Collection> 776 </Annotation> 777 </Member> 778 </EnumType> 779 780 <EnumType Name="SNMPEncryptionProtocols"> 781 <Member Name="None"> 782 <Annotation Term="OData.Description" String="No encryption."/> 783 <Annotation Term="OData.LongDescription" String="This value shall indicate there is no encryption."/> 784 </Member> 785 <Member Name="CBC_DES"> 786 <Annotation Term="OData.Description" String="CBC-DES encryption."/> 787 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the RFC3414-defined CBC-DES encryption protocol."/> 788 </Member> 789 <Member Name="CFB128_AES128"> 790 <Annotation Term="OData.Description" String="CFB128-AES-128 encryption."/> 791 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the RFC3414-defined CFB128-AES-128 encryption protocol."/> 792 </Member> 793 </EnumType> 794 </Schema> 795 796 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_7_1"> 797 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 798 <Annotation Term="OData.Description" String="This version was created to correct typographic errors in DeliveryRetryPolicy."/> 799 <EntityType Name="EventDestination" BaseType="EventDestination.v1_7_0.EventDestination"/> 800 </Schema> 801 802 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_7_2"> 803 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 804 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol. It was also created to correct descriptions and terms for SNMP properties. It was also updated to allow for a service to select its own DeliveryRetryPolicy if not specified by the client."/> 805 <EntityType Name="EventDestination" BaseType="EventDestination.v1_7_1.EventDestination"/> 806 </Schema> 807 808 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_8_0"> 809 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 810 <Annotation Term="Redfish.Release" String="2020.1"/> 811 <Annotation Term="OData.Description" String="This version was created to add the IncludeOriginOfCondition property."/> 812 813 <EntityType Name="EventDestination" BaseType="EventDestination.v1_7_0.EventDestination"> 814 <Property Name="IncludeOriginOfCondition" Type="Edm.Boolean"> 815 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 816 <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."/> 817 <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."/> 818 </Property> 819 </EntityType> 820 </Schema> 821 822 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_8_1"> 823 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 824 <Annotation Term="OData.Description" String="This version was created to correct typographic errors in DeliveryRetryPolicy."/> 825 <EntityType Name="EventDestination" BaseType="EventDestination.v1_8_0.EventDestination"/> 826 </Schema> 827 828 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_8_2"> 829 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 830 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol. It was also created to correct descriptions and terms for SNMP properties. It was also updated to allow for a service to select its own DeliveryRetryPolicy if not specified by the client."/> 831 <EntityType Name="EventDestination" BaseType="EventDestination.v1_8_1.EventDestination"/> 832 </Schema> 833 834 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_9_0"> 835 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 836 <Annotation Term="Redfish.Release" String="2020.3"/> 837 838 <EntityType Name="EventDestination" BaseType="EventDestination.v1_8_1.EventDestination"> 839 <NavigationProperty Name="Certificates" Type="CertificateCollection.CertificateCollection" ContainsTarget="true" Nullable="false"> 840 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 841 <Annotation Term="OData.Description" String="The link to a collection of server certificates for the server referenced by the Destination property."/> 842 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type CertificateCollection that represent the server certificates for the server referenced by the Destination property. If VerifyCertificate is `true`, services shall compare the certificates in this collection with the certificate obtained during handshaking with the event destination in order to verify the identify of the event destination prior to sending an event. If the server cannot be verified, the service shall not send the event. If VerifyCertificate is `false`, the service shall not perform certificate verification."/> 843 <Annotation Term="OData.AutoExpandReferences"/> 844 </NavigationProperty> 845 <Property Name="VerifyCertificate" Type="Edm.Boolean"> 846 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 847 <Annotation Term="OData.Description" String="An indication of whether the service will verify the certificate of the server referenced by the Destination property prior to sending the event."/> 848 <Annotation Term="OData.LongDescription" String="This property shall indicate whether whether the service will verify the certificate of the server referenced by the Destination property prior to sending the event."/> 849 </Property> 850 <Property Name="SyslogFilters" Type="Collection(EventDestination.v1_9_0.SyslogFilter)"> 851 <Annotation Term="OData.Description" String="A list of syslog message filters to send to a remote syslog server."/> 852 <Annotation Term="OData.LongDescription" String="This property shall describe all desired syslog messages to send to a remote syslog server. If this property contains an empty array or is absent, all messages shall be sent."/> 853 </Property> 854 <Property Name="OEMProtocol" Type="Edm.String" Nullable="false"> 855 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 856 <Annotation Term="OData.Description" String="The OEM-defined protocol type of the event connection."/> 857 <Annotation Term="OData.LongDescription" String="This property shall contain the protocol type that the event uses to send the event to the destination. This property shall be present if Protocol is `OEM`."/> 858 </Property> 859 <Property Name="OEMSubscriptionType" Type="Edm.String" Nullable="false"> 860 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 861 <Annotation Term="OData.Description" String="The OEM-defined subscription type for events."/> 862 <Annotation Term="OData.LongDescription" String="This property shall indicate the OEM-defined type of subscription for events. This property shall be present if SubscriptionType is `OEM`."/> 863 </Property> 864 </EntityType> 865 866 <EnumType Name="SyslogSeverity"> 867 <Annotation Term="OData.Description" String="The syslog severity is an application-specific rating used to describe the urgency of the message."/> 868 <Annotation Term="OData.LongDescription" String="This type shall specify the syslog severity levels as an application-specific rating used to describe the urgency of the message. `Emergency` should be reserved for messages indicating the system is unusable and `Debug` should only be used when debugging a program. Severity values are described in RFC5424."/> 869 <Member Name="Emergency"> 870 <Annotation Term="OData.Description" String="A panic condition."/> 871 </Member> 872 <Member Name="Alert"> 873 <Annotation Term="OData.Description" String="A condition that should be corrected immediately, such as a corrupted system database."/> 874 </Member> 875 <Member Name="Critical"> 876 <Annotation Term="OData.Description" String="Hard device errors."/> 877 </Member> 878 <Member Name="Error"> 879 <Annotation Term="OData.Description" String="An Error."/> 880 </Member> 881 <Member Name="Warning"> 882 <Annotation Term="OData.Description" String="A Warning."/> 883 </Member> 884 <Member Name="Notice"> 885 <Annotation Term="OData.Description" String="Conditions that are not error conditions, but that may require special handling."/> 886 </Member> 887 <Member Name="Informational"> 888 <Annotation Term="OData.Description" String="Informational only."/> 889 </Member> 890 <Member Name="Debug"> 891 <Annotation Term="OData.Description" String="Messages that contain information normally of use only when debugging a program."/> 892 </Member> 893 <Member Name="All"> 894 <Annotation Term="OData.Description" String="A message of any severity."/> 895 </Member> 896 </EnumType> 897 898 <EnumType Name="SyslogFacility"> 899 <Annotation Term="OData.Description" String="The syslog facility code is an enumeration of program types."/> 900 <Annotation Term="OData.LongDescription" String="This type shall specify the syslog facility codes as program types. Facility values are described in the RFC5424."/> 901 <Member Name="Kern"> 902 <Annotation Term="OData.Description" String="Kernel messages."/> 903 </Member> 904 <Member Name="User"> 905 <Annotation Term="OData.Description" String="User-level messages."/> 906 </Member> 907 <Member Name="Mail"> 908 <Annotation Term="OData.Description" String="Mail system."/> 909 </Member> 910 <Member Name="Daemon"> 911 <Annotation Term="OData.Description" String="System daemons."/> 912 </Member> 913 <Member Name="Auth"> 914 <Annotation Term="OData.Description" String="Security/authentication messages."/> 915 </Member> 916 <Member Name="Syslog"> 917 <Annotation Term="OData.Description" String="Messages generated internally by syslogd."/> 918 </Member> 919 <Member Name="LPR"> 920 <Annotation Term="OData.Description" String="Line printer subsystem."/> 921 </Member> 922 <Member Name="News"> 923 <Annotation Term="OData.Description" String="Network news subsystem."/> 924 </Member> 925 <Member Name="UUCP"> 926 <Annotation Term="OData.Description" String="UUCP subsystem."/> 927 </Member> 928 <Member Name="Cron"> 929 <Annotation Term="OData.Description" String="Clock daemon."/> 930 </Member> 931 <Member Name="Authpriv"> 932 <Annotation Term="OData.Description" String="Security/authentication messages."/> 933 </Member> 934 <Member Name="FTP"> 935 <Annotation Term="OData.Description" String="FTP daemon."/> 936 </Member> 937 <Member Name="NTP"> 938 <Annotation Term="OData.Description" String="NTP subsystem."/> 939 </Member> 940 <Member Name="Security"> 941 <Annotation Term="OData.Description" String="Log audit."/> 942 </Member> 943 <Member Name="Console"> 944 <Annotation Term="OData.Description" String="Log alert."/> 945 </Member> 946 <Member Name="SolarisCron"> 947 <Annotation Term="OData.Description" String="Scheduling daemon."/> 948 </Member> 949 <Member Name="Local0"> 950 <Annotation Term="OData.Description" String="Locally used facility 0."/> 951 </Member> 952 <Member Name="Local1"> 953 <Annotation Term="OData.Description" String="Locally used facility 1."/> 954 </Member> 955 <Member Name="Local2"> 956 <Annotation Term="OData.Description" String="Locally used facility 2."/> 957 </Member> 958 <Member Name="Local3"> 959 <Annotation Term="OData.Description" String="Locally used facility 3."/> 960 </Member> 961 <Member Name="Local4"> 962 <Annotation Term="OData.Description" String="Locally used facility 4."/> 963 </Member> 964 <Member Name="Local5"> 965 <Annotation Term="OData.Description" String="Locally used facility 5."/> 966 </Member> 967 <Member Name="Local6"> 968 <Annotation Term="OData.Description" String="Locally used facility 6."/> 969 </Member> 970 <Member Name="Local7"> 971 <Annotation Term="OData.Description" String="Locally used facility 7."/> 972 </Member> 973 </EnumType> 974 975 <ComplexType Name="SyslogFilter"> 976 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 977 <Annotation Term="OData.Description" String="A syslog filter."/> 978 <Annotation Term="OData.LongDescription" String="This type shall contain the filter for a syslog message. The filter shall describe the desired syslog message to forward to a remote syslog server."/> 979 <Property Name="LowestSeverity" Type="EventDestination.v1_9_0.SyslogSeverity"> 980 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 981 <Annotation Term="OData.Description" String="The lowest severity level message that will be forwarded."/> 982 <Annotation Term="OData.LongDescription" String="This property shall contain the lowest syslog severity level that will be forwarded. The service shall forward all messages equal to or greater than the value in this property. The value `All` shall indicate all severities."/> 983 </Property> 984 <Property Name="LogFacilities" Type="Collection(EventDestination.v1_9_0.SyslogFacility)"> 985 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 986 <Annotation Term="OData.Description" String="The types of programs that can log messages."/> 987 <Annotation Term="OData.LongDescription" String="This property shall contain the types of programs that can log messages. If this property contains an empty array or is absent, all facilities shall be indicated."/> 988 </Property> 989 </ComplexType> 990 </Schema> 991 992 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_9_1"> 993 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 994 <Annotation Term="OData.Description" String="This version was created to improve the descriptions for EventFormatType and EventDestinationProtocol. It was also created to correct descriptions and terms for SNMP properties. It was also updated to allow for a service to select its own DeliveryRetryPolicy if not specified by the client."/> 995 <EntityType Name="EventDestination" BaseType="EventDestination.v1_9_0.EventDestination"/> 996 </Schema> 997 998 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="EventDestination.v1_10_0"> 999 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 1000 <Annotation Term="OData.Description" String="This version was created to add additional SNMP authentication protocols and to provide better description for the authentication and encryption keys. It also added `RetryForeverWithBackoff` to DeliveryRetryPolicy and long description details to the DeliveryRetryPolicy values."/> 1001 <Annotation Term="Redfish.Release" String="2020.4"/> 1002 1003 <EntityType Name="EventDestination" BaseType="EventDestination.v1_9_1.EventDestination"/> 1004 1005 <ComplexType Name="SNMPSettings" BaseType="EventDestination.v1_7_0.SNMPSettings"> 1006 <Property Name="AuthenticationKeySet" Type="Edm.Boolean" Nullable="false"> 1007 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 1008 <Annotation Term="OData.Description" String="Indicates if the AuthenticationKey property is set."/> 1009 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the AuthenticationKey property. Otherwise, the property shall contain `false`."/> 1010 </Property> 1011 <Property Name="EncryptionKeySet" Type="Edm.Boolean" Nullable="false"> 1012 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 1013 <Annotation Term="OData.Description" String="Indicates if the EncryptionKey property is set."/> 1014 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the EncryptionKey property. Otherwise, the property shall contain `false`."/> 1015 </Property> 1016 </ComplexType> 1017 </Schema> 1018 1019 </edmx:DataServices> 1020</edmx:Edmx> 1021