components:
  schemas:
    EventService_v1_5_5_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#EventService.SubmitTestEvent':
          $ref: '#/components/schemas/EventService_v1_5_5_SubmitTestEvent'
        Oem:
          $ref: '#/components/schemas/EventService_v1_5_5_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      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.
    EventService_v1_5_5_EventService:
      additionalProperties: false
      description: The EventService schema contains properties for managing event
        subscriptions and generates the events sent to subscribers.  The resource
        has links to the actual collection of subscriptions, which are called event
        destinations.
      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/EventService_v1_5_5_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        DeliveryRetryAttempts:
          description: The number of times that the POST of an event is retried before
            the subscription terminates.  This retry occurs at the service level,
            which means that the HTTP POST to the event destination fails with an
            HTTP `4XX` or `5XX` status code or an HTTP timeout occurs this many times
            before the event destination subscription terminates.
          format: int64
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the number of times that
            the POST of an event is retried before the subscription terminates.  This
            retry occurs at the service level, which means that the HTTP POST to the
            event destination fails with an HTTP `4XX` or `5XX` status code or an
            HTTP timeout occurs this many times before the event destination subscription
            terminates.
        DeliveryRetryIntervalSeconds:
          description: The interval, in seconds, between retry attempts for sending
            any event.
          format: int64
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the interval, in seconds,
            between the retry attempts for any event sent to the subscription destination.
          x-units: s
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        EventFormatTypes:
          description: The content types of the message that this service can send
            to the event destination.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/EventDestination.yaml#/components/schemas/EventDestination_EventFormatType
            nullable: true
          readOnly: true
          type: array
          x-longDescription: This property shall contain the content types of the
            message that this service can send to the event destination.  If this
            property is not present, the EventFormatType shall be assumed to be `Event`.
          x-versionAdded: v1_2_0
        EventTypesForSubscription:
          deprecated: true
          description: The types of events to which a client can subscribe.
          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.
          x-longDescription: This property shall contain the types of events to which
            a client can subscribe.  The semantics associated with the enumeration
            values are defined in the Redfish Specification.
          x-versionDeprecated: v1_3_0
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        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.
        RegistryPrefixes:
          description: The list of the prefixes of the message registries that can
            be used for the RegistryPrefixes or ExcludeRegistryPrefixes properties
            on a subscription.  If this property is absent or contains an empty array,
            the service does not support RegistryPrefix-based subscriptions.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall contain the array of the prefixes
            of the message registries that shall be allowed or excluded for an event
            subscription.
          x-versionAdded: v1_2_0
        ResourceTypes:
          description: The list of @odata.type values, or schema names, that can be
            specified in the ResourceTypes array in a subscription.  If this property
            is absent or contains an empty array, the service does not support resource
            type-based subscriptions.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall specify an array of the valid @odata.type
            values that can be used for an event subscription.
          x-versionAdded: v1_2_0
        SMTP:
          $ref: '#/components/schemas/EventService_v1_5_5_SMTP'
          description: Settings for SMTP event delivery.
          x-longDescription: This property shall contain settings for SMTP event delivery.
          x-versionAdded: v1_5_0
        SSEFilterPropertiesSupported:
          $ref: '#/components/schemas/EventService_v1_5_5_SSEFilterPropertiesSupported'
          description: The set of properties that are supported in the `$filter` query
            parameter for the ServerSentEventUri.
          x-longDescription: This property shall contain the properties that are supported
            in the `$filter` query parameter for the URI indicated by the ServerSentEventUri
            property, as described by the Redfish Specification.
          x-versionAdded: v1_2_0
        ServerSentEventUri:
          description: The link to a URI for receiving Server-Sent Event representations
            for the events that this service generates.
          format: uri-reference
          readOnly: true
          type: string
          x-longDescription: This property shall contain a URI that specifies an HTML5
            Server-Sent Event-conformant endpoint.
          x-versionAdded: v1_1_0
        ServiceEnabled:
          description: An indication of whether this service is enabled.  If `false`,
            events are no longer published, new SSE connections cannot be established,
            and existing SSE connections are terminated.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate whether this service is
            enabled.  If `false`, events are no longer published, new SSE connections
            cannot be established, and existing SSE connections are terminated.
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
        SubordinateResourcesSupported:
          description: An indication of whether the service supports the SubordinateResources
            property on both event subscriptions and generated events.
          nullable: true
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether the service supports
            the SubordinateResources property on both event subscriptions and generated
            events.
          x-versionAdded: v1_2_0
        Subscriptions:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to a collection of event destinations.
          readOnly: true
          x-longDescription: This property shall contain the link to a resource collection
            of type EventDestinationCollection.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall represent an event service for a Redfish
        implementation.
      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.
    EventService_v1_5_5_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.
    EventService_v1_5_5_SMTP:
      additionalProperties: false
      description: Settings for SMTP event delivery.
      properties:
        Authentication:
          $ref: '#/components/schemas/EventService_v1_5_5_SMTPAuthenticationMethods'
          description: The authentication method for the SMTP server.
          nullable: true
          readOnly: false
          x-longDescription: This property shall contain the authentication method
            for the SMTP server.
          x-versionAdded: v1_5_0
        ConnectionProtocol:
          $ref: '#/components/schemas/EventService_v1_5_5_SMTPConnectionProtocol'
          description: The connection type to the outgoing SMTP server.
          nullable: true
          readOnly: false
          x-longDescription: This property shall contain the connection type to the
            outgoing SMTP server.
          x-versionAdded: v1_5_0
        FromAddress:
          description: The 'from' email address of the outgoing email.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the email address to use
            for the 'from' field in an outgoing email.
          x-versionAdded: v1_5_0
        Password:
          description: The password for authentication with the SMTP server.  The
            value is `null` in responses.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the password for authentication
            with the SMTP server.  The value shall be `null` in responses.
          x-versionAdded: v1_5_0
        Port:
          description: The destination SMTP port.
          format: int64
          maximum: 65535
          minimum: 0
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the destination port for
            the SMTP server.
          x-versionAdded: v1_5_0
        ServerAddress:
          description: The address of the SMTP server.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the address of the SMTP server
            for outgoing email.
          x-versionAdded: v1_5_0
        ServiceEnabled:
          description: An indication if SMTP for event delivery is enabled.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate if SMTP for event delivery
            is enabled.
          x-versionAdded: v1_5_0
        Username:
          description: The username for authentication with the SMTP server.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the username for authentication
            with the SMTP server.
          x-versionAdded: v1_5_0
      type: object
      x-longDescription: This type shall contain settings for SMTP event delivery.
      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.
    EventService_v1_5_5_SMTPAuthenticationMethods:
      enum:
      - None
      - AutoDetect
      - Plain
      - Login
      - CRAM_MD5
      type: string
      x-enumDescriptions:
        AutoDetect: Auto-detect.
        CRAM_MD5: CRAM-MD5 authentication.
        Login: LOGIN authentication.
        None: No authentication.
        Plain: PLAIN authentication.
      x-enumLongDescriptions:
        AutoDetect: This value shall indicate authentication is auto-detected.
        CRAM_MD5: This value shall indicate authentication conforms to the RFC4954-defined
          AUTH CRAM-MD5 mechanism.
        Login: This value shall indicate authentication conforms to the RFC4954-defined
          AUTH LOGIN mechanism.
        None: This value shall indicate authentication is not required.
        Plain: This value shall indicate authentication conforms to the RFC4954-defined
          AUTH PLAIN mechanism.
    EventService_v1_5_5_SMTPConnectionProtocol:
      enum:
      - None
      - AutoDetect
      - StartTLS
      - TLS_SSL
      type: string
      x-enumDescriptions:
        AutoDetect: Auto-detect.
        None: Clear text.
        StartTLS: StartTLS.
        TLS_SSL: TLS/SSL.
      x-enumLongDescriptions:
        AutoDetect: This value shall indicate the connection is auto-detected.
        None: This value shall indicate the connection is in clear text.
        StartTLS: This value shall indicate the connection conforms to the RFC3207-defined
          StartTLS extension.
        TLS_SSL: This value shall indicate the connection is TLS/SSL.
    EventService_v1_5_5_SSEFilterPropertiesSupported:
      additionalProperties: false
      description: The set of properties that are supported in the `$filter` query
        parameter for the ServerSentEventUri.
      properties:
        EventFormatType:
          description: An indication of whether the service supports filtering by
            the EventFormatType property.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether this service supports
            filtering by the EventFormatType property.
          x-versionAdded: v1_2_0
        EventType:
          deprecated: true
          description: An indication of whether the service supports filtering by
            the EventTypes property.
          readOnly: true
          type: boolean
          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.
          x-longDescription: This property shall indicate whether this service supports
            filtering by the EventTypes property.
          x-versionAdded: v1_2_0
          x-versionDeprecated: v1_3_0
        MessageId:
          description: An indication of whether the service supports filtering by
            the MessageIds property.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether this service supports
            filtering by the MessageIds property.
          x-versionAdded: v1_2_0
        MetricReportDefinition:
          description: An indication of whether the service supports filtering by
            the MetricReportDefinitions property.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether this service supports
            filtering by the MetricReportDefinitions property.
          x-versionAdded: v1_2_0
        OriginResource:
          description: An indication of whether the service supports filtering by
            the OriginResources property.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether this service supports
            filtering by the OriginResources property.
          x-versionAdded: v1_2_0
        RegistryPrefix:
          description: An indication of whether the service supports filtering by
            the RegistryPrefixes property.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether this service supports
            filtering by the RegistryPrefixes property.
          x-versionAdded: v1_2_0
        ResourceType:
          description: An indication of whether the service supports filtering by
            the ResourceTypes property.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether this service supports
            filtering by the ResourceTypes property.
          x-versionAdded: v1_2_0
        SubordinateResources:
          description: An indication of whether the service supports filtering by
            the SubordinateResources property.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether this service supports
            filtering by the SubordinateResources property.
          x-versionAdded: v1_4_0
      type: object
      x-longDescription: The type shall contain a set of properties that are supported
        in the `$filter` query parameter for the URI indicated by the ServerSentEventUri
        property, as described by the Redfish Specification.
      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.
    EventService_v1_5_5_SubmitTestEvent:
      additionalProperties: false
      description: This action generates a test event.
      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 add a test event to the event service with
        the event data specified in the action parameters.  Then, this message should
        be sent to any appropriate event destinations.
      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.
    EventService_v1_5_5_SubmitTestEventRequestBody:
      additionalProperties: false
      description: This action generates a test event.
      properties:
        EventGroupId:
          description: The group identifier for the event.
          format: int64
          type: integer
          x-longDescription: The parameter shall contain the group identifier for
            the event.  It has the same semantics as the EventGroupId property in
            the Event schema for Redfish.
          x-versionAdded: v1_3_0
        EventId:
          description: The ID for the event to add.
          type: string
          x-longDescription: This parameter shall have the same semantics as the EventId
            property in the Event schema for Redfish.  A service can ignore this value
            and replace it with its own.
        EventTimestamp:
          description: The date and time for the event to add.
          format: date-time
          type: string
          x-longDescription: This parameter shall contain the date and time for the
            event to add and have the same semantics as the EventTimestamp property
            in the Event schema for Redfish.
        EventType:
          $ref: http://redfish.dmtf.org/schemas/v1/Event.yaml#/components/schemas/Event_EventType
          deprecated: true
          description: The type for the event to add.
          x-deprecatedReason: This parameter has been deprecated.  Starting with Redfish
            Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix
            and ResourceType properties and not on the EventType property.
          x-longDescription: This parameter shall contain the property name for which
            the following allowable values apply.
          x-versionDeprecated: v1_3_0
        Message:
          description: The human-readable message for the event to add.
          type: string
          x-longDescription: This parameter shall have the same semantics as the Message
            property in the Event schema for Redfish.
        MessageArgs:
          description: An array of message arguments for the event to add.
          items:
            type: string
          type: array
          x-longDescription: This parameter shall have the same semantics as the MessageArgs
            property in the Event schema for Redfish.
        MessageId:
          description: The MessageId for the event to add.
          type: string
          x-longDescription: This parameter shall contain the MessageId for the event
            to add and have the same semantics as the MessageId property in the Event
            schema for Redfish.
        OriginOfCondition:
          description: The URL in the OriginOfCondition property of the event to add.  It
            is not a reference object.
          format: uri-reference
          type: string
          x-longDescription: This parameter shall be a string that represents the
            URL contained by the OriginOfCondition property in the Event schema for
            Redfish.
        Severity:
          description: The severity for the event to add.
          type: string
          x-longDescription: This parameter shall contain the severity for the event
            to add and have the same semantics as the Severity property in the Event
            schema for Redfish.
      required:
      - MessageId
      type: object
      x-longDescription: This action shall add a test event to the event service with
        the event data specified in the action parameters.  Then, this message should
        be sent to any appropriate event destinations.
title: '#EventService.v1_5_5.EventService'
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: '2019.3'
