SOL005NSLifecycleManagement_def.yaml 233 KB
Newer Older
  LcmOpOccStatusForChangeNotificationType:
    description: >
      The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management
      operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the
      provisions defined in Table 6.5.4.7-1.
      Value | Description
      ------|------------
      START | The impact on the NS component is identified.
      COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully.
      PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS       component.
      FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component.
      ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back.
    type: string
    enum:
      - START
      - COMPLETED
      - ROLLED_BACK

  NsLcmOpOcc:
    description: >
      This type represents a request a NS lifecycle operation occurrence.
      It shall comply with the provisions defined in Table 6.5.2.3-1.
    type: object
    required:
      - id
      - operationState
      - statusEnteredTime
      - nsInstanceId
      - lcmOperationType
      - startTime
      - isAutomaticInvocation
      - isCancelPending
      - _links
    properties:
      id:
        description: >
          Identifier of this NS lifecycle operation occurrence.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      operationState:
        description: >
          The state of the NS LCM operation.
        $ref: "#/definitions/NsLcmOperationStateType"
      statusEnteredTime:
        description: >
          Date-time when the current state has been entered.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      nsInstanceId:
        description: >
          Identifier of the NS instance to which the operation applies.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      lcmOperationType:
        description: >
          Type of the actual LCM operation represented by this
          lcm operation occurrence.
      startTime:
        description: >
          Date-time of the start of the operation.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      isAutomaticInvocation:
        description: >
          Set to true if this NS LCM operation occurrence has
          been automatically triggered by the NFVO. This occurs
          in the case of auto-scaling, auto-healing and when a
          nested NS is modified as a result of an operation on its
          composite NS. Set to false otherwise.
        type: 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 lcmOperationType and
          the data type of this attribute shall apply:
          - INSTANTIATE: InstantiateNsRequest
          - SCALE: ScaleNsRequest
          - UPDATE: UpdateNsRequest
          - HEAL: HealNsRequest
          - TERMINATE: TerminateNsRequest
          This attribute shall be present if this data type is returned
          in a response to reading an individual resource, and may
          be present according to the chosen attribute selector
          parameter if this data type is returned in a response to a
          query of a container resource.
        type: string
        enum:
          - INSTANTIATE
          - SCALE
          - UPDATE
          - HEAL
          - TERMINATE
      isCancelPending:
        description: >
          If the LCM operation occurrence is in "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.
        type: boolean
      cancelMode:
        description: >
          The mode of an ongoing cancellation. Shall be present
          when isCancelPending=true, and shall be absent otherwise.
        $ref: "#/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/SOL005_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:
          affectedVnfs:
            description: >
              Information about the VNF instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
            type: array
            items:
          affectedPnfs:
            description: >
              Information about the PNF instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
            type: array
            items:
          affectedVls:
            description: >
              Information about the VL instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
            type: array
            items:
              $ref: "#/definitions/AffectedVirtualLink"
          affectedVnffgs:
            description: >
              Information about the VNFFG instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note
            type: array
            items:
          affectedNss:
            description: >
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note.
            type: array
            items:
          affectedSaps:
            description: >
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note.
            type: array
            items:
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - nsInstance
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
          nsInstance:
            description: >
              Link to the NS instance that the operation applies to.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
          cancel:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence, if
              cancelling is currently allowed.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
          retry:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence,
              if cancelling is currently allowed.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
          rollback:
            description: >
              Link to the task resource that represents the "rollback"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
          continue:
            description: >
              Link to the task resource that represents the "continue"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
          fail:
            description: >
              Link to the task resource that represents the "fail"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"

  subscriptionId:
    description: >
      Identifier of the subscription that this notification relates to.
    type: string

  nsInstanceId:
    description: >
      The deleted NS instance identifier.
    type: string

  CpProtocolData:
    description: >
      This type represents network protocol data.
    type: object
    required:
      - layerProtocol
    properties:
      layerProtocol:
        description: >
          Identifier of layer(s) and protocol(s).
          Permitted values: IP_OVER_ETHERNET.
        type: string
        enum:
          - IP_OVER_ETHERNET
      ipOverEthernet:
        description: >
          Network address data for IP over Ethernet to
          assign to the extCP instance. Shall be
          present if layerProtocol is equal to
          "IP_OVER_ETHERNET", and shall be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressData"

  IpOverEthernetAddressData:
    description: >
      This type represents network address data for IP over Ethernet.
    type: object
    properties:
      macAddress:
        description: >
          MAC address. If this attribute is not present, it shall be chosen by the NFV MANO.
        $ref: "#/definitions/MacAddress"
      segmentationId:
        description: >
          Identification of the network segment to which the Cp instance connects to.
          If the Cp instance represents a subport in a trunk, "segmentationId" shall be present.
          Otherwise it shall not be present.
          Depending on the NFVI networking infrastructure, the "segmentationId" may indicate the actual network segment
          value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an
          identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface
          of the trunk port in question. In the latter case the NFVI infrastructure will map this local "segmentationId"
          to whatever "segmentationId" is actually used by the NFVI’s transport technology.
        type: string
      ipAddresses:
        description: >
          List of IP addresses to assign to the CP instance. Each entry
          represents IP address data for fixed or dynamic IP address
          assignment per subnet.
          If this attribute is not present, no IP address shall be assigned.
        type: array
        items:
          type: object
          required:
            - type
          properties:
            type:
              description: >
                The type of the IP addresses.
                Permitted values: IPV4, IPV6.
              type: string
              enum:
                - IPV4
                - IPV6
            fixedAddresses:
              description: >
                Fixed addresses to assign (from the subnet defined by
                "subnetId" if provided).
                Exactly one of "fixedAddresses", "numDynamicAddresses" or
                "ipAddressRange" shall be present.
              type: array
              items:
                $ref: "#/definitions/IpAddress"
            numDynamicAddresses:
              description: >
                Number of dynamic addresses to assign (from the subnet defined
                by "subnetId" if provided).
                Exactly one of "fixedAddresses", "numDynamicAddresses" or
                "ipAddressRange" shall be present.
              type: integer
            addressRange:
              description: >
                An IP address range to be used, e.g. in case of egress
                connections.
                In case this attribute is present, IP addresses from the range
                will be used.
              type: object
              required:
                - minAddress
                - maxAddress
              properties:
                minAddress:
                  description: >
                    Lowest IP address belonging to the range.
                  $ref: "#/definitions/IpAddress"
                maxAddress:
                  description: >
                    Highest IP address belonging to the range.
                  $ref: "#/definitions/IpAddress"
            subnetId:
              description: >
                Subnet defined by the identifier of the subnet resource in the
                VIM.
                In case this attribute is present, IP addresses from that
                subnet will be assigned; otherwise, IP addresses not bound to
                a subnet will be assigned.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"

  ExtVirtualLinkData:
    description: >
      This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1.
    type: object
    required:
      - resourceId
      - extCps
    properties:
      extVirtualLinkId:
        description: >
          The identifier of the external VL instance, if provided.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vimId:
        description: >
          Identifier of the VIM that manages this resource. This
          attribute shall only be supported and present if VNFrelated
          resource management in direct mode is applicable.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifies the entity responsible for the management of
          this resource.
          This attribute shall only be supported and present if
          VNF-related resource management in indirect mode is
          applicable. The identification scheme is outside the
          scope of the present document.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      resourceId:
        description: >
          The identifier of the resource in the scope of the VIM or
          the resource provider.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
      extCps:
        description: >
          External CPs of the VNF to be connected to this external VL.
        type: array
        items:
          $ref: "#/definitions/VnfExtCpData"
      extLinkPorts:
        description: >
          Externally provided link ports to be used to connect
          external connection points to this external VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortData"

  ExtManagedVirtualLinkData:
    description: >
      This type represents an externally-managed internal VL.
      It shall comply with the provisions defined in Table 6.5.3.27-1.
    type: object
    required:
      - vnfVirtualLinkDescId
      - resourceId
    properties:
      extManagedVirtualLinkId:
        description: >
          The identifier of the externally-managed internal VL
          instance, if provided.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfVirtualLinkDescId:
        description: >
          The identifier of the VLD in the VNFD for this VL.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      vimId:
        description: >
          Identifier of the VIM that manage this resource. This
          attribute shall only be supported and present if VNFrelated
          resource management in direct mode is applicable.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifies the entity responsible for the management of
          this resource. This attribute shall only be supported and present if
          VNF-related resource management in indirect mode is
          applicable. The identification scheme is outside the
          scope of the present document.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      resourceId:
        description: >
          The identifier of the resource in the scope of the VIM or
          the resource provider.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
      vnfLinkPort:
        description: >
          Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL on
          this network resource. If this attribute is not present, the VNFM shall create the link ports on the
          externally-managed VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortData"
      extManagedMultisiteVirtualLinkId:
        description: >
          Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFV-MANO entity
          that manages the externally managed multi-site VL instance. It shall be present when the present externally-managed
          internal VL (indicated by extManagedVirtualLinkId) is part of a multi-site VL, e.g., in support of multi-site VNF
          spanning several VIMs. All externally-managed internal VL instances corresponding to an internal VL created based
          on the same virtualLinkDescId shall refer to the same extManagedMultisiteVirtualLinkId.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

  VnfExtCpData:
    description: >
      This type represents configuration information for external CPs created
      from a CPD.
    type: object
    required:
      - cpdId
    properties:
      cpdId:
        description: >
          The identifier of the CPD in the VNFD.
          In case this identifier refers to a CPD with trunking enabled, the external CP instances created from this CPD
          will represent ports in a trunk.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      cpConfig:
        description: >
          List of instance data that need to be configured on the CP instances
          created from the respective CPD.
        type: array
        items:
          $ref: "#/definitions/VnfExtCpConfig"

  ExtLinkPortData:
    description: >
      This type represents an externally provided link port to be used to
      connect an external connection point to an external VL.
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that has
          created the link port.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"

  VnfExtCpConfig:
    description: >
      This type represents an externally provided link port or network address
      information per instance of an external connection point. In case a link
      port is provided, the VNFM shall use that link port when connecting the
      external CP to the external VL. In a link port is not provided, the VNFM
      shall create a link port on the external VL, and use that link port to
      connect the external CP to the external VL.
    type: object
      id:
        description: >
          Identifier of the "VnfExtCpConfig" entry. Managed by the API consumer.
          In case the NFVO manages its own identifier space, the NFVO may remap this identifier when communicating with
          the VNFM. If the NFVO knows that there can be an identifier collision when communicating with the VNFM by using
          the identifier from the OSS/BSS, the NFVO shall remap it.
        $ref: "#/definitions/IdentifierInVnf"
      parentCpConfigId:
        description: >
          Reference to the "VnfExtCpConfig" entry that corresponds to the parent port of the trunk. Only present in
          "VnfExtCpConfig" structures that provide configuration information for a CP which represents a subport in a
          trunk, and if parent ports are supported.
        $ref: "#/definitions/IdentifierInVnf"
      cpInstanceId:
        description: >
          Identifier of the external CP instance to which this set of
          configuration parameters is requested to be applied.
          Shall be present if this instance has already been created.
        $ref: "#/definitions/IdentifierInVnf"
      linkPortId:
        description: >
          Identifier of a pre-configured link port to which the external CP
          will be associated.
          The following conditions apply to the attributes "linkPortId" and
          "cpProtocolData":
          * The "linkPortId" and "cpProtocolData" attributes shall both be
            absent for the deletion of an existing external CP instance
            addressed by cpInstanceId.
          * At least one of these attributes shall be present for a
            to-be-created external CP instance or an existing external
            CP instance.
          * If the "linkPortId" attribute is absent, the VNFM shall create a
            link port.
          * If the "cpProtocolData" attribute is absent, the "linkPortId"
            attribute shall be provided referencing a pre-created link port,
            and the VNFM can use means outside the scope of the present
            document to obtain the pre-configured address information for the
            connection point from the resource representing the link port.
          * If both "cpProtocolData" and "linkportId" are provided, the API
            consumer shall ensure that the cpProtocolData can be used with the
            pre-created link port referenced by "linkPortId".
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the link port
          that connects the CP to a VL.
          The following conditions apply to the attributes "linkPortId" and "cpProtocolData":
          *	The "linkPortId" and "cpProtocolData" attributes shall both be absent for the deletiondisconnection of an
            existing external CP instance addressed by "cpInstanceId" from a particular external virtual link, and
            deletion of that instance in case it represents a subport.
          *	At least one of these attributes shall be present for a to-be-createdan external CP instance representing a
            subport that is to be created, or an external CP instance that is to be created by creating the corresponding
            VNFC or VNF instance during the current or a subsequent LCM operation, or for an existing external CP instance
            that is to be re-configured or added to a particular external virtual link
  IdentifierInNs:
    description: >
      An identifier that is unique with respect to a NS. Representation: string of variable length.
    type: string

  IdentifierInNsd:
    description: >
      An identifier that is unique within a NS descriptor. Representation: string of variable length.
    type: string

  IdentifierInPnf:
    description: >
      An Identifier that is unique within respect to a PNF. Representation: string of variable length.
    type: string

  IdentifierInVim:
    description: >
      An identifier maintained by the VIM or other resource provider.
      It is expected to be unique within the VIM instance. Representation: string of variable length.
    type: string

  IdentifierInVnf:
    description: >
      An identifier that is unique for the respective type within a VNF
      instance, but may not be globally unique.
    type: string

  MacAddress:
    description: >
      A MAC address. Representation: string that consists of groups of two hexadecimal digits,
      separated by hyphens or colons.
    type: string
    format: MAC

  IpAddress:
    description: >
      An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
      integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
      consists of groups of zero to four hexadecimal digits, separated by colons.
    type: string
    format: IP

  IpAddressPrefix:
    description: >
      An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF RFC 4632 [12].
      For IPV6 address range, refer to IETF RFC 4291.
    type: string

  PortRange:
    description: >
      The PortRange data type provides the lower and upper bounds of a range of Internet ports.
      It shall comply with the provisions defined in Table 6.5.3.42-1.
    type: object
    required:
      - lowerPort
      - upperPort
    properties:
      lowerPort:
        description: >
          Identifies the lower bound of the port range. upperPort Integer
        type: integer
        minimum: 0
      upperPort:
        description: >
          Identifies the upper bound of the port range.
        type: integer
        minimum: 0

  Mask:
    description: >
      The Mask data type identifies the value to be matched for a sequence of
      bits at a particular location in a frame. It shall
      comply with the provisions defined in Table 6.5.3.41-1.
    type: object
    required:
      - startingPoint
      - length
      - value
    properties:
      startingPoint:
        description: >
          Indicates the offset between the last bit of the source
          mac address and the first bit of the sequence of bits
          to be matched.
        type: integer
      length:
        description: >
          Indicates the number of bits to be matched.
        type: integer
      value:
        description: >
          Provide the sequence of bit values to be matched.
        type: string
4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000

  VnfSnapshotInfo:
    description: |
      This type represents an "Individual VNF snapshot" resource. The "id" attributed is used by the NFVO to index and
      identify the VNF snapshots information resources that are accessible via the NFVO. The identifier is still
      generated by the VNFM and copied into the present "VnfSnapshotInfo" representing the "Individual VNF snapshot"
      resource hold by the NFVO.
    type: object
    required:
      - id
    properties:
      id:
        description: >
          Identifier of the "Individual VNF snapshot" resource. This identifier is allocated by the VNFM.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfSnapshot:
        description: >
          Information about the VNF snapshot, content and/or references to its content. Shall be present when the
          "Individual VNF snapshot" resource is associated to a VNF snapshot on a VNFM, either 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. It shall comply with the provisions defined in table 6.5.2.18-1.
    type: object
    required:
      - id
      - vnfInstanceId
      - triggeredAt
      - createdAt
      - vnfdId
      - vnfInstance
      - vnfcSnapshots
    properties:
      id:
        description: >
          Identifier of the VNF snapshot. This identifier is allocated by the VNFM.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfInstanceId:
        description: >
          Identifier of the snapshotted VNF instance.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      triggeredAt:
        description: >
          Timestamp indicating when the VNF Snapshot creation has been started.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      createdAt:
        description: >
          Timestamp indicating when the VNF Snapshot has been created.
        $ref: "../../definitions/SOL005_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/SOL005_def.yaml#/definitions/Identifier"
      vnfInstance:
        description: >
          VNF instance information 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/SOL005_def.yaml#/definitions/KeyValuePairs"

  WanConnectionInfo:
    description: |
      This type provides information about the connectivity to the WAN of network resources realizing a VL, e.g.,
      when the VL is deployed on several sites across a WAN. It shall comply with the provisions defined in table 6.5.3.90-1.
    type: object
    required:
      - wanConnectionInfoId
    oneOf:
      - required:
          - nsVirtualLinkInfoId
      - required:
          - vnfVirtualLinkResourceInfoId
    properties:
      wanConnectionInfoId:
        description: >
          Identifies this WAN connection information.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      nsVirtualLinkInfoId:
        description: >
          References the NS VL instance to which the connection information is associated. Shall be present if a
          corresponding NS VL instance has been created.
          Either a "nsVirtualLinkInfoId" or a "vnfVirtualLinkResourceInfoId" shall be provided, but not both.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      vnfVirtualLinkResourceInfoId:
        description: >
          References the VNF VL instance to which the connection information is associated. Shall be present if a
          corresponding VNF VL instance has been created.
          Either a "nsVirtualLinkInfoId" or a "vnfVirtualLinkResourceInfoId" shall be provided, but not both.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      protocolInfo:
        description: >
          Protocol specific information for connecting to the WAN.
        $ref: "#/definitions/WanConnectionProtocolInfo"

  WanConnectionProtocolInfo:
    description: |
      This type provides protocol specific information about the connectivity to the WAN of network resources realizing
      a VL, e.g., when the VL is deployed on several sites and across a WAN, and the related multi-site connectivity
      service (MSCS) enabling the connectivity through the WAN. It shall comply with the provisions defined in table 6.5.3.91-1.
    type: object
    properties:
      mscsInfo:
        description: >
          Information about the provisioned MSCS, if already available.
        $ref: "#/definitions/MscsInfo"
      connectivityServiceEndpoints:
        description: >
          Configuration information about the network resources in the NFVI-PoP and their connectivity to the WAN.
        type: array
        items:
          $ref: "#/definitions/ConnectivityServiceEndpointInfo"

  NsLocationConstraint:
    description: |

    type: object

  WanConnectionData:
    description: |
      This type provides information used to connect the comprising network resources realizing a VL, e.g., when the VL
      is deployed on several sites and across a WAN. It shall comply with the provisions defined in table 6.5.3.80-1.
    type: object
    required:
      - protocolData
    oneOf:
      - required:
          - nsVirtualLink
      - required:
          - vnfVirtualLink
    properties:
      nsVirtualLink:
        description: >
          Information used to identify the NS VL for which the WAN connectivity data is applicable.
          Either a "nsVirtualLink" or a "vnfVirtualLink" shall be provided, but not both.
        type: object
        required:
          - nsVirtualLinkDescId
          - nsVirtualLinkProfileId
        properties:
          nsVirtualLinkDescId:
            description: >
              Identifier of the VLD in the NSD from which the VL is created in the case of a multi-site NS VL.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
          nsVirtualLinkProfileId:
            description: >
              Identifier of the VL profile in the NSD.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
      vnfVirtualLink:
        description: >
          Information used to identify the VNF VL for which the WAN connectivity data is applicable.
          Either a "nsVirtualLink" or a "vnfVirtualLink" shall be provided, but not both.
        type: object
        required:
          - vnfProfileId
          - vnfVirtualLinkDescId
          - vnfVirtualLinkProfileId
        properties:
          vnfProfileId:
            description: >
              Identifier of the VNF profile.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
          vnfVirtualLinkDescId:
            description: >
              Identifier of the VLD in the VNFD from which the VL is created in the case of a multi-site internal VNF VL.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
          vnfVirtualLinkProfileId:
            description: >
              Identifier of the VL profile in the VNFD.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      protocolData:
        description: >
          Protocol specific information for connecting to the WAN.
        $ref: "#/definitions/WanConnectionProtocolData"

  ChangeVnfPackageData:
    description: |
      This type specifies the information needed to change the current VNF package for a VNF instance. Clause B.3 of the
      ETSI GS NFV-IFA 007 illustrates the variants of changes to the current VNF Package and information flow procedures.
      This operation encompasses the following scenarios:
      *	Changes of the VNF virtualised resources, such as requirements, composition and structure between the VNF versions,
        without changing the VNF software version.
      *	Changes of both the VNF software version and the VNF virtualised resources. This case includes replacing the VNF
        software version by means of virtualised resources management, such as terminating the current virtualized resource
        instances running the current software version and instantiating new virtualized resource instances with the
        destination VNF software version. The new virtualized resource instances may have the same characteristics as the
        current virtualized resource instances.
      *	Changes related to the VNFD, such as correction of bugs in the VNFD, changes in the naming scheme of VNFD components
        (e.g. name of the VDU, vduId), and adding/removing descriptors of VNF Package changes (VnfPackageChangeInfo).
      NOTE:	For software updates that are executed by functional entities outside NFV-MANO and that require synchronization
            of the information held by the NFV-MANO entities with a new VNF package that reflects the same changes, an
            alternative procedure using the PATCH method on the "Individual VNF instance" resource has been defined, as
            illustrated in annex B.2 of ETSI GS NFV-IFA 007 [19]. This procedure assumes certain restrictions on the
            characteristics of the new VNF package, as defined in note 1 in table 5.5.2.2-1 of ETSI GS NFV-SOL 003.
      This type shall comply with the provisions defined in Table 6.5.3.54-1.
    type: object
    required:
      - vnfInstanceId
      - vnfdId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfdId:
        description: >
          Identifier of the VNFD which defines the destination VNF Package for the change.
        $ref: "../../definitions/SOL005_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/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by the NFVO.
        type: array
        items:
          $ref: "#/definitions/ExtManagedVirtualLinkData"
      additionalParams:
        description: >
          Additional parameters passed by the OSS/BSS as input to the change current VNF package process, specific to the
          VNF of which the underlying VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig".
        $ref: "../../definitions/SOL005_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 6.5.3.57. 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 of ETSI GS NFV-SOL 003.
        $ref: "../../definitions/SOL005_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 6.5.3.57. 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 of ETSI
          GS NFV-SOL 003.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  DeleteVnfSnapshotData:
    description: >
      This type specifies the identifier of information of an available VNF Snapshot to be deleted and the identifier of
      the related VNF instance of the NS instance. It shall comply with the provisions defined in Table 6.5.3.74-1.
    type: object
    required:
      - vnfInstanceId
      - vnfSnapshotInfoId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to identify the VNFM holding the VNF Snapshot information to be deleted.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfSnapshotInfoId:
        description: >
          Identifier of information held by the VNFM about the VNF Snapshot to be deleted.
          This identifier was allocated by the VNFM.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

  RevertVnfToSnapshotData:
    description: >
      This type specifies the identifier of an existing VNF instance of the NS instance to be reverted and the identifier
      of an existing VNF Snapshot to be reverted to. It shall comply with the provisions defined in Table 6.5.3.75-1.
    type: object
    required:
      - vnfInstanceId
      - vnfSnapshotInfoId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to identify the VNFM holding the VNF Snapshot information to be reverted.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfSnapshotInfoId:
        description: >
          Identifier of information held by the VNFM about the VNF Snapshot to be reverted.
          This identifier was allocated by the VNFM.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

  CreateVnfSnapshotData:
    description: >
      This type represents the information that are needed for VNF snapshot creation. When the NFVO invokes the Create
      VNF snapshot operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with
      the provisions defined in Table 6.5.3.76-1.
    type: object
    required:
      - vnfInstanceId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to perform the snapshot from.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      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/SOL005_def.yaml#/definitions/KeyValuePairs"
      userDefinedData:
        description: >
          User defined data for the VNF snapshot.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  VnfcSnapshotInfo:
    description: >
      This type represents a VNFC Snapshot. It shall comply with the provisions defined in table 6.5.3.77-1.
    type: object
    required:
      - id
      - vnfcInstanceId
      - triggeredAt
      - createdAt
      - vnfcInfoId
    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/SOL005_def.yaml#/definitions/Identifier"
      vnfcInstanceId:
        description: >
          Identifier of the snapshotted VNFC instance.
        $ref: "#/definitions/IdentifierInVnf"
      triggeredAt:
        description: >
          Timestamp indicating when the VNFC Snapshot creation has been started.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      createdAt:
        description: >
          Timestamp indicating when the VNFC Snapshot has been completed.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      vnfcInfoId:
        description: >
          Reference to the information of the snapshotted VNFC instance.
        $ref: "#/definitions/IdentifierInVnf"
      computeSnapshotResource:
        description: >
          Reference to a compute snapshot resource.
          The identifier of the compute snapshot resource is assigned during creation of a VNFC Snapshot being returned
          from the VIM as output data in the response message of the individual resource operations.
          This attribute shall only be present for a VNFC snapshot that has been newly created.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
      storageSnapshotResources:
        description: >
          Mapping of the storage resources associated to the VNFC with the storage snapshot resources.
        type: array
        items:
          type: object
          required:
            - storageResourceId
          properties:
            storageResourceId:
              description: >
                Reference to the virtual storage resource.
              $ref: "#/definitions/IdentifierInVnf"
            storageSnapshotResources: