SOL002SOL003VNFLifecycleManagement_def.yaml

    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"

  VnfExtCpInfo:
    description: >
      This type represents information about an external CP of a VNF.
      It shall comply with the provisions defined in table 5.5.3.25 1.
    type: object
    required:
      - id
      - cpdId
      - cpProtocolInfo
    properties:
      id:
        description: >
          Identifier of the external CP instance and the related information instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      cpdId:
        description: >
          Identifier of the external CPD, VnfExtCpd, in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      cpProtocolInfo:
        description: >
          Network protocol information for this CP.
        type: array
        items:
          $ref: "#/definitions/CpProtocolInfo"
      extLinkPortId:
        description: >
          Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure.
          Shall be present if the CP is associated to a link port.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      metadata:
        description: >
          Metadata about this external CP.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      associatedVnfcCpId:
        description: >
          Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure that represents
          the VNFC CP which is exposed by this external CP instance.
          Shall be present in case this CP instance maps to a VNFC CP. See note.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      associatedVnfVirtualLinkId:
        description: >
          Identifier of the "VnfVirtualLinkResourceInfo" structure that represents the internal VL
          which is exposed by this external CP instance.
          Shall be present in case this CP instance maps to an internal VL. See note.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"

  VnfOperationalStateType:
    description: >
      STARTED: The VNF instance is up and running.
      STOPPED: The VNF instance has been shut down.
    type: string
    enum:
      - STARTED
      - STOPPED

  LcmOperationStateType:
    description: >
      STARTING: The LCM operation is starting.
      PROCESSING: The LCM operation is currently in execution.
      COMPLETED: The 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

  CancelModeType:
    description: >
      Cancellation mode.
      GRACEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or
      "ROLLING_BACK" state, 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.
      If the VNF LCM operation occurrence is in "STARTING" state, the VNFM
      shall not start any resource management operation and shall wait for
      the granting request to finish execution or time out. After that, the
      VNFM shall put the operation occurrence into the ROLLED_BACK state.
      FORCEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or
      "ROLLING_BACK" state, 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.
      If the VNF LCM operation occurrence is in "STARTING" state, the VNFM
      shall not start any resource management operation and put the operation
      occurrence into the ROLLED_BACK state.
    type: string
    enum:
      - GRACEFUL
      - FORCEFUL

########################################################################################################################
  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 state of a VNF LCM operation occurrence that changes the VNF lifecycle,
      which represents an occurrence of one the following LCM operations:
      * 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.
      Clause 5.6.2 defines the states and state transition of a VNF LCM operation occurrence,
      and also specifies details of the notifications to be emitted at each state transition.
      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 (i.e. the "202 Accepted" response)
      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 "Individual VNF LCM operation occurrence" resource before
      the notification about the state change is sent.
      See clause 5.6.2.2 for further provisions regarding sending this notification, including
      in cases of handling LCM operation errors.
    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.
          Shall be set to the value of the "id" attribute of the "LccnSubscription" 
          representing the associated "Individual subscription" resource.
        $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.
          Shall be set to the value of the "id" attribute of the "VnfLcmOpOcc" 
          representing the associated "Individual VNF lifecycle management operation 
          occurrence" resource.
        $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.

          NOTE 1:	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.
          NOTE 2:	For a particular affected VL, there shall be as many "AffectedVirtualLink" 
          entries as needed for signalling the different types of changes, i.e., one per 
          virtual link and change type. For instance, in the case of signaling affected VL 
          instances involving the addition of a particular VL instance with links ports, 
          one "AffectedVirtualLink" entry signals the addition of the VL by using the 
          "changeType" attribute of "AffectedVirtualLink" structure equal to "ADDED", 
          and another "AffectedVirtualLink" entry signals the addition of externally visible 
          VNF link ports of the VL by using the "changeType" equal to "LINK_PORT_ADDED".
        type: array
        items:
          $ref: "#/definitions/AffectedVirtualLink"
      affectedExtLinkPorts:
        description: >
          Information about external VNF link ports that were affected during the 
          lifecycle operation. See note 1.

          NOTE 1:	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/AffectedExtLinkPort"
      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" has made any changes to the external connectivity of
          the VNF instance. Shall be absent otherwise.
          Only information about external VL instances that have been added or
          modified shall be provided.
        type: array
        items:
          $ref: "#/definitions/ExtVirtualLinkInfo"
      error:
        description: >
          Details of the latest error, if one has occurred during executing
          the LCM operation (see clause 6.3 of ETSI GS NFV-SOL 013).
          Shall be present if the "operationState" attribute is "FAILED_TEMP", "FAILED"
          or "ROLLED_BACK" and shall be absent otherwise.
        $ref: "SOL002SOL003_def.yaml#/definitions/ProblemDetails"
      _links:
        description: >
          Links to resources related to this notification.
          The link URIs in this structure shall be set to point to the resources identified 
          by the corresponding identifier attributes in this notification.
        $ref: "#/definitions/LccnLinks"

  VnfIdentifierCreationNotification:
    description: >
      This type represents a VNF identifier creation notification, which
      informs the receiver of the creation of a new "Individual VNF instance" resource and
      the associated VNF instance identifier.
      This notification shall be triggered by the VNFM when it has created an
      "Individual VNF instance" resource and the associated VNF instance identifier.
    type: object
    required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - vnfInstanceId
      - _links
    properties:
      id:
        description: >
          Identifier of the VNF instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      notificationType:
        description: >
          Discriminator for the different notification types. Shall be set to
          "VnfIdentifierCreationNotification" for this notification type.
        type: string
        enum:
          - VnfIdentifierCreationNotification
      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"
      vnfInstanceId:
        description: >
          The created VNF instance identifier.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      _links:
        description: >
          Links to resources related to this notification.
        $ref: "#/definitions/LccnLinks"

  VnfIdentifierDeletionNotification:
    description: >
      This type represents a VNF identifier deletion notification, which
      informs the receiver of the deletion of a new "Individual VNF instance" resource and
      the associated VNF instance identifier.
      This notification shall be triggered by the VNFM when it has deleted an
      "Individual VNF instance" resource and the associated VNF instance identifier.
    type: object
    required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - vnfInstanceId
      - _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
          "VnfIdentifierDeletionNotification" for this notification type.
        type: string
        enum:
          - VnfIdentifierDeletionNotification
      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"
      vnfInstanceId:
        description: >
          The deleted VNF instance identifier.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      _links:
        description: >
          Links to resources related to this notification.
        $ref: "#/definitions/LccnLinks"

  VnfcInfoModifications:
    description: >
      This type represents modifications of an entry in an array of "VnfcInfo" objects.
      It shall comply with the provisions defined in table 5.5.3.24-1.
    type: object
    required:
      - id
      - vnfcConfigurableProperties
    properties:
      id:
        description: >
          Identifier of the VNFC instance of which the information is to be modified.
          The identifier references the "id" attribute in a "VnfcInfo" structure.
          NOTE:	The attribute "id" in this data type represents the same identifier as
          the attribute "vnfcInstanceId" in other related data types in the present document.
          For reasons of backward compatibility, this misalignment is not corrected.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfcConfigurableProperties:
        description: >
          Changes of the configurable properties of the VNFC instance.
          When this structure is part of a request, the modifications signalled
          in this attribute shall be applied according to the rules of
          JSON Merge Patch (see IETF RFC 7396).
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
  VnfcInfo:
    description: >
      This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the
      provisions defined in table 5.5.3.23-1.
    type: object
    required:
      - id
      - vduId
      - vnfcResourceInfoId
      - vnfcState
    properties:
      id:
        description: >
          Identifier of the VNFC instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vduId:
        description: >
          Reference to the applicable VDU information element in
          the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfcResourceInfoId:
        description: >
          Identifier of the VnfcResourceInfo instance representing
          the virtualised resources used by this VNFC instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfcState:
        description: >
          Identifier of the VnfcResourceInfo instance representing
          the virtualised resources used by this VNFC instance.
          State of the VNFC instance.
          Permitted values:
          • STARTED: The VNFC instance is up and
          running.
          • STOPPED: The VNFC instance has been shut down
        type: string
        enum:
          - STARTED
          - STOPPED
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfcConfigurableProperties:
        description: >
          Current values of the configurable properties of the
          VNFC instance.
          Configurable properties referred in this attribute are
          declared in the VNFD.
          This attribute can be modified with the PATCH method
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"