VNFLifecycleManagement_def.yaml

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

definitions:
  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:
    #SOL003 location: 5.5.2.11
    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/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkData"
      vimConnectionInfo:
        description: >
          Information about VIM connections to be used for managing the
          resources for the VNF instance, or refer to external virtual
          links. This attribute shall only be supported and may be present
          if VNF-related resource management in direct mode is applicable.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VimConnectionInfo"
      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:
    #SOL003 location: 5.5.2.7
    description: >
      This type represents request parameters for the "Change VNF flavour" operation.
    type: object
    required:
      - newFlavourId
    properties:
      newFlavourId:
        description: >
          Identifier of the VNF deployment flavour to be instantiated.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment flavour to
          be instantiated. If not present, the default instantiation level as
          declared in the VNFD is instantiated.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkData"
      vimConnectionInfo:
        description: >
          Information about VIM connections to be used for managing the
          resources for the VNF instance, or refer to
          external / externally-managed virtual links. This attribute shall
          only be supported and may be present if VNF-related resource
          management in direct mode is applicable.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VimConnectionInfo"
      additionalParams:
        description: >
          Additional input parameters for the instantiation process, specific
          to the VNF being instantiated, as declared in the VNFD as part of 
          "InstantiateVnfOpConfig".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  extCpInfo:
    type: object
    required:
      - id
      - cpdId
    properties:
      id:
        description: >
          Identifier of the external CP instance and the related information
          instance.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      cpdId:
        description: >
          Identifier of the external connection point descriptor in the VNFD.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      addresses:
        description: >
          List of network addresses that have been configured (statically or
          dynamically) on the CP.
        type: array
        items:
          $ref: "#/definitions/NetworkAddressInfo"

  ExtManagedVirtualLinkInfo:
    #SOL003 location: 5.5.3.3
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
    properties:
      id:
        description: >
          Identifier of the externally-managed internal VL and the related
          externally-managed VL information instance.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
        $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ResourceHandle"
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPort"

  HealVnfRequest:
    type: object
    properties:
      cause:
        description: >
          Indicates the reason why a healing procedure is required.
        type: string
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the healing
          process, specific to the VNF being healed, as declared in the VNFD
          as part of "HealVnfOpConfig".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  InstantiateVnfRequest:
    #SOL003 location: 5.5.2.4
    type: object
    required:
      - flavourId
    properties:
      flavourId:
        description: >
          Identifier of the VNF deployment flavour to be instantiated.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment flavour to be
          instantiated. If not present, the default instantiation level as
          declared in the VNFD is instantiated.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkData"