SOL003VNFLifecycleManagement_def.yaml

                Indicator of the actual coordination action.
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
            coordinationResult:
              description: >
                The result of executing the coordination action which also implies the action to be performed by the VNFM as 
                the result of this coordination. 
                
                Shall be present if the coordination has been finished. Shall be absent if the coordination is ongoing or has 
                timed out (see note 4).
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/LcmCoordResultType"
            startTime:
              description: >
                The time when the VNFM has received the confirmation that the coordination action has been started.
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
            endTime:
              description: >
                The time when the VNFM has received the confirmation that the coordination action has finished or has been
                cancelled, or the time when a coordination action has timed out. Shall be present for a coordination
                action that has finished or timed out (see note 4) and shall be absent if the coordination is ongoing.
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
            delay:
              description: >
                The end of the delay period.
                This attribute shall be present if the last known HTTP response related to this coordination has
                contained a "Retry-After" header, and shall be absent otherwise.
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
            endpointType:
              description: >
                The endpoint type used by this coordination action.
                Valid values:
                •	MGMT: coordination with other operation supporting management systems (e.g. EM)
                •	VNF: coordination with the VNF instance
              type: string
              enum:
                - MGMT
                - VNF
      rejectedLcmCoordinations:
        description: >
          Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) that were rejected
          by 503 error which means they can be tried again after a delay. See note 5.
        type: array
        items:
          type: object
          required:
            - coordinationActionName
            - rejectionTime
            - endpointType
            - delay
          properties:
            coordinationActionName:
              description: >
                Indicator of the actual coordination action.
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
            rejectionTime:
              description: >
                The time when the VNFM has received the 503 response that rejects the actual coordination.
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
            delay:
              description: >
                The end of the delay period, as calculated from the startTime and "Retry-After" header.
              $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
            endpointType:
              description: >
                The endpoint type used by this coordination action.
                Valid values:
                •	MGMT: coordination with other operation supporting management systems (e.g. EM)
                •	VNF: coordination with the VNF instance
              type: string
              enum:
                - MGMT
                - VNF
      warnings:
        description: >
          Warning messages that were generated while the operation was executing.

          If the operation has included LCM coordination actions and these have resulted
          in warnings, such warnings should be added to this attribute.
        type: array
        items:
            type: string
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - vnfInstance
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
          vnfInstance:
            description: >
              Link to the VNF instance that the operation applies to.
            $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
          grant:
            description: >
              Link to the grant for this operation, if one exists.
            $ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
          vnfSnapshot:
            description: >
              Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot.
              Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT".
            $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"

  AffectedExtLinkPort:
    description: >
      This type provides information about added and deleted external link ports (link ports attached to external virtual links).

      NOTE:	The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in correlating 
            the resource changes performed during the LCM operation with the granted resources in a specific Grant exchange, which 
            is identified by the "grantId" available in the "Individual VNF lifecycle management operation occurrence" and the "id" 
            in the "Individual Grant".
    type: object
    required:
      - id
      - changeType
      - extCpInstanceId
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data
          type (see clause 5.5.3.2).
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          -	ADDED
          - MODIFIED
          -	REMOVED
        type: string
        enum:
          - ADDED
          - MODIFIED
          - REMOVED
      extCpInstanceId:
        description: >
          Identifier of the related external CP instance.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      resourceHandle:
        description: >
          Reference to the link port resource.
          Detailed information is (for added resources) or has been (for removed resources) available from the VIM.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. 
          It shall be present when an applicable GrantInfo for the granted resource exists. See note.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"

  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
      - Change of the current VNF package
      - 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
      - Creation of a VNF snapshot
      - Reversion of the VNF instance to a VNF snapshot
      
      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.
      The amount of information provided in the LCM operation occurrence notifications to be issued by the VNFM when 
      a particular subscription matches can be controlled by the API consumer using the "verbosity" attribute in the 
      subscription request (see clause 5.5.2.15). The "verbosity" setting in a particular individual subscription shall 
      only apply to the LCM operation occurrence notifications triggered by that subscription. However, it shall not 
      affect the amount of information in the "VnfLcmOpOcc" structure (see clause 5.5.2.13) which represents the "Individual 
      LCM operation occurrence" resource associated with each of the notifications.
      See clause 5.6.2.2 for further provisions regarding sending this notification, including in cases of handling LCM 
      operation errors.

      NOTE 1:	Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL" 
              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".
      Note 3: Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present.
    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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../General_Definitions/SOL003_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: "#/definitions/LcmOperationStateType"
      vnfInstanceId:
        description: >
          The identifier of the VNF instance affected.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      operation:
        description: >
          The lifecycle management operation.
        $ref: "../../General_Definitions/SOL003_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
      verbosity:
        description: >
          This attribute signals the verbosity of the notification. If it is not present, it shall default to the value "FULL".
          If the value is "SHORT", full change details can be obtained by performing a GET request on the "Individual LCM
          operation occurrence" resource that is signalled by the "vnfLcmOpOcc" child attribute of the "_links" attribute.
        $ref: '#/definitions/LcmOpOccNotificationVerbosityType'
      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 associate "Individual VNF lifecycle
          management operation occurrence" resource.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      affectedVnfcs:
        description: >
          Information about VNFC instances that were affected during the lifecycle operation. See note 1.
        type: array
        items:
          $ref: "#/definitions/AffectedVnfc"
      affectedVirtualLinks:
        description: >
          Information about VL instances that were affected during the lifecycle operation. See note 1 and note 2.
        type: array
        items:
          $ref: "#/definitions/AffectedVirtualLink"
      affectedExtLinkPorts:
        description: >
          Information about external VNF link ports that were affected during the lifecycle operation. See note 1.
        type: array
        items:
          $ref: "#/definitions/AffectedExtLinkPort"
      affectedVirtualStorages:
        description: >
          Information about virtualised storage instances that were affected during the lifecycle operation. See note 1.
        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",
          the "operation" attribute is not equal to "CHANGE_VNFPKG", the
          "verbosity" attribute is set to "FULL" and the operation has performed
          any changes to VNF instance information, including VNF configurable
          properties. Shall be absent otherwise. See note 3.
        $ref: "#/definitions/VnfInfoModifications"

      affectedVipCps:
        description: >
          Information about virtual IP CP instances that were affected during the execution of the lifecycle management
          operation, if this notification represents the result of a lifecycle management operation occurrence.

          Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
          and the operation has made any changes to the VIP CP instances of the VNF instance. Shall be absent otherwise.
          Only information about VIP CP instances that have been added, deleted or modified shall be provided.
        type: array
        items:
          $ref: "#/definitions/AffectedVipCp"
      
      affectedVirtualCps:
        description:
          Information about virtual CP instances that were affected during the execution of the lifecycle
          management operation, if this notification represents the result of a lifecycle management operation
          occurrence.
          Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
          and the operation has made any changes to the virtual CP instances of the VNF instance. Shall be absent
          otherwise. Only information about virtual CP instances that have been added, deleted or modified shall be
          provided.
        type: array
        items:
          $ref: "#/definitions/AffectedVirtualCp"
      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",
          the "verbosity" attribute is set to "FULL" 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"
      modificationsTriggeredByVnfPkgChange:
        description: >
          Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package.
          Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is equal to
          "CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to
          "VnfInstance" attributes.  Shall be absent otherwise. See note 3.
        $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
      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: "../../General_Definitions/SOL003_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"

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs, and added or removed VNF link ports.

      NOTE 1:	When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, 
              the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual link 
              instance, not the link port instance. The resource handles of the affected VNF link ports can be 
              found by dereferencing the identifiers in the "vnfLinkPortIds" attribute.
      NOTE 2:	The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to 
              assist in correlating the resource changes performed during the LCM operation with the granted 
              resources in a specific Grant exchange, which is identified by the "grantId" available in the 
              "Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant".
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
      - changeType
      - networkResource
    properties:
      id:
        description: >
          Identifier of the virtual link instance, identifying the applicable
          "vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" entry in the "VnfInstance" data type.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the related VLD in the VNFD.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is
          associated to a VLD which is referred from the source or destination VNFD.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      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. 
          See note 1.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
          - LINK_PORT_ADDED
          - LINK_PORT_REMOVED
      networkResource:
        description: >
          Reference to the VirtualNetwork resource or reference to a Network MCIO.
          Detailed information is (for new and modified resources) or has been (for removed resources) available from the VIM or the CISM.
          See note 1.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
      vnfLinkPortIds:
        description: >
          Identifiers of the link ports of the affected VL related to the change. Each identifier references a "VnfLinkPortInfo" 
          structure.
          
          Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", and the related "VnfLinkPortInfo" 
          structures are present (case "added") or have been present (case "removed") in the "VnfVirtualLinkResourceInfo" or 
          "ExtManagedVirtualLinkInfo" structures that are represented by the "vnfVirtualLinkResource¬Info" or "extManagedVirtualLinkInfo" 
          attribute in the "VnfInstance" structure. See note 1.
        type: array
        items:
          $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. 
          It shall be present when an applicable GrantInfo for the granted resource exists. See note 1 and note 2.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced VirtualNetwork
          resource is placed. Shall be provided if this information is available from the VIM.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      metadata:
        description: >
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the applicable "vnfVirtualLinkResourceInfo”
          structure if such structure is referenced by the "id" attribute and it has metadata.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"

  AffectedVirtualStorage:
    description: >
      This type provides information about added, deleted, modified and temporary virtual storage resources.

      NOTE:	The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to 
            assist in correlating the resource changes performed during the LCM operation with the granted 
            resources in a specific Grant exchange, which is identified by the "grantId" available in the 
            "Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant".
    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: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      virtualStorageDescId:
        description: >
          Identifier of the related VirtualStorage descriptor in the VNFD.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage
          instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      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 or reference to a Storage MCIO.
          Detailed information is (for new and modified resources) or has been (for removed
          resources) available from the VIM or the CISM.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. 
          It shall be present when an applicable GrantInfo for the granted resource exists. See note.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced VirtualNetwork
          resource is placed. Shall be provided if this information is available from the VIM.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      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: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"

  IntVnfCpData:
    description: >
      This type represents input information related to one or more VNF internal CP instances
      created based on the same CPD.

      NOTE: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment
            definition resource is needed to fulfil the connectivity requirements of the VNF internal CP, e.g. to build a link
            redundant mated pair in SR-IOV cases. When more than one netAttDefResourceId is indicated, all shall
            belong to the same namespace as defined by the corresponding "containerNamespace" attribute in the "resourceHandle" attribute
            in the "NetAttDefResourceData".
    type: object
    required:
    - cpdId
    - netAttDefResourceId
    properties:
      cpdId:
        description: >
          Identifier of the CPD in the VNFD.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      netAttDefResourceId:
        description: >
          Identifiers of the “NetAttDefResourceData” structure that
          provides the specification of the interface to attach the VNF
          internal CP created from the CPD identified by cpdId to a
          secondary container cluster network. See note.
        type: array
        items:
          $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"

  CreateVnfRequest:
    description: >
      This type represents request parameters for the "Create VNF identifier" operation.
    type: object
    required:
      - vnfdId
    properties:
      vnfdId:
        description: >
          Identifier that identifies the VNFD which defines the VNF instance to
          be created.
        $ref: "../../General_Definitions/SOL003_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 additional initial values, overriding those obtained from the VNFD, for
          the "metadata" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling metadata
          during the operation are defined in clause 5.4.2.3.1.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"

  ScaleVnfRequest:
    description: >
      This type represents request parameters for the "Scale VNF" operation.
    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: "../../General_Definitions/SOL003_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" defined in ETSI GS NFV-IFA 011 [10].
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"

  ScaleVnfToLevelRequest:
    description: >
      This type represents request parameters for the "Scale VNF to Level" operation.

      NOTE:	Either the instantiationLevelId attribute or the scaleInfo attribute shall 
            be included.
    type: object
    anyOf:
      - oneOf:
          - required:
              - instantiationLevelId
          - required:
              - scaleInfo
    properties:
      instantiationLevelId:
        description: >
          Identifier of the target instantiation level of the current
          deployment flavour to which the VNF is requested to be scaled.
          See note.
        $ref: "../../General_Definitions/SOL003_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.
          See note.
        type: array
        items:
          $ref: "../../General_Definitions/SOL003_def.yaml#/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" defined in ETSI GS NFV-IFA 011 [10].
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"

  CancelMode:
    description: >
      This type represents a parameter to select the mode of cancelling an
      ongoing VNF LCM operation occurrence.
    type: object
    required:
      - cancelMode
    properties:
      cancelMode:
        description: >
          Cancellation mode to apply.
        $ref: "#/definitions/CancelModeType"

  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: "../../General_Definitions/SOL003_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 8.3.4 of ETSI GS NFV-SOL 013.
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/SubscriptionAuthentication"
      verbosity:
        description: >
          This attribute signals the requested verbosity of LCM operation occurrence notifications. If it is not present,
          it shall default to the value "FULL".
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"

  LccnSubscription:
    description: >
      This type represents a subscription related to notifications about VNF
      lifecycle changes.
    type: object
    required:
      - id
      - callbackUri
      - verbosity
      - _links
    properties:
      id:
        description: >
          Identifier of this subscription resource.
        $ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Uri"
      verbosity:
        description: >
          This attribute signals the verbosity of LCM operation occurrence notifications.
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
  
  ExtVirtualLinkInfo:
    description: >
      This type represents information about an external VL.

      NOTE:	This attribute reflects the current configuration information that has resulted from merging into this attribute 
            the "VnfExtCpData" information which was passed as part of the "ExtVirtualLinkData" structure in the input of the 
            most recent VNF LCM operation such as "InstantiateVnfRequest", "ChangeExtVnfConnectivityRequest", "ChangeVnfFlavourRequest" 
            or "ChangeCurrentVnfPkgRequest", or in the Grant response. If applying such change results in an empty list of 
            "currentVnfExtCpData" structure instances, the affected instance of "ExtVirtualLinkInfo" shall be removed from its 
            parent data structure.
    type: object
    required:
      - id
      - resourceHandle
      - currentVnfExtCpData
    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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"
      currentVnfExtCpData:
        description: >
          Allows the API consumer to read the current CP configuration information for the connection of external CPs 
          to the external virtual link. See note.
        type: array
        items:
          $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VnfExtCpData"
      extNetAttDefResource:
        description: >
          Network attachment definition resources that provide the specification of the interface to attach connection points 
          to this VL.
        type: array
        items:
          $ref: "#/definitions/NetAttDefResourceInfo"

  VnfLinkPortInfo:
    description: >
      This type represents a link port of an internal VL of a VNF.

      NOTE 1: Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId
              with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be 
              present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP" 
              and vipCpInstanceId are present, the two different CP instances share the linkport.
      NOTE 2: Annex A.4 of ETSI GS NFV-IFA 007 provides examples for configurations where both vipCpInstanceId
              and vnfcCpInstanceId are present (UC#5 and UC#5-b), only vnfcCpInstanceId is present (UC#2), or 
              only vipCpInstanceId is present (UC6 and UC#6-b).
      NOTE 3: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle"
              attribute.
    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: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link
          port.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
        description: >
          When the link port is used for external connectivity by the VNF, this attribute represents the 
          identifier of the external CP associated with this link port.
          
          When the link port is used for internal connectivity in the VNF, this attribute represents the 
          identifier of the VNFC CP to be connected to this link port.
          
          Shall be present when the link port is used for external connectivity by the VNF.
          May be present if used to reference a VNFC CP instance.
          There shall be at most one link port associated with any external connection point instance or 
          internal connection point (i.e. VNFC CP) instance.
          The value refers to an "extCpInfo" item in the VnfInstance or a "vnfcCpInfo" item of a "vnfcResourceInfo" 
          item in the VnfInstance. See note 1.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      cpInstanceType:
        description: >
          Type of the CP instance that is identified by cpInstanceId. 
          Shall be present if "cpInstanceId" is present and shall be absent otherwise.
          
          Permitted values:
          - VNFC_CP: The link port is connected to a VNFC CP.
          -	EXT_CP: The link port is associated to an external CP.
          See note 1.
        type: string
        enum:
          - VNFC_CP
          - EXT_CP
      vipCpInstanceId:
        description: >
          VIP CP instance of the VNF connected to this link port. May be present. 
          See notes 1, and 2.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      trunkResourceId:
        description: >
          Identifier of the trunk resource in the VIM.
          Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with. 
          See note 3.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVim"

  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.

      NOTE 1:	The use cases UC#4 and UC#5 in clause A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration.
      NOTE 2:	The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute.
    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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link
          port.
        $ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      secondaryCpInstanceId:
        description: >
          Additional external CP of the VNF connected to this link port.
          If present, this attribute shall refer to a "secondary" ExtCpInfo item in the VNF instance that exposes a virtual 
          IP CP instance which shares this linkport with the external CP instance referenced by the "cpInstanceId" attribute. 
          See note 1.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      trunkResourceId:
        description: >
          Identifier of the trunk resource in the VIM.
          Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with. 
          See note 2.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVim"

  CpProtocolInfo:
    description: >
      This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.

      NOTE:	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: object
    required:
      - layerProtocol
    properties:
      layerProtocol:
        description: >
          The identifier of layer(s) and protocol(s) associated to the network address information.
          
          Permitted values:
            - IP_OVER_ETHERNET
            - IP_FOR_VIRTUAL_CP
          See note.
        type: string
        enum:
          - IP_OVER_ETHERNET
          - IP_FOR_VIRTUAL_CP
      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"
      virtualCpAddress:
        description: >
          IP address data assigned to an external CP instance exposing a virtual CP. It shall be present if
          layerProtocol is equal to “IP_FOR_VIRTUAL_CP” and the external CP instance exposes a virtual CP and
          shall not be present otherwise.  
        $ref: "#/definitions/VirtualCpAddressInfo"

  IpOverEthernetAddressInfo:
    description: >
      This type represents information about a network address that has been assigned.

      NOTE 1:	At least one of "macAddress" or "ipAddresses" shall be present.
      NOTE 2:	Exactly one of "addresses" or "addressRange" shall be present.
      NOTE 3:	If the Cp instance represents a subport in a trunk, segmentationId shall be present. 
              Otherwise it shall not be present.
      NOTE 4:	Depending on the NFVI networking infrastructure, the segmentationId may indicate the 
              actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the 
              transport header of the packets or it may be an identifier used between the application 
              and the NFVI networking infrastructure to identify the network sub-interface of the trunk 
              port in question. In the latter case the NFVI infrastructure will map this local segmentationId 
              to whatever segmentationId is actually used by the NFVI’s transport technology.
    type: object
    anyOf:
      - required:
          - macAddress
      - required:
          - ipAddresses
    oneOf: