VNFLifecycleManagement_def.yaml

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

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

  AffectedVirtualStorage:
    # Ref TBD
    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: "#/definitions/IdentifierInVnf"
      virtualStorageDescId:
        description: >
          Identifier of the related VirtualStorage descriptor in the VNFD.
        $ref: "#/definitions/IdentifierInVnfd"
      changeType:
        description: >
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          For a temporary resource, an AffectedVirtualStorage structure exists
          as long as the temporary resource exists.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
      storageResource:
        description: >
          Reference to the VirtualStorage resource. Detailed information is 
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      
  AffectedVnfc:
    description: >
      This type provides information about added, deleted, modified and
      temporary VNFCs.  
    type: object
    required:
      - id
      - vduId
      - changeType
      - computeResource
    properties:
      id:
        description: >
          Identifier of the Vnfc instance, identifying the applicable
          "vnfcResourceInfo" entry in the "VnfInstance" data type.
        $ref: "#/definitions/IdentifierInVnf"
      vduId:
        description: >
          Identifier of the related VDU in the VNFD.
        $ref: "#/definitions/IdentifierInVnfd"
      changeType:
        description: >
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          For a temporary resource, an AffectedVnfc structure exists as long
          as the temporary resource exists.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
      computeResource:
        description: >
          Reference to the VirtualCompute resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
        $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      addedStorageResourceIds:
        description: >
          References to VirtualStorage resources that have been added. Each
          value refers to a VirtualStorageResourceInfo item in the
          VnfInstance that was added to the VNFC. It shall be provided if at
          least one storage resource was added to the VNFC.
        $ref: "#/definitions/IdentifierInVnf"

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

  ChangeExtVnfConnectivityRequest:
    # Ref TBD
    description: >
      This type represents request parameters for the 
      "Change external VNF connectivity" operation to modify the external
      connectivity of a VNF instance.
    type: object
    required:
      - extVirtualLinks
    properties:
      extVirtualLinks:
        description: >
          Information about external VLs to change (e.g. connect the VNF to).
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
      additionalParams:
        description: >
          Additional input parameters for the instantiation process, specific
          to the VNF being instantiated, as declared in the VNFD as part of 
          "ChangeExtVnfConnectivityOpConfig".".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  ChangeVnfFlavourRequest:
    # Ref TBD
    description: >