components:
  schemas:
    EventDestination_v1_8_6_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#EventDestination.ResumeSubscription':
          $ref: '#/components/schemas/EventDestination_v1_8_6_ResumeSubscription'
        Oem:
          $ref: '#/components/schemas/EventDestination_v1_8_6_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
          x-versionAdded: v1_2_0
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    EventDestination_v1_8_6_DeliveryRetryPolicy:
      enum:
      - TerminateAfterRetries
      - SuspendRetries
      - RetryForever
      type: string
      x-enumDescriptions:
        RetryForever: The subscription is not suspended or terminated, and attempts
          at delivery of future events shall continue regardless of the number of
          retries.
        SuspendRetries: The subscription is suspended after the maximum number of
          retries is reached.
        TerminateAfterRetries: The subscription is terminated after the maximum number
          of retries is reached.
      x-enumLongDescriptions:
        RetryForever: This value shall indicate 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.
        SuspendRetries: This value shall indicate the subscription is suspended after
          the maximum number of retries is reached, specified by the DeliveryRetryAttempts
          property in the event service.  The value of the State property within Status
          shall contain `Disabled` for a suspended subscription.
        TerminateAfterRetries: This value shall indicate the subscription is terminated
          after the maximum number of retries is reached, specified by the DeliveryRetryAttempts
          property in the event service.
    EventDestination_v1_8_6_EventDestination:
      additionalProperties: false
      description: 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.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/EventDestination_v1_8_6_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
          x-versionAdded: v1_2_0
        Context:
          description: A client-supplied string that is stored with the event destination
            subscription.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain a client-supplied context
            that remains with the connection through the connection's lifetime.
        DeliveryRetryPolicy:
          $ref: '#/components/schemas/EventDestination_v1_8_6_DeliveryRetryPolicy'
          description: The subscription delivery retry policy for events, where the
            subscription type is RedfishEvent.
          nullable: true
          readOnly: false
          x-longDescription: This property shall indicate the subscription delivery
            retry policy for events where the subscription type is RedfishEvent.
          x-versionAdded: v1_6_0
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        Destination:
          description: The URI of the destination event receiver.
          format: uri-reference
          readOnly: true
          type: string
          x-longDescription: 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://`.  Server-sent event destinations shall
            be in the form `redfish-sse://ip:port` where `ip` and `port` are the IP
            address and the port of the client with the open SSE connection.  For
            other URIs, such as HTTP or HTTPS, they shall be consistent with RFC3986.
        EventFormatType:
          $ref: http://redfish.dmtf.org/schemas/v1/EventDestination.yaml#/components/schemas/EventDestination_EventFormatType
          description: The content types of the message that are sent to the EventDestination.
          nullable: true
          readOnly: true
          x-longDescription: 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.
          x-versionAdded: v1_4_0
        EventTypes:
          deprecated: true
          description: The types of events that are sent to the destination.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/Event.yaml#/components/schemas/Event_EventType
          readOnly: true
          type: array
          x-deprecatedReason: 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`.
          x-longDescription: 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`.
          x-versionDeprecated: v1_5_0
        HttpHeaders:
          description: 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.
          items:
            $ref: '#/components/schemas/EventDestination_v1_8_6_HttpHeaderProperty'
          type: array
          x-longDescription: 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.
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        IncludeOriginOfCondition:
          description: An indication of whether the events subscribed to will also
            include the entire resource or object referenced the OriginOfCondition
            property in the event payload.
          nullable: true
          readOnly: true
          type: boolean
          x-longDescription: 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.
          x-versionAdded: v1_8_0
        MessageIds:
          description: The list of MessageIds that are sent to this event destination.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of MessageIds that
            are the allowable values for the MessageId property within an event sent
            to the subscriber.  The MessageId should be in the `MessageRegistryPrefix.MessageKey`
            format.  If included, the MessageId major and minor version details should
            be ignored.  Events with a MessageId that is not contained in this array
            and is not from a message registry contained in RegistryPrefixes shall
            not be sent to the subscriber.  If this property is an empty array or
            is absent, no inclusive filtering based upon the MessageId of an event
            is performed.
          x-versionAdded: v1_1_0
        MetricReportDefinitions:
          description: 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.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: 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.
          x-versionAdded: v1_6_0
        MetricReportDefinitions@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties that this object contains shall conform to the Redfish
            Specification-described requirements.
        OriginResources:
          description: The array of resources for which the service sends only related
            events.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: 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 event that the service sends
            to the subscriber.  Events with an OriginOfCondition that is not contained
            in this array, and is not subordinate to members of this array if SubordinateResources
            contains the value `true`, shall not be sent to the subscriber.  If this
            property is an empty array or is absent, no filtering based upon the URI
            of the OriginOfCondition of an event is performed.
          x-versionAdded: v1_1_0
        OriginResources@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        Protocol:
          $ref: '#/components/schemas/EventDestination_v1_8_6_EventDestinationProtocol'
          description: The protocol type of the event connection.
          readOnly: true
          x-longDescription: 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.
        RegistryPrefixes:
          description: The list of prefixes for the message registries that contain
            the MessageIds that are sent to this event destination.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array the prefixes of
            message registries that contain the MessageIds that are the allowable
            values for the MessageId property within an event sent to the subscriber.  Events
            with a MessageId that is not from a message registry contained in this
            array and is not contained by MessageIds shall not be sent to the subscriber.  If
            this property is an empty array or is absent, no inclusive filtering based
            upon message registry of the MessageId of an event is performed.
          x-versionAdded: v1_4_0
        ResourceTypes:
          description: The list of resource type values (schema names) that correspond
            to the OriginOfCondition.  The version and full namespace should not be
            specified.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall specify an array of resource type
            values that contain the allowable resource types for the resource referenced
            by the OriginOfCondition property.  Events with the resource type of the
            resource referenced by the OriginOfCondition property that is not contained
            in this array shall not be sent to the subscriber.  If this property is
            an empty array or is absent, no filtering based upon the resource type
            of the OriginOfCondition of an event is performed.  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`.
          x-versionAdded: v1_4_0
        SNMP:
          $ref: '#/components/schemas/EventDestination_v1_8_6_SNMPSettings'
          description: Settings for an SNMP event destination.
          x-longDescription: This property shall contain the settings for an SNMP
            event destination.
          x-versionAdded: v1_7_0
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: This property shall contain the status of the subscription.
          x-longDescription: This property shall contain the status of the subscription.
          x-versionAdded: v1_6_0
        SubordinateResources:
          description: 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.
          nullable: true
          readOnly: true
          type: boolean
          x-longDescription: 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.
          x-versionAdded: v1_4_0
        SubscriptionType:
          $ref: '#/components/schemas/EventDestination_v1_8_6_SubscriptionType'
          description: The subscription type for events.
          nullable: true
          readOnly: true
          x-longDescription: This property shall indicate the type of subscription
            for events.  If this property is not present, the SubscriptionType shall
            be assumed to be RedfishEvent.
          x-versionAdded: v1_3_0
      required:
      - Context
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      - SubscriptionType
      type: object
      x-longDescription: 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.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
      x-requiredOnCreate:
      - Destination
      - Protocol
    EventDestination_v1_8_6_EventDestinationProtocol:
      enum:
      - Redfish
      - SNMPv1
      - SNMPv2c
      - SNMPv3
      - SMTP
      type: string
      x-enumDescriptions:
        Redfish: The destination follows the Redfish Specification for event notifications.
        SMTP: The destination follows the SMTP specification for event notifications.
        SNMPv1: The destination follows the SNMPv1 protocol for event notifications.
        SNMPv2c: The destination follows the SNMPv2c protocol for event notifications.
        SNMPv3: The destination follows the SNMPv3 protocol for event notifications.
      x-enumLongDescriptions:
        Redfish: 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.
        SMTP: This value shall indicate the destination follows the RFC5321-defined
          SMTP specification.
        SNMPv1: This value shall indicate the destination follows the RFC1157-defined
          SNMPv1 protocol.
        SNMPv2c: This value shall indicate the destination follows the SNMPv2c protocol
          as defined by RFC1441 and RFC1452.
        SNMPv3: This value shall indicate the destination follows the SNMPv3 protocol
          as defined by RFC3411 and RFC3418.
      x-enumVersionAdded:
        SMTP: v1_7_0
        SNMPv1: v1_7_0
        SNMPv2c: v1_7_0
        SNMPv3: v1_7_0
    EventDestination_v1_8_6_HttpHeaderProperty:
      additionalProperties: false
      description: The HTTP header value is the property value.  The header name is
        the property name.
      properties: {}
      type: object
      x-longDescription: This type shall contain the HTTP header name and value to
        include with every event POST to the event destination.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
        ^[^:\\s]+$: {}
    EventDestination_v1_8_6_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    EventDestination_v1_8_6_ResumeSubscription:
      additionalProperties: false
      description: This action resumes a suspended event subscription.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall resume a suspended event subscription,
        which affects the subscription status.  The service may deliver buffered events
        when the subscription is resumed.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    EventDestination_v1_8_6_ResumeSubscriptionRequestBody:
      additionalProperties: false
      description: This action resumes a suspended event subscription.
      properties: {}
      type: object
      x-longDescription: This action shall resume a suspended event subscription,
        which affects the subscription status.  The service may deliver buffered events
        when the subscription is resumed.
    EventDestination_v1_8_6_SNMPAuthenticationProtocols:
      enum:
      - None
      - CommunityString
      - HMAC_MD5
      - HMAC_SHA96
      type: string
      x-enumDescriptions:
        CommunityString: Trap community string authentication.
        HMAC_MD5: HMAC-MD5-96 authentication.
        HMAC_SHA96: HMAC-SHA-96 authentication.
        None: No authentication.
      x-enumLongDescriptions:
        CommunityString: This value shall indicate authentication using SNMP community
          strings and the value of TrapCommunity.
        HMAC_MD5: This value shall indicate authentication conforms to the RFC3414-defined
          HMAC-MD5-96 authentication protocol.
        HMAC_SHA96: This value shall indicate authentication conforms to the RFC3414-defined
          HMAC-SHA-96 authentication protocol.
        None: This value shall indicate authentication is not required.
    EventDestination_v1_8_6_SNMPEncryptionProtocols:
      enum:
      - None
      - CBC_DES
      - CFB128_AES128
      type: string
      x-enumDescriptions:
        CBC_DES: CBC-DES encryption.
        CFB128_AES128: CFB128-AES-128 encryption.
        None: No encryption.
      x-enumLongDescriptions:
        CBC_DES: This value shall indicate encryption conforms to the RFC3414-defined
          CBC-DES encryption protocol.
        CFB128_AES128: This value shall indicate encryption conforms to the RFC3414-defined
          CFB128-AES-128 encryption protocol.
        None: This value shall indicate there is no encryption.
    EventDestination_v1_8_6_SNMPSettings:
      additionalProperties: false
      description: Settings for an SNMP event destination.
      properties:
        AuthenticationKey:
          description: The secret authentication key for SNMPv3.
          nullable: true
          pattern: (^[ !#-~]+$)|(^Passphrase:[ ^[ !#-~]+$)|(^Hex:[0-9A-Fa-f]{24,96})|(^\*+$)
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: 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.
          x-versionAdded: v1_7_0
        AuthenticationProtocol:
          $ref: '#/components/schemas/EventDestination_v1_8_6_SNMPAuthenticationProtocols'
          description: The authentication protocol for SNMPv3.
          nullable: true
          readOnly: false
          x-longDescription: This property shall contain the SNMPv3 authentication
            protocol.
          x-versionAdded: v1_7_0
        EncryptionKey:
          description: The secret authentication key for SNMPv3.
          nullable: true
          pattern: (^[A-Za-z0-9]+$)|(^\*+$)
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: 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.
          x-versionAdded: v1_7_0
        EncryptionProtocol:
          $ref: '#/components/schemas/EventDestination_v1_8_6_SNMPEncryptionProtocols'
          description: The encryption protocol for SNMPv3.
          nullable: true
          readOnly: false
          x-longDescription: This property shall contain the SNMPv3 encryption protocol.
          x-versionAdded: v1_7_0
        TrapCommunity:
          description: The SNMP trap community string.
          nullable: true
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: This property shall contain the SNMP trap community string.  The
            value shall be `null` in responses.
          x-versionAdded: v1_7_0
      type: object
      x-longDescription: This type shall contain the settings for an SNMP event destination.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    EventDestination_v1_8_6_SubscriptionType:
      enum:
      - RedfishEvent
      - SSE
      - SNMPTrap
      - SNMPInform
      type: string
      x-enumDescriptions:
        RedfishEvent: 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.
        SNMPInform: The subscription follows versions 2 and 3 of SNMP Inform for event
          notifications.
        SNMPTrap: The subscription follows the various versions of SNMP Traps for
          event notifications.
        SSE: The subscription follows the HTML5 server-sent event definition for event
          notifications.
      x-enumLongDescriptions:
        SNMPInform: 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.
        SNMPTrap: This value shall indicate the subscription follows the various versions
          of SNMP Traps for event notifications.  Protocol shall specify the appropriate
          version of SNMP.
      x-enumVersionAdded:
        SNMPInform: v1_7_0
        SNMPTrap: v1_7_0
title: '#EventDestination.v1_8_6.EventDestination'
x-copyright: Copyright 2014-2022 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2020.1'
