# 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
      - _links
    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.
          This attribute can be modified with the PATCH method.
          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 apart from 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: >
          Additional VNF-specific attributes that provide the current values 
          of the configurable properties of the VNF instance.
          These attributes represent values that are stored persistently in 
          the VnfInstance structure and that correspond to configuration 
          parameters of the VNF instance. 
          Modifying these attributes affects the configuration of the VNF 
          instance either directly (if the VNF instance is in INSTANTIATED 
          state at the time of the modification) or as part of the subsequent 
          VNF instantiation operation (if the VNF instance is in NOT_INSTANTIATED 
          state at the time of the modification).
          Configurable properties referred in these attributes shall be declared 
          in the VNFD. 
          The declaration of configurable properties in the VNFD can optionally 
          contain the specification of initial values. 
          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.
          This attributeThese attributes can be modified with the PATCH method.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      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
          - extCpInfo
        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.
            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/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcResourceInfo"
          vnfVirtualLinkResourceInfo:
            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"
          vnfVirtualStorageResourceInfo:
            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"
          vnfcInfo:
            description: >
              Information about the VNFC instances.
            type: array
            items:
              $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo"
      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 VNF provider foresees shall be declared in the VNFD. The VNFM shall 
          accept requests to write metadata that are not  are declared in the VNFD.  

          These attributes can be initialized with default values from VNFD and/or with values 
          passed in the CreateVnfRequest structure (see clause 5.5.2.3).

          This attribute can be modified with the PATCH method.

          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          Additional VNF specific attributes that affect the lifecycle management of this 
          VNF instance by the VNFM, or the lifecycle management scripts. 
          These attributes represent values that are stored persistently in the VnfInstance 
          structure for consumption by the VNFM, or by the lifecycle management scripts 
          during the execution of VNF lifecycle management operations. 
        
          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.

          All extensions that are allowed for the VNF shall be declared in the VNFD.
          This attribute can be be initialized with default values from VNFD and/or 
          with values passed in the InstantiateVnfRequest structure (see clause 5.5.2.4).

          A value initialised with default values from the VNFD can be updated with values 
          passed in the InstantiateVnfRequest structure.

          Further, these attributes can be modified with the PATCH method.
        
          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on 
          TOSCA specifications.
        $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:
    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 external VLs to connect the VNF to.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData"
      localizationLanguage:
        description: >
          Localization language of the VNF to be instantiated. The value shall
          comply with the format defined in IETF RFC 5646.
        type: 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 VNF
          configurable properties attribute in the "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:
    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/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData"
      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 VNF configurable properties attribute in
          the "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 the type of 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:
      vnfcInstanceId:
        description: >
          List of VNFC instances requiring a healing action.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      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"
      healScript:
        description: >
          Provides link to a script that should be executed as part
          of the healing action or a set of rules for healing procedure.
        type: string

  OperateVnfRequest:
    description: >
      This type represents request parameters for the "Operate VNF" operation.
    type: object
    required:
      - changeStateTo
    properties:
      vnfcInstanceId:
        description: >
          Identifier of VNFC instances. Cardinality can be "0" to denote
          that the request applies to the whole VNF and not a specific VNFC instance.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      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 has been set to "FORCEFUL", when the
          "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is absent.
        type: string
        enum:
          - FORCEFUL
          - GRACEFUL
      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 has been 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:
    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"

  ChangeCurrentVnfPkgRequest:
    description: >
      This type represents request parameters for the "Change current VNF package" operation to replace the VNF package
      on which a VNF instance is based.
    type: object
    required:
      - vnfdId
    properties:
      vnfdId:
        description: >
          Identifier of the VNFD which defines the destination VNF Package for the change.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to. Entries in the list 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 other entities than the VNFM.
        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 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 parameters passed by the EM as input to the process, specific to the VNF of which the underlying
          VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        descriptions: >
          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, and needed passed
          parameter values in case of conflicts, are defined in clause 5.4.11a.3.1.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfConfigurableProperties:
        description: >
          If present, this attribute provides modifications to the values of the VNF configurable properties attribute
          in the "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during
          the operation, and needed passed parameter values in case of conflicts, are defined in clause 5.4.11a.3.1.
        $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.
      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: "../../../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 [15]).
        $ref: "../../../definitions/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: "../../../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  [15]).
        $ref: "../../../definitions/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/SOL002SOL003VNFLifecycleManagement_def.yaml#/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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"

  CreateVnfSnapshotRequest:
    description: >
      This type represents request parameters for the "Create VNF Snapshot" operation.
    type: object
    required:
      - vnfSnapshotResId
    properties:
      vnfSnapshotResId:
        description: >
          Identifier of the individual VNF snapshot resource to which the VNF Snapshot is to be associated.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfcInstanceId:
        description: >
          Identifier of the VNFC instance to be snapshotted. If this attribute is provided, only a snapshot of the
          referred VNFC instance shall be created.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      additionalParams:
        description: >
          Additional input parameters for the snapshot creation process, specific for the VNF being “snapshotted”,
          as declared in the VNFD as part of "CreateSnapshotVnfOpConfig".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      userDefinedData:
        description: >
          User defined data for the VNF snapshot.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  RevertToVnfSnapshotRequest:
    description: >
      This type represents request parameters for the "Revert-to VNF Snapshot" operation.
    type: object
    oneOf:
      - anyOf:
          - required:
              - vnfInstanceId
          - required:
              - vnfSnapshotInfoId
      - anyOf:
          - required:
              - vnfcInstanceId
          - required:
              - vnfcSnapshotInfoId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to be reverted. Only one of the tuples (vnfInstanceId; vnfSnapshotInfoId) or
          (vnfcInstanceId; vnfcSnapshotInfoId) shall be present, indicating whether a VNF instance or a VNFC instance
          shall be reverted.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfSnapshotId:
        description: >
          Identifier of the VNF snapshot to be reverted to.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfcInstanceId:
        description: >
          Identifier of the VNFC instance to be reverted. Only one of the tuples (vnfInstanceId; vnfSnapshotInfoId) or
          (vnfcInstanceId; vnfcSnapshotInfoId) shall be present, indicating whether a VNF instance or a VNFC instance
          shall be reverted.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfcSnapshotId:
        description: >
          Identifier of the VNFC snapshot to be reverted to.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"

  VnfSnapshotRes:
    description: >
      This type represents an individual VNF snapshot resource.
    type: object
    required:
      - id
    properties:
      id:
        description: >
          Identifier of the individual VNF snapshot resource. This identifier is allocated by the VNFM.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfSnapshot:
        description: >
          VNF snapshot information, 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'

  VnfSnapshot:
    description: >
      This type represents a VNF snapshot.
    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"
      triggeredAt:
        description: >
          Timestamp indicating when the VNF snapshot creation has been started.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      createdAt:
        description: >
          Timestamp indicating when the VNF snapshot has been completed. 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"
      vnfInfo:
        description: >
          VnfInfo of the snapshotted VNF instance. This is a copy of the individual VNF instance resource.
        $ref: '#/definitions/VnfInstance'
      vnfcSnapshots:
        description: >
          Information about VNFC snapshots constituting this VNF snapshot.
        type: array
        items:
          $ref: '#/definitions/VnfcSnapshotInfo'
      userDefinedData:
        description: >
          User defined data for the VNF snapshot.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  VnfcSnapshotInfo:
    description: >
      This type represents a VNFC snapshot.
    type: object
    required:
      - id
      - vnfcInstanceId
      - triggeredAt
      - vnfcInfo
    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/Identifier"
      vnfcInstanceId:
        description: >
          Identifier of the snapshotted VNFC instance.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      triggeredAt:
        description: >
          Timestamp indicating when the VNF snapshot creation has been started.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      createdAt:
        description: >
          Timestamp indicating when the VNFC snapshot has been completed. Shall be present once the VNFC snapshot
          creation has been completed.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      vnfcInfo:
        description: >
          Information of the snapshotted VNFC instance. This is a copy of the individual VnfcResourceInfo.
        $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo"
      computeSnapshotResource:
        description: >
          Reference to a compute snapshot resource. The identifiers of the compute and storage snapshot resources are
          assigned during creation of a VNFC snapshot being returned from the VIM as output data in the response message
          of the individual resource operations.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      storageSnapshotResources:
        description: >
          Reference to a storage snapshot resource. The identifiers of the compute and storage snapshot resources are
          assigned during creation of a VNFC snapshot being returned from the VIM as output data in the response message
          of the individual resource operations.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      userDefinedData:
        description: >
          User defined data for the VNF snapshot.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  StopType:
    description: >
      The enumeration StopType.
      * FORCEFUL: The VNFM will stop the VNF instance or VNFC instance(s) immediately after accepting the request.
      * GRACEFUL: The VNFM will first arrange to take the VNF instance or VNFC instance(s) 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 or VNFC instance(s).
    type: string
    enum:
      - FORCEFUL
      - GRACEFUL