SOL003VNFLifecycleManagement_def.yaml

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

definitions:
  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 (see note 4).
          Configurable properties can be modified with values passed in 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 4:	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 defined 
          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. This attribute shall only be
          supported and present if VNF-related resource management in direct
          mode is applicable.
          This attribute can be modified with the PATCH method.
        type: array
        items:
          $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.
            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: >
              External virtual links the VNF instance is connected to.
            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/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 (see note 4).
          These attributes can be updatedmodified 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 2:	ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
          NOTE 4:	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 declareddefined 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"
      _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"

  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/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by the NFVO.
          NOTE:	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.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_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/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"

  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.
          Entries in the list of external VLs that are unchanged need not be supplied as part of this request.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by the NFVO.

          NOTE:	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.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_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/SOL002SOL003_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"
      extensions:
        description: >
          If present, this attribute provides modifications to the values 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.7.3.1.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfConfigurableProperties:
        description: >
          If present, this attribute provides modifications to the values of the vnfConfigurableProperties" attribute 
          in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during 
          the operation, are defined in clause 5.4.7.3.1.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  TerminateVnfRequest:
    type: object
    required:
      - terminationType
    properties:
      terminationType:
        description: >
          Indicates whether forceful or graceful termination is requested.
          Permitted values:
          * FORCEFUL: The VNFM will shut down the VNF and release the
            resources immediately after accepting the request.
          * GRACEFUL: The VNFM will first arrange to take the VNF out of
          service after accepting the request. Once the operation of taking
          the VNF out of service finishes (irrespective of whether it has
          succeeded or failed) or once the timer value specified in the
          "gracefulTerminationTimeout" attribute expires, the VNFM will shut
          down the VNF and release the resources.
        type: string
        enum:
          - FORCEFUL
          - GRACEFUL
      gracefulTerminationTimeout:
        description: >
          This attribute is only applicable in case of graceful termination.
          It defines the time to wait for the VNF to be taken out of service
          before shutting down the VNF and releasing the resources.
          The unit is seconds.
          If not given and the "terminationType" attribute is set to
          "GRACEFUL", it is expected that the VNFM waits for the successful
          taking out of service of the VNF, no matter how long it takes,
          before shutting down the VNF and releasing the resources.
        type: integer
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the termination
          process, specific to the VNF being terminated, as declared in the
          VNFD as part of "TerminateVnfOpConfig".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  HealVnfRequest:
    type: object
    properties:
      cause:
        description: >
          Indicates the reason why a healing procedure is required.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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"

  OperateVnfRequest:
    description: >
      This type represents request parameters for the "Operate VNF" operation.
    type: object
    required:
      - changeStateTo
    properties:
      changeStateTo:
        description: >
          The desired operational state (i.e. started or stopped) to change
          the VNF to.
        $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType"
      stopType:
        description: >
          It signals whether forceful or graceful stop is requested.
          The “stopType” and “gracefulStopTimeout” attributes shall be absent,
          when the “changeStateTo” attribute is equal to “STARTED”. The
          “gracefulStopTimeout” attribute shall be present, when the
          “changeStateTo” is equal to “STOPPED” and the “stopType” attribute
          is equal to “GRACEFUL”. The “gracefulStopTimeout” attribute shall be
          absent, when the “changeStateTo” attribute is equal to “STOPPED” and
          the “stopType” attribute is equal to “FORCEFUL”. The request shall
          be treated as if the “stopType” attribute was set to ”FORCEFUL”, when
          the “changeStateTo” attribute is equal to “STOPPED” and the
          “stopType” attribute is absent.
        $ref: "#/definitions/StopType"
      gracefulStopTimeout:
        description: >
          The time interval (in seconds) to wait for the VNF to be taken out
          of service during graceful stop, before stopping the VNF.
          The “stopType” and “gracefulStopTimeout” attributes shall be absent,
          when the “changeStateTo” attribute is equal to “STARTED”. The
          “gracefulStopTimeout” attribute shall be present, when the
          “changeStateTo” is equal to “STOPPED” and the “stopType” attribute
          is equal to “GRACEFUL”. The “gracefulStopTimeout” attribute shall be
          absent, when the “changeStateTo” attribute is equal to “STOPPED” and
          the “stopType” attribute is equal to “FORCEFUL”. The request shall
          be treated as if the “stopType” attribute was set to ”FORCEFUL”, when
          the “changeStateTo” attribute is equal to “STOPPED” and the
          “stopType” attribute is absent.
        type: integer
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the process,
          specific to the VNF of which the operation status is changed, as
          declared in the VNFD as part of "OperateVnfOpConfig".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  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).
          Entries in the list of external VLs that are unchanged need not be supplied as part of this request.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_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/SOL002SOL003_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"

  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.
    type: object
    properties:
      vnfInstanceName:
        description: >
          New value of the "vnfInstanceName" attribute in "VnfInstance", or
          "null" to remove the attribute.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      vnfInstanceDescription:
        description: >
          New value of the "vnfInstanceDescription" attribute in
          "VnfInstance", or "null" to remove the attribute.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      vnfPkgId:
        description: >
          New value of the "vnfPkgId" attribute in "VnfInstance".
          The value "null" is not permitted.
        $ref: "../../../definitions/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).
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          Modifications of the "metadata" attribute in "VnfInstance". If
          present, these modifications shall be applied according to the rules
          of JSON Merge Patch (see IETF RFC 7396).
        $ref: "../../../definitions/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).
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vimConnectionInfo:
        description: >
          New content of certain entries in the "vimConnectionInfo" attribute
          array in "VnfInstance", as defined below this table.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
      vimConnectionInfoDeleteIds:
        description: >
          List of identifiers entries to be deleted from the "vimConnectionInfo"
          attribute array in "VnfInstance", to be used as "deleteIdList" as defined
          below this table.
        type: array
        items:
          $ref: "../../../definitions/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".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      vnfInstanceDescription:
        description: >
          If present, this attribute signals modifications of the
          "vnfInstanceDescription" attribute in "VnfInstance".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      vnfConfigurableProperties:
        description: >
          If present, this attribute signals modifications of the
          "vnfConfigurableProperties" attribute in "VnfInstance".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          If present, this attribute signals modifications of the "metadata"
          attribute in "VnfInstance".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          If present, this attribute signals modifications of the "extensions"
          attribute in "VnfInstance".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vimConnectionInfo:
        description: >
          If present, this attribute signals modifications of certain entries
          in the "vimConnectionInfo" attribute array in "VnfInstance".
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
      vimConnectionInfoDeleteIds:
        description: >
          If present, this attribute signals the deletion of certain entries
          in the "vimConnectionInfo" attribute array in "VnfInstance".
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfdId:
        description: >
          If present, this attribute signals modifications of the "vnfdId"
          attribute in "VnfInstance".
        $ref: "../../../definitions/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.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      vnfSoftwareVersion:
        description: >
          If present, this attribute signals modifications of the
          "vnfSoftwareVersion" attribute in "VnfInstance".
        $ref: "../../../definitions/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
          "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.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"

  StopType:
    description: >
      * FORCEFUL: The VNFM will stop the VNF instance immediately after accepting the
        request.
      * GRACEFUL: The VNFM will first arrange to take the VNF instance out of service
        after accepting the request. Once that operation is successful or once
        the timer value specified in the "gracefulStopTimeout" attribute
        expires, the VNFM will stop the VNF instance.
    type: string
    enum:
      - FORCEFUL
      - GRACEFUL

  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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
        $ref: "../../../definitions/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: "../../../definitions/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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfcCpInfo:
        description: >
          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. See note 2. May be present otherwise.

          NOTE 2:	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.
        type: array
        items:
          type: object
          required:
            - id
            - cpdId
          properties:
            id:
              description: >
                Identifier of this VNFC CP instance and the associated array
                entry.
              $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
              $ref: "../../../definitions/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 2) and shall be absent otherwise.

                NOTE 2:	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: "../../../definitions/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. See note 3.

                NOTE 3:	The information can be omitted because it is already available as part of the external 
                CP information.
              type: array
              items:
                $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CpProtocolInfo"
            vnfLinkPortId:
              description: >
                Identifier of the "VnfLinkPorts" 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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            metadata:
              description: >
                Metadata about this CP.
              $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  VnfLcmOpOcc:
    description: >
      This type represents a VNF lifecycle management operation occurrence.
    type: object
    required:
      - id
      - operationState
      - stateEnteredTime
      - startTime
      - vnfInstanceId
      - operation
      - isAutomaticInvocation
      - isCancelPending
    properties:
      id:
        description: >
          Identifier of this VNF lifecycle management operation occurrence.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      operationState:
        description: >
          The state of the LCM operation.
        $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType"
      stateEnteredTime:
        description: >
          Date-time when the current state has been entered.
        $ref: "../../../definitions/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: "../../../definitions/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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      operation:
        description: >
          Type of the actual LCM operation represented by this VNF LCM
          operation occurrence.
        $ref: "../../../definitions/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: "../../../definitions/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
        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: "../../../definitions/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/SOL002SOL003VNFLifecycleManagement_def.yaml#/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: "../../../definitions/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.
              NOTE 1: 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/SOL002SOL003_def.yaml#/definitions/AffectedVnfc"
          affectedVirtualLinks:
            description: >
              Information about VL instances that were affected during the
              lifecycle operation. See note 1 and note 2.

              NOTE 1:	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.
              NOTE 2:	For a particular affected VL, there shall be as many 
              "AffectedVirtualLink" entries as needed for signalling the different 
              types of changes, i.e., one per virtual link and change type. For instance, 
              in the case of signaling affected VL instances involving the addition of a 
              particular VL instance with links ports, one "AffectedVirtualLink" entry 
              signals the addition of the VL by using the "changeType" attribute of 
              "AffectedVirtualLink" structure equal to "ADDED", and another "AffectedVirtualLink" 
              entry signals the addition of externally visible VNF link ports of the VL by using 
              the "changeType" equal to "LINK_PORT_ADDED".
            type: array
            items:
              $ref: "#/definitions/AffectedVirtualLink"
          affectedExtLinkPorts:
            description: >
              Information about external VNF link ports that were affected during the lifecycle 
              operation. See note 1.

              NOTE 1:	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/AffectedExtLinkPort"
          affectedVirtualStorages:
            description: >
              Information about virtualised storage instances that were affected
              during the lifecycle operation.
              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/SOL002SOL003VNFLifecycleManagement_def.yaml#/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.