SOL002SOL003VNFLifecycleManagement_def.yaml

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

definitions:
  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 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: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  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
    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.
          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"

  VnfInfoModificationRequest:
    description: >
      This type represents attribute modifications for an "Individual VNF instance" resource,
      i.e. modifications to a resource representation based on the "VnfInstance" data type.
      The attributes of "VnfInstance" that can be modified according to the provisions in clause 5.5.2.2
      are included in the "VnfInfoModificationRequest" data type.
      The "VnfInfoModificationRequest" data type shall comply with the provisions defined in table 5.5.2.12-1.
    type: object
    properties:
      vnfInstanceName:
        description: >
          New value of the "vnfInstanceName" attribute in "VnfInstance", or "null" to remove the attribute.
        type: string
      vnfInstanceDescription:
        description: >
          New value of the "vnfInstanceDescription" attribute in "VnfInstance", or "null" to remove the attribute.
        type: string
      vnfdId:
        description: >
          New value of the "vnfdId" attribute in "VnfInstance". The value "null" is not permitted.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfConfigurableProperties:
        description: >
          Modifications of the "vnfConfigurableProperties" attribute in "VnfInstance".
          If present, these modifications shall be applied according to the rules of
          JSON Merge PATCH (see IETF RFC 7396 [15]).
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          Modifications of the "metadattametadata" attribute in "VnfInstance".
          If present, these modifications shall be applied according to the rules of
          JSON Merge PATCH (see IETF  RFC  7396  [15]).
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          Modifications of the "extensions" attribute in "VnfInstance".
          If present, these modifications shall be applied according to the rules of
          JSON Merge PATCH (see IETF  RFC  7396  [15]).
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfcInfoModifications:
        description: >
          Modifications of certain entries in the "vnfcInfo" attribute array in the
          "instantiatedVnfInfo" attribute of "VnfInstance"." to be used as "newList" as defined below this table.
        type: array
        items:
          $ref: "#/definitions/VnfcInfoModifications"
      vnfcInfoModificationsDeleteIds:
        description: >
          List of identifiers entries to be deleted from the 'vnfcInfoModifications" attribute array
          to be used as "deleteIdList" as defined below this table.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"

  VnfInfoModifications:
    description: >
      This type represents attribute modifications that were performed on an
      "Individual VNF instance" resource. The attributes that can be included
      consist of those requested to be modified explicitly in the
      "VnfInfoModificationRequest" data structure, and additional attributes
      of the "VnfInstance" data structure that were modified implicitly e.g.
      when modifying the referenced VNF package.
    type: object
    properties:
      vnfInstanceName:
        description: >
          If present, this attribute signals modifications of the
          "vnfInstanceName" attribute in "VnfInstance".
        type: string
      vnfInstanceDescription:
        description: >
          If present, this attribute signals modifications of the
          "vnfInstanceDescription" attribute in "VnfInstance".
        type: string
      vnfConfigurableProperties:
        description: >
          If present, this attribute signals modifications of the
          "vnfConfigurableProperties" attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          If present, this attribute signals modifications of the "metadata"
          attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          If present, this attribute signals modifications of the "extensions"
          attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfdId:
        description: >
          If present, this attribute signals modifications of the "vnfdId"
          attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfProvider:
        description: >
          If present, this attribute signals modifications of the
          "vnfProvider" attribute in "VnfInstance".
          If present, this attribute (which depends on the value of the
          "vnfPkgId" attribute) was modified implicitly following a request to
          modify the "vnfPkgId" attribute, by copying the value of this
          attribute from the VNFD in the VNF Package identified by the
          "vnfPkgId” attribute.
        type: string
      vnfProductName:
        description: >
          If present, this attribute signals modifications of the
          "vnfProductName" attribute in "VnfInstance".
          If present, this attribute (which depends on the value of the
          "vnfPkgId" attribute) was modified implicitly following a request to
          modify the "vnfPkgId" attribute, by copying the value of this
          attribute from the VNFD in the VNF Package identified by the
          "vnfPkgId” attribute.
        type: string
      vnfSoftwareVersion:
        description: >
          If present, this attribute signals modifications of the
          "vnfSoftwareVersion" attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/Version"
      vnfdVersion:
        description: >
          If present, this attribute signals modifications of the
          "vnfdVersion" attribute in "VnfInstance".
          If present, this attribute (which depends on the value of the
          "vnfdId" attribute) was modified implicitly following a request to
          modify the "vnfdId" attribute, by copying the value of this
          attribute from the VNFD in the VNF Package identified by the
          "vnfdId” attribute.
        $ref: "SOL002SOL003_def.yaml#/definitions/Version"
      vnfcInfoModifications:
        description: >
          If present, this attribute signals modifications of certain
          entries in the "vnfcInfo" attribute array in the
          "instantiatedVnfInfo" attribute of "VnfInstance", as defined
          in clause 5.5.2.12
        type: array
        items:
          $ref: "#/definitions/VnfcInfoModifications"

  VnfLcmOpOcc:
    description: >
      This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the "id"
      attribute in the "Grant" representing the associated "Individual Grant", if such grant exists.
    type: object
    oneOf:
      - required:
        - changedInfo
      - required:
        - modificationsTriggeredByVnfPkgChange
    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 has been 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. Shall be set to the value of the "id" attribute 
          in the "Grant" representing the associated "Individual Grant", 
          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
          * CREATE_SNAPSHOT: CreateVnfSnapshotRequest
          * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest
          * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest
        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 API consumer 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 API consumer 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.
              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 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. This allows
              the API consumer 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/AffectedExtLinkPort"
          affectedVirtualStorages:
            description: >
              Information about virtualised storage instances that were affected
              during the lifecycle operation.
              This allows the API consumer 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"
      modificationsTriggeredByVnfPkgChange:
        description: >
          Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package,
          if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
          This allows the API consumer 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.
          Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present.
        $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
      vnfSnapshotInfoId:
        description: >
          Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation,
          i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT".
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      _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"
          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: "SOL002SOL003_def.yaml#/definitions/Link"

  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: "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 8.3.4 of ETSI GS NFV-SOL 013.
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
        $ref: "SOL002SOL003_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: "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"
      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: "SOL002SOL003_def.yaml#/definitions/Link"
  
  ExtVirtualLinkInfo:
    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: "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"
      currentVnfExtCpData:
        description: >
          Allows the API consumer to read the current CP configuration information for the connection of external CPs
          to the external virtual link.
          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 has been provided by the NFVO during the granting
          procedure. 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: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/VnfExtCpData"

  ExtManagedVirtualLinkInfo:
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
      - networkResource
    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"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      networkResource:
        description: >
          Reference to the VirtualNetwork resource providing this VL.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
      extManagedMultisiteVirtualLinkId:
        description: >
          Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO entity 
          that manages the externally managed multi-site VL instance. It shall be present when the externally-managed 
          internal VL is part of a multi-site VL, e.g., in support of multi-site VNF spanning several VIMs. 
          All externally-managed internal VL instances corresponding to an internal VL created based on the same 
          virtualLinkDescId shall refer to the same extManagedMultisiteVirtualLinkId.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"

  ScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      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

  VnfcResourceInfo:
    description: >
      This type represents the information on virtualised compute and storage
      resources used by a VNFC in a VNF instance.
    type: object
    required:
      - id
      - vduId
      - computeResource
    properties:
      id:
        description: >
          Identifier of this VnfcResourceInfo instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the
          resource management layer (typically, the VIM), where
          the referenced VirtualCompute resource is placed.
          Shall be provided if this information is available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      storageResourceIds:
        description: >
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfcCpInfo:
        description: >
          All the CPs of the VNFC instance.
          Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance 
          or is connected to an external CP of the VNF instance.  
          A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. 
          A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL.
          May be present otherwise.
        type: array
        items:
          type: object
          required:
            - id
            - cpdId
          properties:
            id:
              description: >
                Identifier of this VNFC CP instance and the associated array
                entry.
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
            vnfExtCpId:
              description: >
                Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of
                the VNF instance or connected to an external CP of the VNF instance (see note) and shall be absent otherwise.

                NOTE: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes 
                an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL.
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            cpProtocolInfo:
              description: >
                Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP.
                The information can be omitted because it is already available as part of the external CP information.
              type: array
              items:
                $ref: "#/definitions/CpProtocolInfo"
            vnfLinkPortId:
              description: >
                Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if
                the CP is associated to a link port on an internal VL of the VNF instance and shall be absent otherwise.
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            metadata:
              description: >
                Metadata about this CP.
              $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  VnfVirtualLinkResourceInfo:
    description: >
      This type represents the information that allows addressing a virtualised
      resource that is used by an internal VL instance in a VNF instance.
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
      - networkResource
    properties:
      id:
        description: >
          Identifier of this VnfVirtualLinkResourceInfo instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      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: "SOL002SOL003_def.yaml#/definitions/Identifier"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfLinkPorts:
        description: >
          Links ports of this VL.
          Shall be present when the linkPort is used for external connectivity
          by the VNF (refer to VnfLinkPortInfo).
          May be present otherwise.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  VirtualStorageResourceInfo:
    description: >
      This type represents the information that allows addressing a virtualised
      resource that is used by a VNF instance.
    type: object
    required:
      - id
      - virtualStorageDescId
      - storageResource
    properties:
      id:
        description: >
          Identifier of this VirtualStorageResourceInfo instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      virtualStorageDescId:
        description: >
          Identifier of the VirtualStorageDesc in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      storageResource:
        description: >
          Reference to the VirtualStorage resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced
          VirtualStorage resource is placed. Shall be provided if this
          information is available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  VnfLinkPortInfo:
    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/IdentifierInVnf"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link
          port.
        $ref: "SOL002SOL003_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 of the
          VNF to be connected to 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.
        $ref: "SOL002SOL003_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.
        type: string
        enum:
          - VNFC_CP
          - EXT_CP

  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"

  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"

  IpOverEthernetAddressInfo:
    description: >
      This type represents information about a network address that has been
      assigned.
    type: object
    anyOf:
      - required:
          - macAddress
      - required:
          - ipAddresses
    oneOf:
      - required:
          - addresses
      - required:
          - addressRange
    properties:
      macAddress:
        description: >
          MAC address, if assigned.
          At least one of "macAddress" or "ipAddresses" shall be present.
        $ref: "SOL002SOL003_def.yaml#/definitions/MacAddress"
      segmentationId:
        description: >
          Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a
          subport in a trunk, segmentationId shall be present.  Otherwise it shall not be present.
          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: string
      ipAddresses:
        description: >
          Addresses assigned to the CP instance. Each entry represents IP
          addresses assigned by fixed or dynamic IP address assignment per
          subnet.
          At least one of "macAddress" or "ipAddresses" shall be present.
        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/IdentifierInVim"

  MonitoringParameter:
    type: object
    required:
      - id
      - performanceMetric
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      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

  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"

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs, and added or removed VNF link ports.
    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"
      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: "SOL002SOL003_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.
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers 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.
        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.
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers 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.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      vnfLinkPortIds:
        description: >
          Identifiers of the link ports of the affected VL (reference to the vnfLinkPortInfo) 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
          "vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" attribute in the "VnfInstance" structure.
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers 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.
        type: array
        items:
          $ref: "SOL002SOL003_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.
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers 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.
          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".
        $ref: "SOL002SOL003_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: "SOL002SOL003_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 VnfVirtualLinkResourceInfo structure.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  AffectedExtLinkPort:
    description: >
      This type provides information about added and deleted external link ports (link ports attached to external virtual links).
    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: "SOL002SOL003_def.yaml#/definitions/Identifier"
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          -	ADDED
          -	REMOVED
        type: string
        enum:
          - ADDED
          - REMOVED
      extCpInstanceId:
        description: >
          Identifier of the related external CP instance.
        $ref: "SOL002SOL003_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: "SOL002SOL003_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.
          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".
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierLocal"

  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"
      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: "SOL002SOL003_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. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
        $ref: "SOL002SOL003_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.
          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".
        $ref: "SOL002SOL003_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: "SOL002SOL003_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: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  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"

  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
      - cpConfigId
      - cpProtocolInfo
    oneOf:
      - required:
          - associatedVnfcCpId
      - required:
          - associatedVnfVirtualLinkId
    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"
      cpConfigId:
        description: >
          Identifier that references the applied "VnfExtCpConfig" entry in the "cpConfig" map of the "currentVnfExtCpData"
          in the "ExtVirtualLinkInfo" structure.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      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"

  VnfcSnapshotInfo:
    description: >
      This type represents a VNFC snapshot.
    type: object
    required:
      - id
      - vnfcInstanceId
      - triggeredAt
      - vnfcResourceId
    properties:
      id:
        description: >
          Identifier of the information held by the VNFM about a specific VNFC snapshot. This identifier is allocated by
          the VNFM and is unique within the scope of a VNF snapshot.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal"
      vnfcInstanceId:
        description: >
          Identifier of the snapshotted VNFC instance.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      creationStartedAt:
        description: >
          Timestamp indicating when the VNF snapshot creation has been started by the VNFM.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      creationFinishedAt:
        description: >
          Timestamp indicating when the VNFC snapshot has been completed. Shall be present once the VNFC snapshot
          creation has been completed by the VNFM.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      vnfcResourceInfoId:
        description: >
          Reference to the "VnfcResourceInfo" structure in the "VnfInstance" structure that represents the resource 
          of the snapshotted VNFC instance. A snapshot of that structure is available in the "vnfInstance" attribute 
          of the "VnfSnapshot" structure.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      computeSnapshotResource:
        description: >
          Reference to a compute snapshot resource. 
          The identifier of the compute snapshot resource is assigned during creation of a VNFC snapshot
          being returned from the VIM as output data in the response message of the individual resource operations. 
          This attribute shall only be present for a VNFC snapshot that has been newly created by the VNFM as a result o
          f the "Create VNF snapshot task".
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      storageSnapshotResources:
        description: >
          Mapping of the storage resources associated to the VNFC with the storage snapshot resources.
        type: array
        items:
          type: object
          required: 
          - storageResourceId
          properties:
            storageResourceId:
              description: >
                Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure 
                that represents the virtual storage resource.
              $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            storageSnapshotResource:
              description: >
                Reference to a storage snapshot resource.
                The identifier of the storage snapshot resource is assigned during creation of a VNFC 
                snapshot being returned from the VIM as output data in the response message of the 
                individual resource operations. This attribute shall only be present for a VNFC snapshot 
                with an associated storage resource and that has been newly created by the VNFM as a 
                result of the "Create VNF snapshot task".
              $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      userDefinedData:
        description: >
          User defined data for the VNFC snapshot.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  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, includingwhich 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
      * 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.
      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
      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: "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", 
          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.
        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.
          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 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. 
          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.
        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",
          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.
        $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",
          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 VNF
          instance information, including VNF configurable properties. Shall be absent otherwise.
        $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: "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"

  VnfSnapshotInfo:
    description: >
      This type represents an "Individual VNF snapshot" resource. 
      It shall comply with the provisions defined in table 5.5.2.22-1.
    type: object
    required:
    - id    
    - _links
    properties:
      id:
        description: >
          Identifier of the "Individual VNF snapshot" resource. This identifier is allocated by the VNFM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfSnapshotPkgId:
        description: >
          Identifier of the VNF snapshot package information held by the NFVO. Shall be present when the 
          “Individual VNF snapshot" resource is created from a VNF snapshot package extraction.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfSnapshot:
        description: >
          Information about the VNF snapshot, content and/or references to its content. Shall be present 
          when the "Individual VNF snapshot" resource is associated to a VNF snapshot created via the 
          corresponding "Create VNF Snapshot" task resource or extracted from a VNF snapshot package.
        $ref: "#/definitions/VnfSnapshot"
      _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"
          takenFrom:
            description: >
              Link to the VNF instance from which this snapshot was taken. Shall be present when the 
              "Individual VNF snapshot" resource is associated to a VNF snapshot created via the 
              corresponding "Create VNF snapshot" task resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"

  VnfSnapshot:
    description: >
      This type represents a VNF snapshot. 
      It shall comply with the provisions defined in table 5.5.2.23-1.
    type: object
    required:
      - id
      - vnfInstanceId
      - triggeredAt
      - vnfdId
      - vnfInfo
      - vnfcSnapshots
    properties:
      id:
        description: >
          Identifier of the VNF Snapshot. This identifier is allocated by the VNFM.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfInstanceId:
        description: >
          Identifier of the snapshotted VNF instance.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      creationStartedAt:
        description: >
          Timestamp indicating when the VNF snapshot creation has been started by the VNFM.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      creationFinishedAt:
        description: >
          Timestamp indicating when the VNF snapshot has been completed by the VNFM.
          Shall be present once the VNF snapshot creation has been completed.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      vnfdId:
        description: >
          Identifier of the VNFD in use at the time the snapshot of the VNF instance has been created.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfInstance:
        description: >
          VNF Instance information of the snapshotted VNF instance. This is a copy of the "ndividual VNF instance" resource.
        $ref: '#/definitions/VnfInstance'
      vnfcSnapshots:
        description: >
          Information about VNFC snapshots constituting this VNF snapshot.
        type: array
        items:
          $ref: '#/definitions/VnfcSnapshotInfo'
      vnfStateSnapshotInfo:
        description: >
          Information about VNF-specific state snapshot data.
          This attribute shall not be present before the VNF snapshot has been completed. 
          Otherwise, this attribute shall be present if the VNF snapshot has associated
          additional VNF-specific state data.
        $ref: '#/definitions/VnfStateSnapshotInfo'
      userDefinedData:
        description: >
          User defined data for the VNF snapshot.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          vnfStateSnapshot:
            description: >
              Link to the "VNF state snapshot" resource. This attribute shall not be 
              present before the VNF snapshot has been completed. Otherwise, this 
              attribute shall be present if the VNF snapshot has associated additional 
              VNFspecific state data.
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  VnfInstance:
    description: >
      This type represents a VNF instance.
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfInstanceName:
        description: >
          Name of the VNF instance.
          This attribute can be modified with the PATCH method.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance.
          This attribute can be modified with the PATCH method.
        type: string
      vnfdId:
        description: >
          Identifier of the VNFD on which the VNF instance is based.

          Modifying the value of this attribute shall not be performed when conflicts
          exist between the previous and the newly referred VNF package,
          i.e. when the new VNFD is not changed with respect to the previous VNFD
          in other aspects than merely referencing to other VNF software images.
          In order to avoid misalignment of the VnfInstance with the current VNF's
          on-boarded VNF Package, the values of attributes in the VnfInstance that
          have corresponding attributes in the VNFD shall be kept in sync with the values in the VNFD.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfProvider:
        description: >
          Provider of the VNF and the VNFD. The value is copied from the VNFD.
        type: string
      vnfProductName:
        description: >
          Name to identify the VNF Product. The value is copied from the VNFD.
        type: string
      vnfSoftwareVersion:
        description: >
          Software version of the VNF. The value is copied from the VNFD.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Version"
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Version"
      vnfConfigurableProperties:
        description: >
          Current values of the configurable properties of the VNF instance.
          Configurable properties referred in this attribute are declared in
          the VNFD.
          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
          based on TOSCA specifications.
          VNF configurable properties are sometimes also referred to as
          configuration parameters applicable to a VNF. Some of these are set
          prior to instantiation and cannot be modified if the VNF is
          instantiated, some are set prior to instantiation (are part of
          initial configuration) and can be modified later, and others can be
          set only after instantiation. The applicability of certain
          configuration may depend on the VNF and the required operation of
          the VNF at a certain point in time.
          These configurable properties include the following standard
          attributes, which are declared in the VNFD if auto-scaling and/or
          auto-healing are supported by the VNF:
          * isAutoscaleEnabled: If present, the VNF supports auto-scaling. If
            set to true, auto-scaling is currently enabled. If set to false,
            auto-scaling is currently disabled.
          * isAutohealEnabled: If present, the VNF supports auto-healing. If
            set to true, auto-healing is currently enabled. If set to false,
            auto-healing is currently disabled.
          These configurable properties can be initialized with default values
          from the VNFD.
          Configurable properties can be modified with values passed in the request
          structures of certain LCM operations, such as the InstantiateVnfRequest 
          structure.
          Further, these configurable properties can be created, modified or
          deleted with the PATCH method.

          NOTE: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes 
          of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined
          initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata", 
          obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata" 
          and "extensions" that have no defineddeclared initial value shall not be created, in order to be consistent 
          with the semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion 
          request.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vimConnectionInfo:
        description: >
          Information about VIM connections to be used for managing the
          resources for the VNF instance. The keys of the map, each of 
          which identifies information about a particular VIM connection, 
          are managed by the NFVO and referenced from other data structures 
          via the "vimConnectionId" attribute. This attribute shall only 
          be supported and present if VNF-related resource management in 
          direct mode is pplicable.
          This attribute can be modified with the PATCH method.
        type: object
        additionalProperties:
          $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
      instantiationState:
        description: >
          The instantiation state of the VNF.
        type: string
        enum:
          - NOT_INSTANTIATED
          - INSTANTIATED
      instantiatedVnfInfo:
        description: >
          Information specific to an instantiated VNF instance. This attribute
          shall be present if the instantiateState attribute value is
          INSTANTIATED.
        type: object
        required:
          - flavourId
          - vnfState
        properties:
          flavourId:
            description: >
              Identifier of the VNF deployment flavour applied to this VNF instance.
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
          vnfState:
            description: >
              The state of the VNF instance.
            $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType"
          scaleStatus:
            description: >
              Scale status of the VNF, one entry per aspect.
              Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
              This attribute shall be present if the VNF supports scaling.
              See clause B.2 for an explanation of VNF scaling.
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo"
          maxScaleLevels:
            description: >
              Maximum allowed scale levels of the VNF, one entry per aspect.
              This attribute shall be present if the VNF supports scaling.
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo"
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance. When trunking is enabled, 
              the list of entries includes both, external CPs corresponding to parent ports of a trunk, 
              and external CPs associated to sub-ports of a trunk.
            type: array
            minItems: 1
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo"
          extVirtualLinkInfo:
            description: >
              Information about the external VLs the VNF instance is connected to.
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
          extManagedVirtualLinkInfo:
            description: >
              Information about the externally-managed internal VLs of the VNF instance.

              NOTE: It is possible to have several ExtManagedVirtualLinkInfo for the same 
              VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of 
              ExtManagedVirtualLinkInfo corresponding to the same VNF internal VL shall indicate 
              so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site 
              VL instance (refer to clause 5.5.3.3).
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkInfo"
          monitoringParameters:
            description: >
              Active monitoring parameters.
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/MonitoringParameter"
          localizationLanguage:
            description: >
              Information about localization language of the VNF (includes e.g.
              strings in the VNFD). The localization languages supported by a VNF
              can be declared in the VNFD, and localization language selection can
              take place at instantiation time.
              The value shall comply with the format defined in IETF RFC 5646.
            type: string
          vnfcResourceInfo:
            description: >
              Information about the virtualised compute and storage resources used
              by the VNFCs of the VNF instance.
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcResourceInfo"
          virtualLinkResourceInfo:
            description: >
              Information about the virtualised network resources used by the VLs
              of the VNF instance.
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfVirtualLinkResourceInfo"
          virtualStorageResourceInfo:
            description: >
              Information on the virtualised storage resource(s) used as storage for the VNF instance.
            type: array
            items:
              $ref: "../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualStorageResourceInfo"
      metadata:
        description: >
          Additional VNF-specific attributes that provide metadata describing the VNF instance.
          These attributes represent values that are stored persistently in the VnfInstance structure
          for consumption by functional blocks that invoke the VNF lifecycle management interface.
          They are not consumed by the VNFM, or the lifecycle management scripts.
          Modifying the values of these attributes has no effect on the VNF instance, it only affects
          the information represented in the VnfInstance structure.
          Metadata that are writeable are the VNF provider foresees are expected to be declared in the VNFD.
          The declaration of metadata in the VNFD can optionally contain the specification of initial values.
          The VNFM shall accept requests to write metadata that are not declared in the VNFD.
          These attributes can be initialized with default values from the VNFD or with values
          passed in the CreateVnfRequest structure (see clause 5.4.2.3.1).
          This attributeThese attributes can be created, modified or removed with the PATCH method.

          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
          Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes
          of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with
          a defined initial value. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions"
          that have no declared initial value shall not be created, in order to be consistent with the semantics
          of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request.
        $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
          These attributes represent values that are stored persistently in the VnfInstance structure
          for consumption by the VNFM or the lifecycle management scripts during the execution of
          VNF lifecycle management operations.
          All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an extension
          in the VNFD contains information on whether its presence is optional or required, and optionally
          can specify an initial value. See note 2 and note 4. The VNFM shall reject requests to write extension
          attributes that are not declared in the VNFD with a "422 Unprocessable entity" error response as defined
          in clause 6.4 of ETSI GS NFV-SOL 013.
          Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified
          attribute values can be considered during subsequent VNF lifecycle management operations, which means that
          the modified values can indirectly affect the configuration of the VNF instance.
          These attributes can be initialized with default values from the VNFD.
          These attributes can be modified with values passed in the request structures of certain LCM operations, 
          such as the InstantiateVnfRequest structure.
          Further, these attributes can be created, modified or deleted with the PATCH method.

          NOTE: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes 
          of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined
          initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata", 
          obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata" 
          and "extensions" that have no defineddeclared initial value shall not be created, in order to be consistent 
          with the semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion 
          request.
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: URI of this resource.
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          indicators:
            description: Indicators related to this VNF instance, if applicable.
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          instantiate:
            description: >
              Link to the "Instantiate VNF task" resource, if the related operation
              is possible based on the current status of this VNF instance
              resource (i.e. VNF instance in NOT_INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          terminate:
            description: >
              Link to the "Terminate VNF task" resource, if the related operation
              is possible based on the current status of this VNF instance
              resource (i.e. VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          scale:
            description: >
              Link to the "Scale VNF task" resource, if the related operation is
              supported for this VNF instance, and is possible based on the
              current status of this VNF instance resource (i.e. VNF instance
              is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          scaleToLevel:
            description: >
              Link to the "Scale VNF to level task" resource, if the related
              operation is supported for this VNF instance, and is possible
              based on the current status of this VNF instance resource
              (i.e. VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          changeFlavour:
            description: >
              Link to the "Change VNF flavour task" resource, if the related
              operation is supported for this VNF instance, and is possible
              based on the current status of this VNF instance resource
              (i.e. VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          heal:
            description: >
              Link to the "Heal VNF task" resource, if the related operation is
              supported for this VNF instance, and is possible based on the
              current status of this VNF instance resource
              (i.e. VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          operate:
            description: >
              Link to the "Operate VNF task" resource, if the related operation is
              supported for this VNF instance, and is possible based on the
              current status of this VNF instance resource
              (i.e. VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          changeExtConn:
            description: >
              Link to the "Change external VNF connectivity task" resource, if the related
              operation is possible based on the current status of this VNF
              instance resource (i.e. VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          createSnapshot:
            description: >
              Link to the "Create VNF snapshot task" resource, if the related operation is 
              supported for this VNF instance and is possible based on the current status of 
              this VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          revertToSnapshot:
            description: >
              Link to the "Revert to VNF snapshot task" resource, if the related operation is 
              supported for this VNF instance and is possible based on the current status of 
              this VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
            $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  VnfStateSnapshotInfo:
    description: >
      This type represents information about VNF-specific state snapshot data.
    type: object
    required:
      - checksum
      - isEncrypted
    properties:
      checksum:
        description: >
          Checksum of the VNF state snapshot file. Hash algorithms applicable to VNF snapshot package artifacts
          are defined in ETSI GS NFV-SOL 010.
          $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
      isEncrypted:
        description: >
          Reflects whether the VNF state snapshot content is encrypted (true) or not (false).
          $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
      metadata:
        description: >
          The metadata with additional information such as content type, size, creation date, etc.
          $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  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.
          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
      - 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.
          Shall be present in case a corresponding VnfcResourceInfo instance exists.
          This allows to represent the error condition that a VNFC instance has lost its resources.
        $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"

  ModificationsTriggeredByVnfPkgChange:
    description: >
      This type represents attribute modifications that were performed on an "Individual VNF instance" resource when
      changing the current VNF package. The attributes that can be included consist of those requested to be modified
      explicitly in the "ChangeCurrentVnfPkgRequest" data structure, and additional attributes of the "VnfInstance"
      data structure that were modified implicitly during the operation.
    type: object
    properties:
      vnfConfigurableProperties:
        description: >
          This attribute signals the modifications of the "vnfConfigurableProperties" attribute in "VnfInstance" performed
          by the operation and shall be present if that attribute was modified during the operation.
          This attribute represents the delta (semantics as per IETF RFC 7386, JSON Merge Patch) between the value
          of the attribute at the start of the "Change current VNF package" operation and the value of the attribute at
          its completion.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          This attribute signals the modifications of the "metadata" attribute in "VnfInstance" performed by the operation
          and shall be present if that attribute was modified during the operation.
          This attribute represents the delta (semantics as per IETF RFC 7386, JSON Merge Patch) between the value
          of the attribute at the start of the "Change current VNF package" operation and the value of the attribute at
          its completion.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          This attribute signals the modifications of the "extensions" attribute in "VnfInstance" performed by the operation and
          shall be present if that attribute was modified during the operation.
          This attribute represents the delta (semantics as per IETF RFC 7386, JSON Merge Patch) between the value
          of the attribute at the start of the "Change current VNF package" operation and the value of the attribute at
          its completion.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfdId:
        description: >
          If present, this attribute signals the new value of the "vnfdId" attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfProvider:
        description: >
          If present, this attribute signals the new value of the "vnfProvider" attribute in "VnfInstance". If present,
          this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related
          operation, and contains a copy of  the value of he related attribute from the VNFD in the VNF Package identified
          by the "vnfdId" attribute.
        type: string
      vnfProductName:
        description: >
          If present, this attribute signals the new value of the "vnfProductName" attribute in "VnfInstance". If present,
          this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related
          operation, and contains a copy of  the value of he related attribute from the VNFD in the VNF Package identified
          by the "vnfdId" attribute.
        type: string
      vnfSoftwareVersion:
        description: >
          If present, this attribute signals the new value of the "vnfSoftwareVersion" attribute in "VnfInstance". If present,
          this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related
          operation, and contains a copy of  the value of he related attribute from the VNFD in the VNF Package identified
          by the "vnfdId" attribute.
        $ref: "SOL002SOL003_def.yaml#/definitions/Version"
      vnfdVersion:
        description: >
          If present, this attribute signals the new value of the "vnfdVersion" attribute in "VnfInstance". If present,
          this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related
          operation, by copying the value of this attribute from the VNFD in the VNF Package identified by the "vnfdId"
          attribute.
        $ref: "SOL002SOL003_def.yaml#/definitions/Version"

  LcmOpOccNotificationVerbosityType:
    description: >
      The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation
      occurrence notifications.
      * FULL: This signals a full notification which contains all change details.
      * SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to
               be sent via the notification mechanism.
    type: string
    enum:
      - FULL
      - SHORT