SOL003VNFLifecycleManagement_def.yaml

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

definitions:
  InstantiateVnfRequest:
    description: >
      This type represents request parameters for the "Instantiate VNF" operation. 
      It shall comply with the provisions defined in table 5.5.2.4-1.

      NOTE 1:	The indication of externally-managed internal VLs is needed in case 
              networks have been pre-configured for use with certain VNFs, for instance 
              to ensure that these networks have certain properties such as security or 
              acceleration features, or to address particular network topologies. 
              The present document assumes that externally-managed internal VLs are 
              managed by the NFVO and created towards the VIM.
      NOTE 2:	It is possible to have several ExtManagedVirtualLinkData for the same VNF 
              internal VL in case of a multi-site VNF spanning several VIMs. The set of 
              ExtManagedVirtualLinkData 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 4.4.1.12).
    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, including configuration information
          for the CPs via which the VNF instance can attach to this VL.
          The following applies to the "ExtVirtualLinkData" information provided in this
          request, together with the related overriding information provided in the 
          "Grant" structure (see clause 9.5.2.3): Even if the VNF is not instantiated in
          fully scaled-out state, the  API consumer shall provide enough CP configuration
          records to allow connecting the VNF instance, fully scaled out in all scaling 
          aspects, to the external VLs
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by the NFVO. See note 1 and note 2.
        type: array
        items:
          $ref: "#/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. The VNFM shall apply the content of this 
          attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch 
          (see IETF RFC 7396).
        type: object
        additionalProperties:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"

      localizationLanguage:
        description: >
          Localization language of the VNF to be instantiated. The value shall
          comply with the format defined in IETF RFC 5646.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      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"
      extensions:
        description: >
          If present, this attribute provides modifications to the default values, 
          as obtained from the VNFD, of the "extensions" attribute in "VnfInstance", 
          as defined in clause 5.5.2.2. Provisions for handling extensions during the
          operation are defined in clause 5.4.4.3.1.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfConfigurableProperties:
        description: >
          If present, this attribute provides modifications to the default values, as obtained from the VNFD, of 
          the "vnfConfigurableProperties" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for 
          handling configurable properties during the operation are defined in clause 5.4.4.3.1.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  ExtManagedVirtualLinkData:
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
      - resourceId
    properties:
      id:
        description: >
          The identifier of the externally-managed internal VL instance. The
          identifier is assigned by the NFV-MANO entity that manages this VL
          instance.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfVirtualLinkDescId:
        description: >
          The identifier of the VLD in the VNFD for this VL.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      vimConnectionId:
        description: >
          Identifier of the VIM connection to manage this resource. This
          attribute shall only be supported and present if VNF-related
          resource management in direct mode is applicable.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifies the entity responsible for the management of this
          resource. This attribute shall only be supported and present if
          VNF-related resource management in indirect mode is applicable. The
          identification scheme is outside the scope of the present document.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      resourceId:
        description: >
          The identifier of the resource in the scope of the VIM or the
          resource provider.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim"
      vnfLinkPort:
        description: >
          Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL
          on this network resource. If this attribute is not present, the VNFM shall create the link ports on the
          externally-managed VL.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VnfLinkPortData"
      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 present
          externally-managed internal VL (indicated by extManagedVirtualLinkId) 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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"

  ChangeVnfFlavourRequest:
    description: >
      This type represents request parameters for the "Change VNF flavour" operation. 
      It shall comply with the provisions defined in table 5.5.2.7-1.

      NOTE 1:	The indication of externally-managed internal VLs is needed in case networks 
              have been pre-configured for use with certain VNFs, for instance to ensure 
              that these networks have certain properties such as security or acceleration 
              features, or to address particular network topologies. The present document 
              assumes that externally-managed internal VLs are managed by the NFVO and created 
              towards the VIM.
      NOTE 2:	It is possible to have several ExtManagedVirtualLinkData for the same VNF internal 
              VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData 
              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 4.4.1.12).
    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, including configuration information 
          for the CPs via which the VNF instance can attach to this VL.
          Entries in the list of external VLs that are unchanged need not be supplied as part of
          this request.
          The following applies to the "ExtVirtualLinkData" information provided in this 
          request, together with the related "ExtVirtualLinkInfo" information known to the 
          VNFM represented in the "VnfInstance" structure (see clause 5.5.2.2) and the related
          overriding information provided in the "Grant" structure (see clause 9.5.2.3): Even if the VNF 
          is not in fully scaled-out state after changing the flavour, the API consumer shall provide 
          enough CP configuration records to allow connecting the VNF instance, fully scaled out in all scaling 
          aspects, to the external VLs.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by the NFVO. See notes 1 and 2.
        type: array
        items:
          $ref: "#/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. The VNFM shall apply the content of this 
          attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch 
          (see IETF RFC 7396).