SOL003-VNFFaultManagement-API.yaml

                description: >
                  If present, match VNF instances with an instance identifier
                  listed in this attribute. The attributes "vnfInstanceIds" and
                  "vnfInstanceNames" are alternatives to reference to particular
                  VNF Instances in a filter. They should not be used both in the
                  same filter instance, but one alternative should be chosen.
                type: array
                items:
                  description: |
                    An identifier with the intention of being globally unique.
                  type: string
              vnfInstanceNames:
                description: >
                  If present, match VNF instances with a VNF Instance Name
                  listed in this attribute. The attributes "vnfInstanceIds" and
                  "vnfInstanceNames" are alternatives to reference to particular
                  VNF Instances in a filter. They should not be used both in the
                  same filter instance, but one alternative should be chosen.
                type: array
                items:
                  type: string
          notificationTypes:
            description: >
              Match particular notification types. Permitted values: *
              AlarmNotification * AlarmClearedNotification *
              AlarmListRebuiltNotification The permitted values of the
              "notificationTypes" attribute are spelled exactly as the names of
              the notification types to facilitate automated code generation
              systems.
            type: array
            items:
              type: string
              enum:
                - AlarmNotification
                - AlarmClearedNotification
                - AlarmListRebuiltNotification
          faultyResourceTypes:
            description: >
              Match VNF alarms with a faulty resource type listed in this
              attribute.
            type: array
            items:
              description: >
                The enumeration FaultyResourceType represents those types of
                faulty resource.
              type: string
              enum:
                - COMPUTE
                - STORAGE
                - NETWORK
          perceivedSeverities:
            description: >
              Match VNF alarms with a perceived severity listed in this
              attribute.
            type: array
            items:
              description: >
                Indicates the relative level of urgency for operator attention.
                * CRITICAL: The Critical severity level indicates that a service
                  affecting condition has occurred and an immediate corrective action
                  is required. Such a severity can be reported, for example, when a
                  managed object becomes totally out of service and its capability needs
                  to be restored (ITU-T Recommendation X.733).
                * MAJOR: The Major severity level indicates that a service
                affecting
                  condition has developed and an urgent corrective action is required.
                  Such a severity can be reported, for example, when there is a severe
                  degradation in the capability of the managed object and its full
                  capability needs to be restored (ITU-T Recommendation X.733).
                * MINOR: The Minor severity level indicates the existence of a
                  non-service affecting fault condition and that corrective action
                  should be taken in order to prevent a more serious (for example,
                  service affecting) fault. Such a severity can be reported, for
                  example, when the detected alarm condition is not currently degrading
                  the capacity of the managed object (ITU-T Recommendation X.733).
                * WARNING: The Warning severity level indicates the detection of
                a
                  potential or impending service affecting fault, before any significant
                  effects have been felt. Action should be taken to further diagnose (if
                  necessary) and correct the problem in order to prevent it from
                  becoming a more serious service affecting fault (ITU-T Recommendation
                  X.733).
                * INDETERMINATE: The Indeterminate severity level indicates that
                the
                  severity level cannot be determined (ITU-T Recommendation X.733).
                * CLEARED: The Cleared severity level indicates the clearing of
                one or
                  more previously reported alarms. This alarm clears all alarms for this
                  managed object that have the same Alarm type, Probable cause and
                  Specific problems (if given) (ITU-T Recommendation X.733).
              type: string
              enum:
                - CRITICAL
                - MAJOR
                - MINOR
                - WARNING
                - INDETERMINATE
                - CLEARED
          eventTypes:
            description: |
              Match VNF alarms with an event type listed in this attribute.
            type: array
            items:
              description: >
                The enumeration EventType represents those types of events that
                trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type
                is associated with the
                  procedure and/or process required conveying information from one point
                  to another (ITU-T Recommendation X.733).
                * PROCESSING_ERROR_ALARM: An alarm of this type is associated
                with a
                  software or processing fault (ITU-T Recommendation X.733).
                * ENVIRONMENTAL_ALARM: An alarm of this type is associated with
                a
                  condition related to an enclosure in which the equipment resides
                  (ITU-T Recommendation X.733).
                * QOS_ALARM: An alarm of this type is associated with
                degradation in the
                  quality of a service (ITU-T Recommendation X.733).
                * EQUIPMENT_ALARM: An alarm of this type is associated with an
                equipment
                  fault (ITU-T Recommendation X.733).
              type: string
              enum:
                - COMMUNICATIONS_ALARM
                - PROCESSING_ERROR_ALARM
                - ENVIRONMENTAL_ALARM
                - QOS_ALARM
                - EQUIPMENT_ALARM
          probableCauses:
            description: |
              Match VNF alarms with a probable cause listed in this attribute.
            type: array
            items:
              type: string
      callbackUri:
        description: |
          The URI of the endpoint to send the notification to.
        type: string
        format: url
      authentication:
        type: object
        required:
          - authType
        properties:
          authType:
            description: >
              Defines the types of Authentication / Authorization which the API
              consumer is willing to accept when receiving a notification.
              Permitted values: * BASIC: In every HTTP request to the
              notification endpoint, use
                HTTP Basic authentication with the client credentials. 
              * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
                notification endpoint, use an OAuth 2.0 Bearer token, obtained
                using the client credentials grant type.
              * TLS_CERT: Every HTTP request to the notification endpoint is
              sent
                over a mutually authenticated TLS session, i.e. not only the
                server is authenticated, but also the client is authenticated
                during the TLS tunnel setup.
            type: array
            items:
              type: string
              enum:
                - BASIC
                - OAUTH2_CLIENT_CREDENTIALS
                - TLS_CERT
          paramsBasic:
            description: >
              Parameters for authentication/authorization using BASIC. Shall be
              present if authType is "BASIC" and the contained information has
              not been provisioned out of band. Shall be absent otherwise.
            type: object
            properties:
              userName:
                description: >
                  Username to be used in HTTP Basic authentication. Shall be
                  present if it has not been provisioned out of band.
                type: string
              password:
                description: >
                  Password to be used in HTTP Basic authentication. Shall be
                  present if it has not been provisioned out of band.
                type: string
          paramsOauth2ClientCredentials:
            description: >
              Parameters for authentication/authorization using
              OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is
              "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not
              been provisioned out of band. Shall be absent otherwise.
            type: object
            properties:
              clientId:
                description: >
                  Client identifier to be used in the access token request of
                  the OAuth 2.0 client credentials grant type.  Shall be present
                  if it has not been provisioned out of band. The clientId and
                  clientPassword passed in a subscription shall not be the same
                  as the clientId and clientPassword that are used to obtain
                  authorization for API requests. Client credentials may differ
                  between subscriptions. The value of clientPassword should be
                  generated by a random process.
                type: string
              clientPassword:
                description: >
                  Client password to be used in the access token request of the
                  OAuth 2.0 client credentials grant type.  Shall be present if
                  it has not been provisioned out of band. The clientId and
                  clientPassword passed in a subscription shall not be the same
                  as the clientId and clientPassword that are used to obtain
                  authorization for API requests. Client credentials may differ
                  between subscriptions. The value of clientPassword should be
                  generated by a random process.
                type: string
              tokenEndpoint:
                description: |
                  String formatted according to IETF RFC 3986.
                type: string