SOL005NSLifecycleManagement_def.yaml

# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
  CreateNsRequest:
    type: object
    required:
      - nsdId
      - nsName
      - nsDescription
    properties:
      nsdId:
        description: >
          Identifier of the NSD that defines the NS instance to be
          created.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsName:
        description: >
          Human-readable name of the NS instance to be created.
        type: string
      nsDescription:
        description: >
          Human-readable description of the NS instance to be created.
        type: string

  NsInstance:
    description: >
      This type represents a response for Query NS operation. 
      It shall comply with the provisions defined in Table 6.5.2.10-1.
    type: object
    required:
      - id
      - nsInstanceName
      - nsInstanceDescription
      - nsdId
      - nsdInfoId
      - nsState
    properties:
      id:
        description: >
          Identifier of the NS instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsInstanceName:
        description: >
          Human readable name of the NS instance.
        type: string
      nsInstanceDescription:
        description: >
          Human readable description of the NS instance.
        type: string
      nsdId:
        description: >
          Identifier of the NSD on which the NS instance is based.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdInfoId:
        description: >
          Identifier of the NSD information object on which the
          NS instance is based. This identifier was allocated by the NFVO.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      flavourId:
        description: >
          Identifier of the NS deployment flavor applied to
          the NS instance. This attribute shall be present if the nsState attribute
          value is INSTANTIATED.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      vnfInstance:
        description: >
          Information on constituent VNF(s) of the NS instance.
        type: array
        items:
          $ref: "#/definitions/VnfInstance"
      pnfInfo:
        description: >
          Information on the PNF(s) that are part of the NS instance.
        type: array
        items:
          $ref: "#/definitions/PnfInfo"
      virtualLinkInfo:
        description: >
          Information on the VL(s) of the NS instance.
          This attribute shall be present if the nsState attribute
          value is INSTANTIATED and if the NS instance has
          specified connectivity.
        type: array
        items:
          $ref: "#/definitions/NsVirtualLinkInfo"
      vnffgInfo:
        description: >
          Information on the VNFFG(s) of the NS instance.
        type: array
        items:
          $ref: "#/definitions/VnffgInfo"
      sapInfo:
        description: >
          Information on the SAP(s) of the NS instance.
        type: array
        items:
          $ref: "#/definitions/SapInfo"
      nestedNsInstanceId:
        description: >
          Identifier of the nested NS(s) of the NS instance.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsState:
        description: >
          The state of the NS instance.
          Permitted values:
          NOT_INSTANTIATED: The NS instance is
          terminated or not instantiated.
          INSTANTIATED: The NS instance is instantiated.
        type: string
        enum:
          - NOT_INSTANTIATED
          - INSTANTIATED
      monitoringParameter:
        description: >
          Performance metrics tracked by the NFVO (e.g. for
          auto-scaling purposes) as identified by the NS
          designer in the NSD.
        type: array
        items:
          $ref: "#/definitions/NsMonitoringParameter"
      nsScaleStatus:
        description: >
          Status of each NS scaling aspect declared in the
          applicable DF, how "big" the NS instance has been
          scaled w.r.t. that aspect.
          This attribute shall be present if the nsState attribute
          value is INSTANTIATED.
        type: array
        items:
          $ref: "#/definitions/NsScaleInfo"
      additionalAffinityOrAntiAffinityRule:
        description: >
          Information on the additional affinity or anti-affinity
          rule from NS instantiation operation. Shall not
          conflict with rules already specified in the NSD.
        type: array
        items:
          $ref: "#/definitions/AffinityOrAntiAffinityRule"
      _links:
        type: object
        description: Links to resources related to this resource.
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL005_def.yaml#/definitions/Link"
          nestedNsInstances:
            description: >
              Links to resources related to this notification.
            type: array
            items:
              $ref: "SOL005_def.yaml#/definitions/Link"
          instantiate:
            description: >
              Link to the "instantiate" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance in
              NOT_INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          terminate:
            description: >
              Link to the "terminate" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          update:
            description: >
              Link to the "update" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          scale:
            description: >
              Link to the "scale" task resource, if the related
              operation is supported for this NS instance, and is
              possible based on the current status of this NS
              instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          heal:
            description: >
              Link to the "heal" task resource, if the related
              operation is supported for this NS instance, and is
              possible based on the current status of this NS
              instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"

  VnfInstance:
    description: >
      This type represents a VNF instance.
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - vnfPkgId
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
        $ref: "SOL005_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.
        $ref: "SOL005_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/Version"
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
        $ref: "#/definitions/Version"
      vnfPkgId:
        description: >
          Identifier of information held by the NFVO about
          the specific VNF package on which the VNF is
          based. This identifier was allocated by the NFVO.
          This attribute can be modified with the PATCH
          method.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      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. 
          This attribute can be modified with the PATCH method.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      vimId:
        description: >
          Identifier of a VIM that manages resources for the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      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 flavor applied to this VNF instance.
            $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
          vnfState:
            description: >
              The state of the VNF instance.
            $ref: "#/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/VnfScaleInfo"
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance.
            type: array
            minItems: 1
            items:
              type: object
              required:
                - id
                - cpdId
              properties:
                id:
                  description: >
                    Identifier of the external CP instance and the related information instance.
                  $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
                cpdId:
                  description: >
                    Identifier of the external CPD, VnfExtCpd, in the VNFD.
                  $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
                cpProtocolInfo:
                  description: >
                    Network protocol information for this CP.
                  type: array
                  items:
                    $ref: "#/definitions/CpProtocolInfo"
                extLinkPortId:
                  description: >
                    Identifier of the "extLinkPortInfo" structure inside the  the
                    "extVirtualLinkInfo" structure. Shall be present if the CP is
                    associated to a link port.
                  $ref: "SOL005_def.yaml#/definitions/Identifier"

          extVirtualLinkInfo:
            description: >
              Information about the external VLs the VNF instance is connected to.
            type: array
            items:
              $ref: "#/definitions/ExtVirtualLinkInfo"
          extManagedVirtualLinkInfo:
            description: >
              External virtual links the VNF instance is connected to.
            type: array
            items:
              $ref: "#/definitions/ExtManagedVirtualLinkInfo"
          monitoringParameters:
            description: >
              Active monitoring parameters.
            type: array
            items:
              $ref: "#/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/VnfVirtualLinkResourceInfo"
          virtualStorageResourceInfo:
            description: >
              Information on the virtualised storage resource(s) used as storage for the VNF instance.
            type: array
            items:
              $ref: "#/definitions/VirtualStorageResourceInfo"
      metadata:
        description: >
          Additional VNF-specific metadata describing the VNF instance.
          Metadata that are writeable are declared in the VNFD.
          This attribute can be modified with the PATCH method.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          VNF-specific attributes that affect the lifecycle management of this
          VNF instance by the VNFM, or the lifecycle management scripts.
          Extensions that are writeable are declared in the VNFD.
          This attribute can be modified with the PATCH method.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  LccnLinks:
    description: >
      This type represents the links to resources that a notification can contain.
    type: object
    required:
      - nsInstance
    properties:
      nsInstance:
        description: >
          Link to the resource representing the NS instance to
          which the notified change applies..
        $ref: "SOL005_def.yaml#/definitions/Link"
      subscription:
        description: >
          Link to the subscription that triggered this notification.
        $ref: "SOL005_def.yaml#/definitions/Link"
      lcOpOcc:
        description: >
          Link to the lifecycle operation occurrence that this
          notification is related to. Shall be present if there is a
          related lifecycle operation occurrence
        $ref: "SOL005_def.yaml#/definitions/Link"

  Version:
    description: >
      A Version.
    type: string

  VnfOperationalStateType:
    type: string
    enum:
      - STARTED
      - STOPPED

  VnfScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      scaleLevel:
        description: >
          Indicates the scale level. The minimum value shall be 0 and the
          maximum value shall be <= maxScaleLevel as described in the VNFD.
        type: integer

  PnfInfo:
    description: >
      This type represents the information about a PNF that is part of an NS instance. 
      It shall comply with the provisions
      defined in Table 6.5.3.13-1.
    type: object
    required:
      - pnfId
      - pnfdId
      - pnfdInfoId
      - pnfProfileId
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfName:
        description: >
          Name of the PNF.
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdInfoId:
        description: >
          Identifier of the PNFD information onject related to this
          PNF. This identifier is allocated by the NFVO
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfProfileId:
        description: >
          Identifier of the related PnfProfile in the NSD on which
          the PNF is based.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      cpInfo:
        description: >
          Information on the external CP of the PNF.
        $ref: "#/definitions/PnfExtCpInfo"

  PnfExtCpInfo:
    description: >
      This type represents the information about the external CP of the PNF. 
      It shall comply with the provisions defined in
      Table 6.5.3.17-1.
    type: object
    required:
      - cpInstanceId
      - cpdId
    properties:
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
      cpdId:
        description: >
          Identifier of (reference to) the Connection Point
          Descriptor (CPD) for this CP.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the CP.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/CpProtocolData"

  NsVirtualLinkInfo:
    description: >
      This type specifies the information about an NS VL instance. 
      It shall comply with the provisions defined in
      Table 6.5.3.53-1
    type: object
    required:
      - id
      - nsVirtualLinkDescId
    properties:
      id:
        description: >
          Identifier of the VL instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      resourceHandle:
        description: >
          Identifier(s) of the virtualised network resource(s)
          realizing the VL instance. See note.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      linkPort:
        description: >
          Link ports of the VL instance.
          Cardinality of zero indicates that no port has yet been
          created for the VL instance.
        type: array
        items:
          $ref: "#/definitions/NsLinkPortInfo"

  VnffgInfo:
    description: >
      Information on the VNFFG(s) of the NS instance.
    type: object
    required:
      - id
      - vnffgdId
      - vnfInstanceId
      - pnfInfoId
    properties:
      id:
        description: >
          Identifier of this VNFFG instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnffgdId:
        description: >
          Identifier of the VNFFGD in the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      vnfInstanceId:
        description: >
          Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdInfoId:
        description: >
          Identifier(s) of the constituent PNF instance(s) of this
          VNFFG instance.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsVirtualLinkInfoId:
        description: >
          Identifier(s) of the constituent VL instance(s) of this
          VNFFG instance.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      nsCpHandle:
        description: >
          Identifiers of the CP instances attached to the
          constituent VNFs and PNFs or the SAP instances of the
          VNFFG. See note.
        type: array
        items:
          $ref: "#/definitions/NsCpHandle"

  NsCpHandle:
    description: >
      This type represents an identifier of the CP or SAP instance. 
      It shall comply with the provisions defined in
      Table 6.5.3.56-1.
    type: object
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance associated to the CP instance.
          This attribute shall be present if the CP instance is VNF external CP.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfExtCpInstanceId:
        description: >
          Identifier of the VNF external CP instance in the scope
          of the VNF instance. This attribute shall be present if the CP instance is VNF
          external CP. See notes 1 and 4.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      pnfInfoId:
        description: >
          Identifier of the PNF instance associated to the CP
          instance. This attribute shall be present if the CP instance is PNF
          external CP. See notes 2 and 4.          
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfExtCpInstanceId:
        description: >
          Identifier of the PNF external CP instance in the scope
          of the PNF. This attribute shall be present if the CP instance is PNF
          external CP. See notes 2 and 4.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
      nsInstanceId:
        description: >
          Identifier of the NS instance associated to the SAP
          instance. This attribute shall be present if the CP instance is NS
          SAP. See notes 3 and 4.           
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsSapInstanceId:
        description: >
          Identifier of the SAP instance in the scope of the NS
          instance. This attribute shall be present if the CP instance is NS
          SAP. See notes 3 and 4.           
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"

  SapInfo:
    description: >
      This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.
    type: object
    required:
      - id
      - sapdId
      - sapName
      - sapProtocolInfo
    properties:
      id:
        description: >
          Identifier of the SAP instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      sapdId:
        description: >
          Identifier of the SAPD in the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      sapName:
        description: >
          Human readable name for the SAP instance.
        type: string
      description:
        description: >
          Human readable description for the SAP instance.
        type: string
      sapProtocolInfo:
        description: >
          Network protocol information for this SAP.
        type: array
        items:
          $ref: "#/definitions/CpProtocolInfo"

  CpProtocolInfo:
    description: >
      This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like
      addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.
    type: object
    required:
      - layerProtocol
      - ipOverEthernet
    properties:
      layerProtocol:
        description: >
          The identifier of layer(s) and protocol(s)
          associated to the network address information.
          Permitted values: IP_OVER_ETHERNET See note.
        type: string
        enum:
          - IP_OVER_ETHERNET
      ipOverEthernet:
        description: >
          IP addresses over Ethernet to assign to the CP
          or SAP instance. Shall be present if
          layerProtocol is equal to "
          IP_OVER_ETHERNET", and shall be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressInfo"

  IpOverEthernetAddressInfo:
    description: >
      This type represents information about a network address that has been assigned.
      It shall comply with the provisions defined in Table 6.5.3.18-1.
    type: object
    required:
      - macAddress
      - ipAddresses
      - subnetId
      - addresses
      - addressRange
    properties:
      macAddress:
        description: >
          Assigned MAC address.
        $ref: "SOL005_def.yaml#/definitions/MacAddress"
      ipAddresses:
        description: >
          Addresses assigned to the CP instance. Each entry represents IP
          addresses assigned by fixed or dynamic IP address assignment per
          subnet.
        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
            addresses:
              description: >
                Fixed addresses assigned (from the subnet defined by
                "subnetId" if provided).
              type: array
              items:
                $ref: "SOL005_def.yaml#/definitions/IpAddress"
            isDynamic:
              description: >
                Indicates whether this set of addresses was assigned
                dynamically (true) or based on address information provided as
                input from the API consumer (false). Shall be present if
                "addresses" is present and shall be absent otherwise.
              type: boolean
            addressRange:
              description: >
                An IP address range used, e.g., in case of egress connections.
                Exactly one of "addresses" or "addressRange" shall be present.
              type: object
              required:
                - minAddress
                - maxAddress
              properties:
                minAddress:
                  description: >
                    Lowest IP address belonging to the range.
                  $ref: "SOL005_def.yaml#/definitions/IpAddress"
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
                  $ref: "SOL005_def.yaml#/definitions/IpAddress"
            subnetId:
              description: >
                Subnet defined by the identifier of the subnet resource in
                the VIM.
                In case this attribute is present, IP addresses are bound
                to that subnet.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVim"


      type:
        description: >
          The type of the IP addresses
        type: string
        enum:
          - PV4
          - PV6
      addresses:
        description: >
          Fixed addresses assigned (from the subnet
          defined by "subnetId" if provided). See note.
        type: array
        items:
        $ref: "SOL005_def.yaml#/definitions/IpAddress"
      isDynamic:
        description: >
          Indicates whether this set of addresses was
          assigned dynamically (true) or based on address
          information provided as input from the API
          consumer (false). Shall be present if "addresses"
          is present and shall be absent otherwise.
        type: boolean
      addressRange:
        description: >
          An IP address range used, e.g. in case of egress
          connections. See note.
        type: object
        required:
          - minAddress
          - maxAddress
        properties:
          minAddress:
            description: >
              Lowest IP address belonging to the range.
            $ref: "SOL005_def.yaml#/definitions/IpAddress"
          maxAddress:
            description: >
              Highest IP address belonging to the range
            $ref: "SOL005_def.yaml#/definitions/IpAddress"
      minAddress:
        description: >
          Lowest IP address belonging to the range
        $ref: "SOL005_def.yaml#/definitions/IpAddress"
      maxAddress:
        description: >
          Highest IP address belonging to the range.
        $ref: "SOL005_def.yaml#/definitions/IpAddress"
      subnetId:
        description: >
          Subnet defined by the identifier of the subnet
          resource in the VIM.
          In case this attribute is present, IP addresses
          are bound to that subnet.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVim"

  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of the external VL and the related external VL
          information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"

  ExtLinkPortInfo:
    description: >
      This type represents information about a link port of an external VL,
      i.e. a port providing connectivity for the VNF to an NS 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: "SOL005_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
        description: >
          Identifier of the external CP of the VNF connected to this link
          port. There shall be at most one link port associated with any
          external connection point instance. The value refers to an
          "extCpInfo" item in the VnfInstance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"

  ExtManagedVirtualLinkInfo:
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
    properties:
      id:
        description: >
          Identifier of the externally-managed internal VL and the related
          externally-managed VL information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"

  VnfLinkPortInfo:
    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: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      resourceHandle:
        description: >
          Reference to the virtualised network resource realizing this link port.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
        description: >
          When the link port is used for external connectivity by the VNF,
          this attribute represents the identifier of the external CP of the
          VNF to be connected to this link port.
          When the link port is used for internal connectivity in the VNF,
          this attribute represents the VNFC CP to be connected to this link
          port.
          Shall be present when the link port is used for external
          connectivity by the VNF.
          may be present if used to reference a VNFC CP instance.
          There shall be at most one link port associated with any external
          connection point instance or internal connection point
          (i.e. VNFC CP) instance.
          The value refers to an "extCpInfo" item in the VnfInstance or a
          "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"

  MonitoringParameter:
    type: object
    required:
      - id
      - value
      - timeStamp
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the VNFD.
        type: string
      value:
        description: >
          Value of the monitoring parameter known to the VNFM (e.g. obtained
          for auto-scaling purposes).
          The type of the "value" attribute (i.e. scalar, structure (Object in
          JSON), or array (of scalars, arrays or structures/Objects)) is
          assumed to be defined in an external measurement specification.
        type: object
      timeStamp:
        description: >
          Represents the point in time when the measurement has been performed,
          as known to the VNFM.
          Should be formatted according to ETF RFC 3339.
        type: string

  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: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      storageResourceIds:
        description: >
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfcCpInfo:
        description: >
          CPs of the VNFC instance.
          Shall be present when that particular CP of the VNFC instance is
          associated to an external CP of the VNF instance.
          May be present otherwise.
        type: array
        items:
          type: object
          required:
            - id
            - cpdId
          properties:
            id:
              description: >
                Identifier of this VNFC CP instance and the associated array
                entry.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
            vnfExtCpId:
              description: >
                When the VNFC CP is exposed as external CP of the VNF, the
                identifier of this external VNF CP.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
            cpProtocolInfo:
              description: >
                Network protocol information for this CP.
              type: array
              items:
                $ref: "#/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.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  VnfVirtualLinkResourceInfo:
    description: >
      This type represents the information that allows addressing a virtualised
      resource that is used by an internal VL instance in a VNF instance.
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
      - networkResource
    properties:
      id:
        description: >
          Identifier of this VnfVirtualLinkResourceInfo instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfLinkPorts:
        description: >
          Links ports of this VL.
          Shall be present when the linkPort is used for external connectivity
          by the VNF (refer to VnfLinkPortInfo).
          May be present otherwise.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  VirtualStorageResourceInfo:
    description: >
      This type represents the information that allows addressing a virtualised
      resource that is used by a VNF instance.
    type: object
    required:
      - id
      - virtualStorageDescId
      - storageResource
    properties:
      id:
        description: >
          Identifier of this VirtualStorageResourceInfo instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      virtualStorageDescId:
        description: >
          Identifier of the VirtualStorageDesc in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      storageResource:
        description: >
          Reference to the VirtualStorage resource.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  NsLinkPortInfo:
    description: >
      This type represents information about a link port of a VL instance.
      It shall comply with the provisions defined in Table 6.5.3.55-1.
    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: "SOL005_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Identifier of the virtualised network resource realizing
          this link port.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      nsCpHandle:
        description: >
          Identifier of the CP/SAP instance to be connected to this
          link port. The value refers to a vnfExtCpInfo item in the
          VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a
          sapInfo item in the NS instance.
          There shall be at most one link port associated with any
          connection point instance.
        type: array
        items:
          $ref: "#/definitions/NsCpHandle"

  AffinityOrAntiAffinityRule:
    description: >
      This type describes the additional affinity or anti-affinity rule
      applicable between the VNF instances to be instantiated
      in the NS instantiation operation request or between the VNF instances
      to be instantiated in the NS instantiation
      operation request and the existing VNF instances..
    type: object
    required:
      - affinityOrAntiAffiinty
      - scope
    properties:
      vnfdId:
        description: >
          Reference to a VNFD.
          When the VNFD which is not used to instantiate VNF, it
          presents all VNF instances of this type as the subjects
          of the affinity or anti-affinity rule. The VNF instance
          which the VNFD presents is not necessary as a part of
          the NS to be instantiated.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfProfileId:
        description: >
          Reference to a vnfProfile defined in the NSD.
          At least one VnfProfile which is used to instantiate VNF
          for the NS to be instantiated as the subject of the affinity
          or anti-affinity rule shall be present. When the VnfProfile
          which is not used to instantiate VNF, it presents all VNF
          instances of this type as the subjects of the affinity or
          anti-affinity rule. The VNF instance which the VnfProfile
          presents is not necessary as a part of the NS to be instantiated.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      vnfInstanceId:
        description: >
          Reference to the existing VNF instance as the subject of
          the affinity or anti-affinity rule. The existing VNF instance
          is not necessary as a part of the NS to be instantiated.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      affinityOrAntiAffiinty:
        description: >
          The type of the constraint.
          Permitted values:
          AFFINITY
          ANTI_AFFINITY.
        type: string
        enum:
          - AFFINITY
          - ANTI_AFFINITY
      scope:
        description: >
          Specifies the scope of the rule where the placement
          constraint applies.
          Permitted values:
          NFVI_POP
          ZONE
          ZONE_GROUP
          NFVI_NODE.
        type: string
        enum:
          - NFVI_POP
          - ZONE
          - ZONE_GROUP
          - NFVI_NODE

  InstantiateNsRequest:
    type: object
    required:
      - nsFlavourId
    properties:
      nsFlavourId:
        description: >
          Identifier of the NS deployment flavor to be instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      sapData:
        description: >
          Create data concerning the SAPs of this NS.
        type: array
        items:
          $ref: "#/definitions/SapData"
      addpnfData:
        description: >
          Information on the PNF(s) that are part of this NS.
        type: array
        items:
          $ref: "#/definitions/AddPnfData"
      vnfInstanceData:
        description: >
          Specify an existing VNF instance to be used in the NS.
          If needed, the VNF Profile to be used for this VNF
          instance is also provided.
          The DF of the VNF instance shall match the VNF DF 
          present in the associated VNF Profile.
        type: array
        items:
          $ref: "#/definitions/VnfInstanceData"
      nestedNsInstanceData:
        description: >
          Specify an existing NS instance to be used as a nested
          NS within the NS.
          If needed, the NS Profile to be used for this nested NS 
          instance is also provided.
          NOTE 2: The NS DF of each nested NS shall be one of the 
          allowed flavours in the associated NSD (as referenced in the
          nestedNsd attribute of the NSD of the NS to be instantiated).
          NOTE 3: The NSD of each referenced NSs (i.e. each 
          nestedInstanceId) shall match the one of the nested NSD in 
          the composite NSD.
        type: array
        items:
          $ref: "#/definitions/NestedNsInstanceData"
      localizationLanguage:
        description: >
          Defines the location constraints for the VNF to be
          instantiated as part of the NS instantiation.
          An example can be a constraint for the VNF to be in a
          specific geographic location..
        type: array
        items:
          $ref: "#/definitions/VnfLocationConstraint"
      additionalParamsForNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
          at the composite NS level (as opposed to the VNF level, 
          which is covered in additionalParamsForVnf), and as 
          opposed to the nested NS level, which is covered in
          additionalParamForNestedNs.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      additionalParamForNestedNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
          per nested NS instance (as opposed to the composite NS
          level, which is covered in additionalParamForNs, and as
          opposed to the VNF level, which is covered in
          additionalParamForVnf). This is for nested NS instances
          that are to be created by the NFVO as part of the NS
          instantiation and not for existing nested NS instances that
          are referenced for reuse.
        type: array
        items:
          $ref: "#/definitions/ParamsForNestedNs"
      additionalParamsForVnf:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
          per VNF instance (as opposed to the composite NS level, 
          which is covered in additionalParamsForNs and as opposed 
          to the nested NS level, which is covered in 
          additionalParamForNestedNs). This is for VNFs that are 
          to be created by the NFVO as part of the NS instantiation 
          and not for existing VNF that are referenced for reuse.
        type: array
        items:
          $ref: "#/definitions/ParamsForVnf"
      startTime:
        description: >
          Timestamp indicating the earliest time to instantiate the NS. 
          Cardinality "0" indicates the NS instantiation takes place immediately.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      nsInstantiationLevelId:
        description: >
          Identifies one of the NS instantiation levels declared in
          the DF applicable to this NS instance. If not present, the
          default NS instantiation level as declared in the NSD
          shall be used.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      additionalAffinityOrAntiAffinityRule:
        description: >
          Specifies additional affinity or anti-affinity constraint for
          the VNF instances to be instantiated as part of the NS
          instantiation.
          Shall not conflict with rules already specified in the NSD.
        type: array
        items:
          $ref: "#/definitions/AffinityOrAntiAffinityRule"

  ParamsForVnf:
    description: >
      This type defines the additional parameters for the VNF instance
      to be created associated with an NS instance.
      It shall comply with the provisions defined in Table 6.5.3.22-1.
    type: object
    required:
      - vnfProfileId
    properties:
      vnfProfileId:
        description: >
          Identifier of (reference to) a vnfProfile to which the
          additional parameters apply.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      additionalParams:
        description: >
          Additional parameters that are applied for the VNF
          instance to be created.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  LocationConstraints:
    description: >
      This type represents location constraints for a VNF to be instantiated.
      The location constraints shall be presented as a
      country code, optionally followed by a civic address based on
      the format defined by IETF RFC 4776 [13].
    type: object
    required:
      - countryCode
    properties:
      countryCode:
        description: >
          The two-letter ISO 3166 [29] country code in capital letters.
        type: string
      civicAddressElement:
        description: >
          Zero or more elements comprising the civic address.
        type: array
        items:
          type: object
          required:
            - caType
            - caValue
          properties:
            caType:
              description: >
                Describe the content type of caValue. The value of
                caType shall comply with Section 3.4 of IETF
                RFC 4776 [13].
              type: integer
            caValue:
              description: >
                Content of civic address element corresponding to the
                caType. The format caValue shall comply with
                Section 3.4 of IETF RFC 4776 [13].
              type: string

  VnfLocationConstraint:
    description: >
      This type represents the association of location constraints to a VNF instance
      to be created according to a specific VNF profile.
      It shall comply with the provisions defined in Table 6.5.3.20-1.
    type: object
    required:
      - vnfProfileId
    properties:
      vnfProfileId:
        description: >
          Identifier of (reference to) a vnfProfile to which the
          additional parameters apply.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      locationConstraints:
        description: >
          Defines the location constraints for the VNF instance to
          be created based on the VNF profile.
        $ref: "#/definitions/LocationConstraints"

  VnfInstanceData:
    description: >
      This type specifies an existing VNF instance to be used in the NS instance and
      if needed, the VNF Profile to use for this VNF instance.
      It shall comply with the provisions defined in Table 6.5.3.19-1.
    type: object
    required:
      - vnfInstanceId
      - vnfProfileId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the existing VNF instance to be used in the NS.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfProfileId:
        description: >
          Identifier of (Reference to) a vnfProfile defined in the
          NSD which the existing VNF instance shall be matched
          with. If not present, the NFVO will select the VnfProfile
          matching the information in the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"

  SapData:
    description: >
      This type represents the information related to a SAP of a NS.
      It shall comply with the provisions defined in Table 6.5.3.10-1.
    type: object
    required:
      - sapdId
      - sapName
      - description
    properties:
      sapdId:
        description: >
          Reference to the SAPD for this SAP.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      sapName:
        description: >
          Human readable name for the SAP.
        type: string
      description:
        description: >
          Human readable description for the SAP.
        type: string
      sapProtocolData:
        description: >
          Parameters for configuring the network protocols on the SAP.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/CpProtocolData"

  ScaleNsRequest:
    description: >
      This type represents a request for the scale NS operation.
    type: object
    required:
      - scaleType
    properties:
      scaleType:
        description: >
          Indicates the type of scaling to be performed.
          Possible values:
          - SCALE_NS
          - SCALE_VNF
        type: string
        enum:
          - SCALE_NS
          - SCALE_VNF
      scaleNsData:
        description: >
          The necessary information to scale the referenced NS instance.
          It shall be present when scaleType = SCALE_NS.
        $ref: "#/definitions/ScaleNsData"
      scaleVnfData:
        description: >
          The necessary information to scale the referenced NS instance.
          It shall be present when scaleType = SCALE_VNF.
        type: array
        items:
          $ref: "#/definitions/ScaleVnfData"
      scaleTime:
        description: >
          Timestamp indicating the scale time of the NS, i.e. the
          NS will be scaled at this timestamp. Cardinality "0"
          indicates the NS scaling takes place immediately".
        $ref: "SOL005_def.yaml#/definitions/DateTime"

  UpdateNsRequest:
    description: >
      This operation supports the update of a NS instance, 
      It shall comply with the provisions defined in Table 6.5.2.12-1.
    type: object
    required:
      - updateType
    properties:
      updateType:
        description: >
          The type of update. It determines also which one of the
          following parameters is present in the operation.
          Possible values include:
          * ADD_VNF: Adding existing VNF instance(s)
          * REMOVE_VNF: Removing VNF instance(s)
          * INSTANTIATE_VNF: Instantiating new VNF(s)
          * CHANGE_VNF_DF: Changing VNF DF
          * OPERATE_VNF: Changing VNF state,
          * MODIFY_VNF_INFORMATION: Modifying
          VNF information and/or the configurable
          properties of VNF instance(s)
          * CHANGE_EXTERNAL_VNF_CONNECTIVITY:
          Changing the external connectivity of VNF
          instance(s)ADD_SAP: Adding SAP(s)
          * REMOVE_SAP: Removing SAP(s)
          * ADD_NESTED_NS: Adding existing NS
          instance(s) as nested NS(s)
          * REMOVE_NESTED_NS: Removing existing
          nested NS instance(s)
          * ASSOC_NEW_NSD_VERSION: Associating a
          new NSD version to the NS instance
          * MOVE_VNF: Moving VNF instance(s) from one
          origin NS instance to another target NS
          instance
          * ADD_VNFFG: Adding VNFFG(s)
          * REMOVE_VNFFG: Removing VNFFG(s)
          * UPDATE_VNFFG: Updating VNFFG(s)
          * CHANGE_NS_DF: Changing NS DF
          * ADD_PNF: Adding PNF
          * MODIFY_PNF: Modifying PNF
          * REMOVE_PNF: Removing PNF
        type: string
        enum:
          - ADD_VNF
          - REMOVE_VNF
          - INSTANTIATE_VNF
          - CHANGE_VNF_DF
          - OPERATE_VNF
          - MODIFY_VNF_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
          - REMOVE_SAP
          - ADD_NESTED_NS
          - REMOVE_NESTED_NS
          - ASSOC_NEW_NSD_VERSION
          - MOVE_VNF
          - ADD_VNFFG
          - REMOVE_VNFFG
          - UPDATE_VNFFG
          - CHANGE_NS_DF
          - ADD_PNF
          - MODIFY_PNF
          - REMOVE_PNF
      addVnfIstance:
        description: >
          Identifies an existing VNF instance to be added to the
          NS instance. It shall be present only if updateType = "ADD_VNF".         
        type: array
        items:
          $ref: "#/definitions/VnfInstanceData"
      removeVnfInstanceId:
        description: >
          Identifies an existing VNF instance to be removed from
          the NS instance. It contains the identifier(s) of the VNF
          instances to be removed. It shall be present only if
          updateType = "REMOVE_VNF." Note: If a VNF instance
          is removed from a NS and this NS was the last one for
          which this VNF instance was a part, the VNF instance is
          terminated by the NFVO.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      instantiateVnfData:
        description: >
          Identifies the new VNF to be instantiated. It can be used
          e.g. for the bottom-up NS creation. It shall be present
          only if updateType = "INSTANTIATE_VNF".
        type: array
        items:
          $ref: "#/definitions/InstantiateVnfData"
      changeVnfFlavourData:
        description: >
          Identifies the new DF of the VNF instance to be
          changed to. It shall be present only if updateType = "CHANGE_VNF_DF".
        type: array
        items:
          $ref: "#/definitions/ChangeVnfFlavourData"
      operateVnfData:
        description: >
          Identifies the state of the VNF instance to be changed. 
          It shall be present only if updateType = "OPERATE_VNF".
        type: array
        items:
          $ref: "#/definitions/OperateVnfData"
      modifyVnfInfoData:
        description: >
          Identifies the VNF information parameters and/or the
          configurable properties of VNF instance to be modified.
          It shall be present only if updateType = "MODIFY_VNF_INFORMATION".
        type: array
        items:
          $ref: "#/definitions/ModifyVnfInfoData"
      changeExtVnfConnectivityData:
        description: >
          Specifies the new external connectivity data of the VNF
          instance to be changed. It shall be present only if
          updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY".
        type: array
        items:
          $ref: "#/definitions/ChangeExtVnfConnectivityData"
      addSap:
        description: >
          Identifies a new SAP to be added to the NS instance.
          It shall be present only if updateType = "ADD_SAP."
        type: array
        items:
          $ref: "#/definitions/SapData"
      removeSapId:
        description: >
          The identifier an existing SAP to be removed from the
          NS instance. It shall be present only if updateType = "REMOVE_SAP."
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      addNestedNsData:
        description: >
          The identifier of an existing nested NS instance to be
          added to (nested within) the NS instance. It shall be
          present only if updateType = "ADD_NESTED_NS".
        type: array
        items:
          $ref: "#/definitions/NestedNsInstanceData"
      removeNestedNsId:
        description: >
          The identifier of an existing nested NS instance to be
          removed from the NS instance. It shall be present only if
          updateType = "REMOVE_NESTED_NS".
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      assocNewNsdVersionData:
        description: >
          Specify the new NSD to be used for the NS instance. It
          shall be present only if updateType =
          ASSOC_NEW_NSD_VERSION".
        $ref: "#/definitions/AssocNewNsdVersionData"
      moveVnfInstanceData:
        description: >
          Specify existing VNF instance to be moved from one NS
          instance to another NS instance. It shall be present only
          if updateType = MOVE_VNF".
        type: array
        items:
          $ref: "#/definitions/MoveVnfInstanceData"
      addVnffg:
        description: >
          Specify the new VNFFG to be created to the NS
          Instance. It shall be present only if updateType =
          "ADD_VNFFG".
        type: array
        items:
          $ref: "#/definitions/AddVnffgData"
      removeVnffgId:
        description: >
          Identifier of an existing VNFFG to be removed from the
          NS Instance. It shall be present only if updateType =
          "REMOVE_VNFFG".
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      updateVnffg:
        description: >
          Specify the new VNFFG Information data to be updated
          for a VNFFG of the NS Instance. It shall be present only
          if updateType = "UPDATE_VNFFG".
        type: array
        items:
          $ref: "#/definitions/UpdateVnffgData"
      changeNsFlavourData:
        description: >
          Specifies the new DF to be applied to the NS instance. It
          shall be present only if updateType =
          "CHANGE_NS_DF".
        $ref: "#/definitions/ChangeNsFlavourData"
      addPnfData:
        description: >
          specifies the PNF to be added into the NS instance. 
          It shall be present only if updateType = "ADD_PNF".
        type: array
        items:
          $ref: "#/definitions/AddPnfData"
      modifyPnfData:
        description: >
          Specifies the PNF to be modified in the NS instance. 
          It shall be present only if updateType = "MODIFY_PNF".
        type: array
        items:
          $ref: "#/definitions/ModifyPnfData"
      removePnfId:
        description: >
          Identifier of the PNF to be deleted from the NS instance.
          It shall be present only if updateType = "REMOVE_PNF".
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      updateTime:
        description: >
          Timestamp indicating the update time of the NS, i.e. the
          NS will be updated at this timestamp. Cardinality "0"
          indicates the NS update takes place immediately.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
  InstantiateVnfData:
    description: >
      This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the
      parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when
      the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF
      update 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.24-1.
    type: object
    required:
      - vnfdId
      - vnfFlavourId
    properties:
      vnfdId:
        description: >
          Information sufficient to identify the VNFD which defines
          the VNF to be instantiated.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      vnfInstantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment
          flavor to be instantiated. If not present, the default
          instantiation level as declared in the VNFD is
          instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      vnfInstanceName:
        description: >
          Human-readable name of the VNF instance to be created.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance to be created.
        type: string
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by other entities than the VNFM.
        type: array
        items:
          $ref: "SOL005_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 [16].
        type: string
      additionalParams:
        description: >
          Additional input parameters for the instantiation process,
          specific to the VNF being instantiated.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  ChangeVnfFlavourData:
    description: >
      The type represents the information that is requested to be changed
      deployment flavor for an existing VNF instance.
      It shall comply with the provisions defined in Table 6.5.3.25-1.
    type: object
    required:
      - vnfInstanceId
      - newFlavourId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to be modified.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      newFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment
          flavor to be instantiated. If not present, the default
          instantiation level as declared in the VNFD is
          instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          information about internal VLs that are managed by NFVO.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData"
      additionalParams:
        description: >
          Additional input parameters for the flavor change
          process, specific to the VNF being modified, as declared
          in the VNFD as part of "ChangeVnfFlavourOpConfig".
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  OperateVnfData:
    description: >
      This type represents a VNF instance for which the operational state 
      needs to be changed and the requested new state. It
      shall comply with the provisions defined in Table 6.5.3.31-1.
    type: object
    required:
      - vnfInstanceId
      - changeStateTo
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      changeStateTo:
        description: >
          The desired operational state (i.e. started or stopped)
          to change the VNF to.
        $ref: "#/definitions/OperationalStates"
      stopType:
        description: >
          It signals whether forceful or graceful stop is requested.           
        $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.
        type: integer

  OperationalStates:
    description: >
      STARTED - The VNF instance is up and running.
      STOPPED - The VNF instance has been shut down.
    type: string
    enum:
      - STARTED
      - STOPPED
  StopType:
    description: >
      * FORCEFUL: The VNFM will stop the VNF immediately after accepting the
        request.
      * GRACEFUL: The VNFM will first arrange to take the VNF 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.
    type: string
    enum:
      - FORCEFUL
      - GRACEFUL

  ModifyVnfInfoData:
    description: >
      This type represents the information that is requested to be modified for a VNF instance. The information to be
      modified shall comply with the associated NSD.
      EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that
      matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.
    type: object
    required:
      - vnfInstanceId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      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
      vnfPkgId:
        description: >
          New value of the "vnfPkgId" attribute in "VnfInstance".
          The value "null" is not permitted
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfConfigurableProperties:
        description: >
          Modifications to entries in the
          "vnfConfigurableProperties" list, as defined below this Table.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      Metadata:
        description: >
          Modifications to entries in the "metadata" list, as
          defined below this Table.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      Extensions:
        description: >
          Modifications to entries in the "extensions" list, as
          defined below this Table.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  ChangeExtVnfConnectivityData:
    description: >
      This type describes the information invoked by the NFVO to change the external VNF connectivity information
      maintained by the VNFM. The types of changes that this operation supports are:
      1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different
      external VL.
      2) Change the connectivity parameters of the existing external CPs, including changing addresses.
      NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP
      address assignment) might not be supported without deleting the resource and creating another one with
      the modified configuration.
      This type shall comply with the provisions defined in Table 6.5.3.33-1.
    type: object
    required:
      - vnfInstanceId
      - extVirtualLink
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      extVirtualLink:
        description: >
          Information about external VLs to change (e.g. connect the VNF to).
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
      additionalParams:
        description: >
          Additional parameters passed by the OSS as input to
          the external connectivity change process, specific to the
          VNF instance being changed.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  AssocNewNsdVersionData:
    description: >
      This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with
      updateType = "AssocNewNsdVersion", the NFVO shall use the referred NSD as a basis for the given NS instance.
      Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the
      nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the
      NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This
      data type shall comply with the provisions defined in Table 6.5.3.34-1.
    type: object
    required:
      - newNsdId
    properties:
      newNsdId:
        description: >
          Identifier of the new NSD version that is to be
          associated to the NS instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      sync:
        description: >
          Specify whether the NS instance shall be automatically
          synchronized to the new NSD by the NFVO (in case of