SOL002SOL003VNFLifecycleManagement_def.yaml

# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
  InstantiateVnfRequest:
    type: object
    required:
      - flavourId
    properties:
      flavourId:
        description: >
          Identifier of the VNF deployment flavour to be instantiated.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment flavour to be
          instantiated. If not present, the default instantiation level as
          declared in the VNFD is instantiated.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData"
      localizationLanguage:
        description: >
          Localization language of the VNF to be instantiated. The value shall
          comply with the format defined in IETF RFC 5646.
        type: string
      additionalParams:
        description: >
          Additional input parameters for the instantiation process, specific
          to the VNF being instantiated, as declared in the VNFD as part of
          "InstantiateVnfOpConfig".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          If present, this attribute provides values for the "extensions" attribute in "VnfInstance",
          as defined in clause 5.5.2.2. If an entry with the same key exists in the VnfInstance data structure,
          the VNFM shall replace its value with the value passed in the InstantiateVnfRequest data structure.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  VnfLcmOpOcc:
    description: >
      This type represents a VNF lifecycle management operation occurrence.
    type: object
    required:
      - id
      - operationState
      - stateEnteredTime
      - startTime
      - vnfInstanceId
      - operation
      - isAutomaticInvocation
      - isCancelPending
    properties:
      id:
        description: >
          Identifier of this VNF lifecycle management operation occurrence.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      operationState:
        description: >
          The state of the LCM operation.
        $ref: "#/definitions/LcmOperationStateType"
      stateEnteredTime:
        description: >
          Date-time when the current state was entered.
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      startTime:
        description: >
          Date-time of the start of the operation.
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to which the operation applies
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      grantId:
        description: >
          Identifier of the grant related to this VNF LCM operation
          occurrence, if such grant exists.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      operation:
        description: >
          Type of the actual LCM operation represented by this VNF LCM
          operation occurrence.
        $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType"
      isAutomaticInvocation:
        description: >
          Set to true if this VNF LCM operation occurrence has been triggered
          by an automated procedure inside the VNFM (i.e.
          ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
          triggered by auto-heal). Set to false otherwise.
        $ref: "SOL002SOL003_def.yaml#/definitions/Boolean"
      operationParams:
        description: >
          Input parameters of the LCM operation. This attribute shall be
          formatted according to the request data type of the related LCM
          operation. The following mapping between operationType and the
          data type of this attribute shall apply:
          * INSTANTIATE: InstantiateVnfRequest
          * SCALE: ScaleVnfRequest
          * SCALE_TO_LEVEL: ScaleVnfToLevelRequest
          * CHANGE_FLAVOUR: ChangeVnfFlavourRequest
          * OPERATE: OperateVnfRequest
          * HEAL: HealVnfRequest
          * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest
          * TERMINATE: TerminateVnfRequest
          * MODIFY_INFO: VnfInfoModifications
        type: object
      isCancelPending:
        description: >
          If the VNF LCM operation occurrence is in "STARTING", "PROCESSING"
          or "ROLLING_BACK" state and the operation is being cancelled, this
          attribute shall be set to true. Otherwise, it shall be set to false.
        $ref: "SOL002SOL003_def.yaml#/definitions/Boolean"
      cancelMode:
        description: >
          The mode of an ongoing cancellation. Shall be present when
          isCancelPending=true, and shall be absent otherwise.
        $ref: "#/definitions/CancelModeType"
      error:
        description: >
          If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState"
          is "PROCESSING" or "ROLLING_BACK" and previous value of
          "operationState" was "FAILED_TEMP", this attribute shall be present
          and contain error information, unless it has been requested to be
          excluded via an attribute selector.
        $ref: "SOL002SOL003_def.yaml#/definitions/ProblemDetails"
      resourceChanges:
        description: >
          This attribute contains information about the cumulative changes to
          virtualised resources that were performed so far by the LCM
          operation since its start, if applicable.
        type: object
        properties:
          affectedVnfcs:
            description: >
              Information about VNFC instances that were affected during the
              lifecycle operation.
              This allows the NFVO to obtain the information contained in the
              latest "result" notification if it has not received it due to an
              error or a wrongly configured subscription filter.
            type: array
            items:
              $ref: "SOL002SOL003_def.yaml#/definitions/AffectedVnfc"
          affectedVirtualLinks:
            description: >
              Information about VL instances that were affected during the
              lifecycle operation.
              This allows the NFVO to obtain the information contained in the
              latest "result" notification if it has not received it due to an
              error or a wrongly configured subscription filter.
            type: array
            items:
              $ref: "#/definitions/AffectedVirtualLink"
          affectedVirtualStorages:
            description: >
              Information about virtualised storage instances that were affected
              during the lifecycle operation.
              This allows the NFVO to obtain the information contained in the
              latest "result" notification if it has not received it due to an
              error or a wrongly configured subscription filter.
            type: array
            items:
              $ref: "#/definitions/AffectedVirtualStorage"
      changedInfo:
        description: >
          Information about the changed VNF instance information, including
          VNF configurable properties, if applicable.
          This allows the NFVO to obtain the information contained in the
          latest "result" notification if it has not received it due to an
          error or a wrongly configured subscription filter.
        $ref: "#/definitions/VnfInfoModifications"
      changedExtConnectivity:
        description: >
          Information about changed external connectivity, if applicable.
          This allows the NFVO to obtain the information contained in the
          latest "result" notification if it has not received it due to an
          error or a wrongly configured subscription filter.
        type: array
        items:
          $ref: "#/definitions/ExtVirtualLinkInfo"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - vnfInstance
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          vnfInstance:
            description: >
              Link to the VNF instance that the operation applies to.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          grant:
            description: >
              Link to the grant for this operation, if one exists.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          cancel:
            description: >
              Link to the task resource that represents the "cancel" operation
              for this VNF LCM operation occurrence, if cancelling is
              currently allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          retry:
            description: >
              Link to the task resource that represents the "retry" operation
              for this VNF LCM operation occurrence, if retrying is currently
              allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          rollback:
            description: >
              Link to the task resource that represents the "rollback"
              operation for this VNF LCM operation occurrence, if rolling back
              is currently allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          fail:
            description: >
              Link to the task resource that represents the "fail" operation
              for this VNF LCM operation occurrence, if declaring as failed is
              currently allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"

  CancelModeType:
    description: >
      Cancellation mode.
      GRACEFUL: The VNFM shall not start any new resource management operation
      and shall wait for the ongoing resource management operations in the
      underlying system, typically the VIM, to finish execution or to time
      out. After that, the VNFM shall put the operation occurrence into the
      FAILED_TEMP state.
      FORCEFUL: The VNFM shall not start any new resource management
      operation, shall cancel the ongoing resource management operations
      in the underlying system, typically the VIM, and shall wait for the
      cancellation to finish or to time out. After that, the VNFM shall put
      the operation occurrence into the FAILED_TEMP state.
    type: string
    enum:
      - GRACEFUL
      - FORCEFUL

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs.
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
      - changeType
      - networkResource
    properties:
      id:
        description: >
          Identifier of the virtual link instance, identifying the applicable
          "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the related VLD in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      changeType:
        description: >
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          * LINK_PORT_ADDED
          * LINK_PORT_REMOVED
          For a temporary resource, an AffectedVirtualLink structure exists as
          long as the temporary resource exists.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
          - LINK_PORT_ADDED
          - LINK_PORT_REMOVED
      networkResource:
        description: >
          Reference to the VirtualNetwork resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      metadata:
        description: >
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VnfVirtualLinkResourceInfo structure.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  AffectedVirtualStorage:
    description: >
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
    type: object
    required:
      - id
      - virtualStorageDescId
      - changeType
      - storageResource
    properties:
      id:
        description: >
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      virtualStorageDescId:
        description: >
          Identifier of the related VirtualStorage descriptor in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      changeType:
        description: >
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          For a temporary resource, an AffectedVirtualStorage structure exists
          as long as the temporary resource exists.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
      storageResource:
        description: >
          Reference to the VirtualStorage resource. Detailed information is 
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      metadata:
        description: >
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  CpProtocolInfo:
    description: >
      This type describes the protocol layer(s) that a CP uses together with
      protocol-related information, like addresses. 
    required:
      - layerProtocol
    properties:
      layerProtocol:
        description: >
          The identifier of layer(s) and protocol(s) associated to the network
          address information. 
          Permitted values: IP_OVER_ETHERNET
          This attribute allows to signal the addition of further types of
          layer and protocol in future versions of the present document in a
          backwards-compatible way. In the current version of the present
          document, only IP over Ethernet is supported.
        type: string
        enum:
          - IP_OVER_ETHERNET
      ipOverEthernet:
        description: >
          IP addresses over Ethernet to assign to the extCP instance. Shall be
          present if layerProtocol is equal to " IP_OVER_ETHERNET", and shall
          be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressInfo"

  CreateVnfRequest:
    type: object
    required:
      - vnfdId
    properties:
      vnfdId:
        description: >
          Identifier that identifies the VNFD which defines the VNF instance to
          be created.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfInstanceName:
        description: >
          Human-readable name of the VNF instance to be created.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance to be created.
        type: string
      metadata:
        description: >
          If present, this attribute provides values for the "metadata" attribute in "VnfInstance",
          as defined in clause 5.5.2.2.
          If a “metadata” entry in this CreateVnfRequest data structure has a corresponding default
          value declared in the VNFD, the value in the “metadata” entry in the CreateVnfRequest
          structure takes precedence.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  ExtManagedVirtualLinkInfo:
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
    properties:
      id:
        description: >
          Identifier of the externally-managed internal VL and the related
          externally-managed VL information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"

  ExtLinkPortInfo:
    description: >
      This type represents information about a link port of an external VL,
      i.e. a port providing connectivity for the VNF to an NS VL. 
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that has
          created the link port.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link
          port.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
        description: >
          Identifier of the external CP of the VNF connected to this link
          port. There shall be at most one link port associated with any
          external connection point instance. The value refers to an
          "extCpInfo" item in the VnfInstance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"

  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of the external VL and the related external VL
          information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"

  IpOverEthernetAddressInfo:
    description: >
      This type represents information about a network address that has been
      assigned. 
    type: object
    properties:
      macAddress:
        description: >
          MAC address, if assigned.
          At least one of "macAddress" or "ipAddresses" shall be present.
        $ref: "SOL002SOL003_def.yaml#/definitions/MacAddress"
      ipAddresses:
        description: >
          Addresses assigned to the CP instance. Each entry represents IP
          addresses assigned by fixed or dynamic IP address assignment per
          subnet.
        type: array
        items:
          type: object
          required:
            - type
          properties:
            type:
              description: >
                The type of the IP addresses.
                Permitted values: IPV4, IPV6.
              type: string
              enum:
                - IPV4
                - IPV6
            addresses:
              description: >
                Fixed addresses assigned (from the subnet defined by
                "subnetId" if provided).
                Exactly one of "addresses" or "addressRange" shall be present.
              type: array
              items:
                $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress"
            isDynamic:
              description: >
                Indicates whether this set of addresses was assigned
                dynamically (true) or based on address information provided as
                input from the API consumer (false). Shall be present if
                "addresses" is present and shall be absent otherwise.
              type: boolean
            addressRange:
              description: >
                An IP address range used, e.g., in case of egress connections.
                Exactly one of "addresses" or "addressRange" shall be present.
              type: object
              required:
                - minAddress
                - maxAddress
              properties:
                minAddress:
                  description: >
                    Lowest IP address belonging to the range.
                  $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress"
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
                  $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress"
            subnetId:
              description: >
                Subnet defined by the identifier of the subnet resource in
                the VIM.
                In case this attribute is present, IP addresses are bound
                to that subnet.
              $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress"

  LccnLinks:
    description: >
      This type represents the links to resources that a notification can
      contain.
    type: object
    required:
      - vnfInstance
      - subscription
    properties:
      vnfInstance:
        description: >
          Link to the resource representing the VNF instance to which the
          notified change applies.
        $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
      subscription:
        description: >
          Link to the related subscription.
        $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
      vnfLcmOpOcc:
        description: >
          Link to the VNF lifecycle management operation occurrence that this
          notification is related to. Shall be present if there is a related
          lifecycle operation occurrence.
        $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"

  LccnSubscription:
    description: >
      This type represents a subscription related to notifications about VNF
      lifecycle changes.
    type: object
    required:
      - id
      - callbackUri
      - _links
    properties:
      id:
        description: >
          Identifier of this subscription resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Uri"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"

  VnfLcmOperationOccurrenceNotification:
    description: >
      This type represents a VNF lifecycle management operation occurrence
      notification, which informs the receiver of changes in the VNF
      lifecycle caused by a VNF LCM operation occurrence. The support of the
      notification is mandatory.
      This notification shall be triggered by the VNFM when there is a change
      in the VNF lifecycle caused by a VNF LCM operation occurrence,
      including:
      * Instantiation of the VNF
      * Scaling of the VNF instance (including auto-scaling)
      * Healing of the VNF instance (including auto-healing)
      * Change of the state of the VNF instance (i.e. Operate VNF)
      * Change of the deployment flavour of the VNF instance
      * Change of the external connectivity of the VNF instance
      * Termination of the VNF instance
      * Modification of VNF instance information and/or VNF configurable
        properties through the "PATCH" method on the "Individual VNF instance"
        resource.
      If this is the initial notification about the start of a VNF LCM
      operation occurrence, it is assumed that the notification is sent by the
      VNFM before any action (including sending the grant request) is taken as
      part of the LCM operation. Due to possible race conditions, the "start"
      notification, the grant request and the LCM operation acknowledgment can
      arrive in any order at the NFVO, and the NFVO shall be able to handle
      such a situation.
      If this is a notification about a final or intermediate result state of
      a VNF LCM operation occurrence, the notification shall be sent after
      all related actions of the LCM operation that led to this state have
      been executed. The new state shall be set in the VnfLcmOpOcc resource
      before the notification about the state change is sent.
    type: object
    required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - notificationStatus
      - operationState
      - vnfInstanceId
      - operation
      - isAutomaticInvocation
      - vnfLcmOpOccId
      - _links
    properties:
      id:
        description: >
          Identifier of this notification. If a notification is sent multiple
          times due to multiple subscriptions, the "id" attribute of all these
          notifications shall have the same value.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      notificationType:
        description: >
          Discriminator for the different notification types. Shall be set to
          "VnfLcmOperationOccurrenceNotification" for this notification type.
        type: string
        enum:
          - VnfLcmOperationOccurrenceNotification
      subscriptionId:
        description: >
          Identifier of the subscription that this notification relates to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      notificationStatus:
        description: >
          Indicates whether this notification reports about the start of a
          lifecycle operation or the result of a lifecycle operation.
          Permitted values:
          * START: Informs about the start of the VNF LCM operation
            occurrence.
          * RESULT: Informs about the final or intermediate result of the VNF
            LCM operation occurrence.
        type: string
        enum:
          - START
          - RESULT
      operationState:
        description: >
          The state of the VNF LCM operation occurrence.
        $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType"
      vnfInstanceId:
        description: >
          The identifier of the VNF instance affected.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      operation:
        description: >
          The lifecycle management operation.
        $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType"
      isAutomaticInvocation:
        description: >
          Set to true if this VNF LCM operation occurrence has been triggered
          by an automated procedure inside the VNFM
          (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
          triggered by auto-heal).
          Set to false otherwise.
        type: boolean
      vnfLcmOpOccId:
        description: >
          The identifier of the VNF lifecycle management operation occurrence
          associated to the notification.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      affectedVnfcs:
        description: >
          Information about VNFC instances that were affected during the
          lifecycle operation.
          Shall be present if the "notificationStatus" is set to "RESULT" and
          the operation has performed any resource modification. Shall be
          absent otherwise. This attribute contains information about the
          cumulative changes to virtualised resources that were performed so
          far by the VNF LCM operation occurrence and by any of the error
          handling procedures for that operation occurrence.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/AffectedVnfc"
      affectedVirtualLinks:
        description: >
          Information about VL instances that were affected during the
          lifecycle operation.
          Shall be present if the "notificationStatus" is set to "RESULT" and
          the operation has performed any resource modification. Shall be
          absent otherwise. This attribute contains information about the
          cumulative changes to virtualised resources that were performed so
          far by the VNF LCM operation occurrence and by any of the error
          handling procedures for that operation occurrence.
        type: array
        items:
          $ref: "#/definitions/AffectedVirtualLink"
      affectedVirtualStorages:
        description: >
          Information about virtualised storage instances that were affected
          during the lifecycle operation.
          Shall be present if the "notificationStatus" is set to "RESULT" and
          the operation has performed any resource modification. Shall be
          absent otherwise. This attribute contains information about the
          cumulative changes to virtualised resources that were performed so
          far by the VNF LCM operation occurrence and by any of the error
          handling procedures for that operation occurrence.
        type: array
        items:
          $ref: "#/definitions/AffectedVirtualStorage"
      changedInfo:
        description: >
          Information about the changed VNF instance information, including
          changed VNF configurable properties.
          Shall be present if the "notificationStatus" is set to "RESULT" and
          the operation has performed any changes to VNF instance information,
          including VNF configurable properties.
          Shall be absent otherwise.
        $ref: "#/definitions/VnfInfoModifications"
      changedExtConnectivity:
        description: >
          Information about changed external connectivity, if this
          notification represents the result of a lifecycle operation
          occurrence. Shall be present if the "notificationStatus" is set to
          "RESULT" and the "operation" is set to "CHANGE_EXT_CONN".
          Shall be absent otherwise.
        type: array
        items:
          $ref: "#/definitions/ExtVirtualLinkInfo"
      error:
        description: >
          Details of the latest error, if one has occurred during executing
          the LCM operation. Shall be present if the "operationState"
          attribute is "FAILED_TEMP" or "FAILED", and shall be absent
          otherwise.
        $ref: "SOL002SOL003_def.yaml#/definitions/ProblemDetails"
      _links:
        description: >
          Links to resources related to this notification.
        $ref: "#/definitions/LccnLinks"

  LccnSubscriptionRequest:
    description: >
      This type represents a subscription request related to notifications
      about VNF lifecycle changes.
    type: object
    required:
      - callbackUri
    properties:
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Uri"
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
          in clause 4.5.3.4.
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
        $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

  LcmOperationStateType:
    description: >
      Value | Description
      ------|------------
      STARTING | The LCM operation is starting.
      PROCESSING | The LCM operation is currently in execution.
      COMPLETED | he LCM operation has been completed successfully.
      FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed.
      FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed.
      ROLLING_BACK | The LCM operation is currently being rolled back.
      ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.
    type: string
    enum:
      - STARTING
      - PROCESSING
      - COMPLETED
      - FAILED_TEMP
      - FAILED
      - ROLLING_BACK
      - ROLLED_BACK

  LifecycleChangeNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications
      about VNF lifecycle changes.
      At a particular nesting level in the filter structure, the following
      applies: All attributes shall match in order for the filter to match
      (logical "and" between different filter attributes). If an attribute is
      an array, the attribute shall match if at least one of the values in
      the array matches (logical "or" between the values of one filter
      attribute).
    type: object
    properties:
      vnfInstanceSubscriptionFilter:
        description: >
          Filter criteria to select VNF instances about which to notify.
        $ref: "SOL002SOL003_def.yaml#/definitions/VnfInstanceSubscriptionFilter"
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          * VnfLcmOperationOccurrenceNotification
          * VnfIdentifierCreationNotification
          * VnfIdentifierDeletionNotification
          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:
            - VnfLcmOperationOccurrenceNotification
            - VnfIdentifierCreationNotification
            - VnfIdentifierDeletionNotification
      operationTypes:
        description: >
          Match particular VNF lifecycle operation types for the notification
          of type VnfLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes" attribute contains the
          value "VnfLcmOperationOccurrenceNotification", and shall be absent
          otherwise.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType"
      operationStates:
        description: >
          Match particular LCM operation state values as reported in
          notifications of type VnfLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes" attribute contains the
          value "VnfLcmOperationOccurrenceNotification", and shall be absent
          otherwise.
        type: array
        items:
          $ref: "#/definitions/LcmOperationStateType"

  MonitoringParameter:
    type: object
    required:
      - id
      - performanceMetric
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the
          VNFD.
        type: string
      performanceMetric:
        description: >
          Performance metric that is monitored. This attribute shall contain the
          related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
        type: string

  ScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      scaleLevel:
        description: >
          Indicates the scale level. The minimum value shall be 0 and the
          maximum value shall be <= maxScaleLevel as described in the VNFD.
        type: integer

  ScaleVnfRequest:
    type: object
    required:
      - type
      - aspectId
    properties:
      type:
        description: >
          Indicates the type of the scale operation requested.
          Permitted values:
          * SCALE_OUT: adding additional VNFC instances to the VNF to increase
            capacity
          * SCALE_IN: removing VNFC instances from the VNF in order to release
            unused capacity.
        type: string
        enum:
          - SCALE_OUT
          - SCALE_IN
      aspectId:
        description: >
          Identifier of the scaling aspect.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      numberOfSteps:
        description: >
          Number of scaling steps to be executed as part of this Scale VNF
          operation. It shall be a positive number and the default value
          shall be 1.
        type: integer
        default: 1
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the scaling
          process, specific to the VNF being scaled, as declared in the VNFD
          as part of "ScaleVnfOpConfig".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  ScaleVnfToLevelRequest:
    description: >
      This type represents request parameters for the "Scale VNF to Level"
      operation.
    type: object
    properties:
      instantiationLevelId:
        description: >
          Identifier of the target instantiation level of the current
          deployment flavour to which the VNF is requested to be scaled.
          Either the instantiationLevelId attribute or the scaleInfo attribute
          shall be included.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      scaleInfo:
        description: >
          For each scaling aspect of the current deployment flavour, indicates
          the target scale level to which the VNF is to be scaled.
          Either the instantiationLevelId attribute or the scaleInfo attribute
          shall be included.
        type: array
        items:
          $ref: "#/definitions/ScaleInfo"
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the scaling
          process, specific to the VNF being scaled, as declared in the
          VNFD as part of "ScaleVnfToLevelOpConfig".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  StopType:
    description: >
      * FORCEFUL: The VNFM will stop the VNF immediately after accepting the
        request.
      * GRACEFUL: The VNFM will first arrange to take the VNF out of service