SOL005NSLifecycleManagement_def.yaml

          Match particular LCM operation status values
          as reported in notifications of type
          NsChangeNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsChangeNotification", and shall be absent otherwise.
        type: array
        items:
          $ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"

  NsScaleInfo:
    description: >
      This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor.
    type: object
    required:
      - nsScalingAspectId
      - nsScaleLevelId
    properties:
      nsScalingAspectId:
        description: >
          Identifier of the NS scaling aspect.
        $ref: "#/definitions/IdentifierInNsd"
      nsScaleLevelId:
        description: >
          Identifier of the NS scale level.
        $ref: "#/definitions/IdentifierInNsd"

  ScaleNsData:
    description: >
      This type represents the information to scale a NS.
    type: object
    properties:
      vnfInstanceToBeAdded:
        description: >
          An existing VNF instance to be added to the NS
          instance as part of the scaling operation. If
          needed, the VNF Profile to be used for this VNF
          instance may also be provided.
        type: array
        items:
          $ref: "#/definitions/VnfInstanceData"
      vnfInstanceToBeRemoved:
        description: >
          The VNF instance to be removed from the NS
          instance as part of the scaling operation.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      scaleNsByStepsData:
        description: >
          The information used to scale an NS instance by
          one or more scaling steps.
        $ref: "#/definitions/ScaleNsByStepsData"
      scaleNsToLevelData:
        description: >
          The information used to scale an NS instance to a target size.
        $ref: "#/definitions/ScaleNsToLevelData"
      additionalParamsForNs:
        description: >
          Allows the OSS/BSS to provide additional
          parameter(s) at the NS level necessary for the
          NS scaling (as opposed to the VNF level, which is
          covered in additionalParamsForVnf).
        $ref: "#/definitions/ParamsForVnf"
      additionalParamsForVnf:
        description: >
          Allows the OSS/BSS to provide additional
          parameter(s) per VNF instance (as opposed to
          the NS level, which is covered in
          additionalParamsforNs). This is for VNFs that are
          to be created by the NFVO as part of the NS
          scaling and not for existing VNF that are covered
          by the scaleVnfData.
        type: array
        items:
          $ref: "#/definitions/ParamsForVnf"
      locationConstraints:
        description: >
          The location constraints for the VNF to be
          instantiated as part of the NS scaling.
          An example can be a constraint for the VNF to be
          in a specific geographic location.
        type: array
        items:
          $ref: "#/definitions/VnfLocationConstraint"
      nestedNslocationConstraints:
        description: >
          Defines the location constraints for the nested NS to be instantiated as part of the NS instantiation.
          An example can be a constraint for the nested NS to be in a specific geographic location.
        type: array
        items:
          $ref: "#/definitions/NestedNsLocationConstraint"

  ScaleVnfData:
    description: >
      This type represents defines the information to scale a VNF instance 
      to a given level, or to scale a VNF instance by steps.
    type: object
    required:
      - vnfInstanceId
      - scaleVnfType
    oneOf:
      - required:
          - scaleToLevelData
      - required:
          - scaleByStepData
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance being scaled.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      scaleVnfType:
        description: >
          Type of the scale VNF operation requested.
          Allowed values are:
          - SCALE_OUT
          - SCALE_IN
          - SCALE_TO_INSTANTIATION_LEVEL
          - SCALE_TO_SCALE_LEVEL(S)
          The set of types actually supported depends on the
          capabilities of the VNF being managed.
        type: string
        enum:
          - SCALE_OUT
          - SCALE_IN
          - SCALE_TO_INSTANTIATION_LEVEL
          - SCALE_TO_SCALE_LEVEL(S)
      scaleToLevelData:
        description: >
          The information used for scaling to a given level.
        $ref: "#/definitions/ScaleToLevelData"
      scaleByStepData:
        description: >
          The information used for scaling by steps.
        $ref: "#/definitions/ScaleByStepData"

  ScaleNsByStepsData:
    description: >
      This type represents the information used to scale an NS instance by one or more scaling steps, with respect to a
      particular NS scaling aspect. Performing a scaling step means increasing/decreasing the capacity of an NS instance in a
      discrete manner, i.e. moving from one NS scale level to another. The NS scaling aspects and their corresponding NS
      scale levels applicable to the NS instance are declared in the NSD.
    type: object
    required:
      - scalingDirection
      - aspectId
    properties:
      scalingDirection:
        description: >
          The scaling direction. Possible values are:
          - SCALE_IN
          - SCALE_OUT.
        type: string
        enum:
          - SCALE_IN
          - SCALE_OUT
      aspectId:
        description: >
          The aspect of the NS that is requested to be scaled, as
          declared in the NSD.
        $ref: "#/definitions/IdentifierInNsd"
      numberOfSteps:
        description: >
          The number of scaling steps to be performed. Defaults to 1.
        type: integer
        default: 1

  ScaleNsToLevelData:
    description: >
      This type represents the information used to scale an NS instance to a target size. The target size is either expressed as
      an NS instantiation level or as a list of NS scale levels, one per NS scaling aspect, of the current DF. The NS
      instantiation levels, the NS scaling aspects and their corresponding NS scale levels applicable to the NS instance are
      declared in the NSD.
    type: object
    oneOf:
      - required:
          - nsInstantiationLevel
      - required:
          - nsScaleInfo
    properties:
      nsInstantiationLevel:
        description: >
          Identifier of the target NS instantiation level of the
          current DF to which the NS instance is requested to be scaled.
        $ref: "#/definitions/IdentifierInNsd"
      nsScaleInfo:
        description: >
          For each NS scaling aspect of the current DF, defines
          the target NS scale level to which the NS instance is to be scaled.
        type: array
        items:
          $ref: "#/definitions/NsScaleInfo"

  ScaleToLevelData:
    description: >
      This type describes the information used to scale a VNF instance to a target size. The target size is either expressed as
      an instantiation level of that DF as defined in the VNFD, or given as a list of scale levels, one per scaling aspect of that
      DF. Instantiation levels and scaling aspects are declared in the VNFD. The NFVO shall then invoke the
      ScaleVnfToLevel operation towards the appropriate VNFM..
    type: object
    anyOf:
      - required:
          - vnfInstantiationLevelId
      - required:
          - vnfScaleInfo
    properties:
      vnfInstantiationLevelId:
        description: >
          Identifier of the target instantiation level of the current
          deployment flavor to which the VNF is requested to be scaled.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      vnfScaleInfo:
        description: >
          For each scaling aspect of the current deployment
          flavor, indicates the target scale level to which the VNF
          is to be scaled.
        type: array
        items:
          $ref: "#/definitions/VnfScaleInfo"
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF being scaled.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  ScaleByStepData:
    description: >
      This type describes the information to scale a VNF instance by steps. 
      The NFVO shall then invoke the Scale VNF
      operation towards the appropriate VNFM.
    type: object
    required:
      - aspectId
    properties:
      aspectId:
        description: >
          Identifier of (reference to) the aspect of the VNF that is
          requested to be scaled, as declared in the VNFD.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      numberOfSteps:
        description: >
          Number of scaling steps. It shall be a positive number.
          Defaults to 1.
          The VNF provider defines in the VNFD whether or not a
          particular VNF supports performing more than one step
          at a time. Such a property in the VNFD applies for all
          instances of a particular VNF.
        type: integer
        default: 1
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF instance being scaled.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  LcmOperationStateType:
    description: >
      Value | Description
      ------|------------
      PROCESSING | The LCM operation is currently in execution.
      COMPLETED | The LCM operation has been completed successfully.
      PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors.
      FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed.
      FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action will not succeed.
      OLLING_BACK | The LCM operation is currently being rolled back.
      ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the NS prior to the original operation invocation has been restored as closely as possible.
    type: string
    enum:
      - PROCESSING
      - COMPLETED
      - PARTIALLY_COMPLETED
      - FAILED_TEMP
      - FAILED
      - ROLLING_BACK
      - ROLLED_BACK

  NsComponentType:
    description: >
      The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1.
      Value | Description
      ------|------------
      VNF | Represents the impacted NS component is a VNF.
      PNF | Represents the impacted NS component is a PNF.
      NS | Represents the impacted NS component is a nested NS.
    type: string
    enum:
      - VNF
      - PNF
      - NS

  LcmOpNameForChangeNotificationType:
    description: >
      The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1.
      Value | Description
      ------|------------
      VNF_INSTANTIATE | Represents the "Instantiate VNF" LCM operation.
      VNF_SCALE | Represents the "Scale VNF" LCM operation.
      VNF_SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation.
      VNF_CHANGE_FLAVOUR | Represents the "Change VNF Flavor" LCM operation.
      VNF_TERMINATE | Represents the "Terminate VNF" LCM operation.
      VNF_HEAL | Represents the "Heal VNF" LCM operation.
      VNF_OPERATE | Represents the "Operate VNF" LCM operation.
      VNF_CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation.
      VNF_MODIFY_INFO | Represents the "Modify VNF Information" LCM operation.           
      NS_INSTANTIATE | Represents the "Instantiate NS" LCM operation
      NS_SCALE | Represents the "Scale NS" LCM operation.
      NS_UPDATE | Represents the "Update NS" LCM operation.
      NS_TERMINATE | Represents the "Terminate NS" LCM operation.
      NS_HEAL | Represents the "Heal NS" LCM operation.
    type: string
    enum:
      - VNF_INSTANTIATE
      - VNF_SCALE
      - VNF_SCALE_TO_LEVEL
      - VNF_CHANGE_FLAVOUR
      - VNF_TERMINATE
      - VNF_HEAL
      - VNF_OPERATE
      - VNF_CHANGE_EXT_CONN
      - VNF_MODIFY_INFO
      - NS_INSTANTIATE
      - NS_SCALE
      - NS_UPDATE
      - NS_TERMINATE
      - NS_HEAL

  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
      - PARTIALLY_COMPLETED
      - FAILED
      - 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.
          NOTE 1:	This allows the OSS/BSS to obtain a copy of the latest "result"
          notification if it has not received it due to an error. If the notification
          represents the successful result of a lifecycle operation, at least an affectedVnf,
          or affectedPnf, or affectedVl, or affectedVnffg or affectedNs, or affectedSap
          shall be present.

          NOTE 2:	A coordination action has timed out if the NFVO has not been able to read
          the "Individual coordination action" resource within a timeout interval after requesting
          the coordination to be started or to be cancelled. The length of the timeout interval
          is defined by means outside the scope of the present document.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      operationState:
        description: >
          The state of the NS LCM operation.
        $ref: "#/definitions/NsLcmOperationStateType"
      stateEnteredTime:
        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.
        $ref: "#/definitions/NsLcmOpType"
      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. See note 1.
            type: array
            items:
              $ref: "#/definitions/AffectedVnf"
          affectedPnfs:
            description: >
              Information about the PNF instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note 1.
            type: array
            items:
              $ref: "#/definitions/AffectedPnf"
          affectedVls:
            description: >
              Information about the VL instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note 1.
            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 1.
            type: array
            items:
              $ref: "#/definitions/AffectedVnffg"
          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 1.
            type: array
            items:
              $ref: "#/definitions/AffectedNs"
          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 1.
            type: array
            items:
              $ref: "#/definitions/AffectedSap"

      lcmCoordinations:
        description: >
          Information about LCM coordination actions (see clause 12.5.4.3)
          related to this LCM operation occurrence.
        type: array
        items:
          type: object
          required:
              - id
              - coordinationActionName
              - startTime
              - endpointType
          properties:
              id:
               description: >
                Identifier of this coordination action. For a terminated coordination action,
                this attribute refers to the "id" attribute in the LcmCoord data structure
                (see clause 12.5.2.3). For a timed-out or ongoing coordination action, this
                attribute refers to the {coordinationId} URI variable in the "Location" header
                of the "202 Accepted" HTTP response to the POST request that has initiated the
                coordination action (see clause 12.4.2.3.1).
               $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

              coordinationActionName:
                description: >
                  Indicator of the actual coordination action.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
              coordinationResult:
                description: >
                  The result of executing the coordination action which also implies the action
                  to be performed by the NFVO as the result of this coordination.
                  Shall be present if the coordination has been finished. Shall be absent if
                  the coordination is ongoing or has timed out (see note 2).
                $ref: "../../NSLCMCoordination/definitions/SOL005NSLCMCoordination_def.yaml#/definitions/LcmCoordResultType"

              startTime:
                description: >
                  The time when the coordination action has been started.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
              endTime:
                description: >
                  The end time of the coordination action. Shall be present for a coordination
                  action that has finished or timed out (see note 2) and shall be absent if the
                  coordination is ongoing.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
              endpointType:
                description: >
                  The endpoint type used by this coordination action.
                  Valid values:
                  -	MGMT: coordination with other operation supporting management systems (e.g. OSS/BSS)
                type: string
                enum:
                  - MGMT
              warnings:
                description: >
                  Warning messages that were generated while the operation was executing.

                  If the operation has included VNF LCM operations or NS LCM coordination
                  actions and these have resulted in warnings, such warnings should be
                  added to this attribute.
                type: array
                items:
                  type: string

      _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
    anyOf:
      - required:
          - ipAddresses
      - required:
          - macAddress
    properties:
      macAddress:
        description: >
          MAC address. If this attribute is not present, it shall be chosen by the NFV MANO.
        $ref: "#/definitions/MacAddress"
      segmentationType:
        description: >
          Specifies the encapsulation type for the traffics coming in and out of the trunk subport.
          Permitted values are:
          -	VLAN: The subport uses VLAN as encapsulation type.
          -	INHERIT: The subport gets its segmentation type from the network it is connected to.
          This attribute may be present for CP instances that represent subports in a trunk and shall be absent otherwise.
          If this attribute is not present for a subport CP instance, default value VLAN shall be used.
        type: string
        enum:
         - VLAN
         - INHERIT
      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
          oneOf:
            - required:
                - fixedAddresses
            - required:
                - numDynamicAddresses
            - required:
                - addressRange
          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 unless
          the extCp exposes a VIP CP and a link port is not needed
          for it based on the conditions defined below.

          A link port is not needed for an external CP instance that exposes a VIP CP in the following cases:
          1. For a VIP CP directly exposed as extCP:
             1.1.	no dedicated IP address is allocated as VIP address, as indicated in the VNFD
             1.2.	a dedicated IP address is allocated as VIP address, but the NFVO indicates that no port is needed
                (createExtLinkPort in VnfExtCpConfig set to false).
          2.	For a VIP CP exposed as extCP via a floating IP address:
            2.1.	no dedicated IP address is allocated as VIP address, as indicated in the VNFD,
              and the VNFC CP associated to the VIP CP is also exposed via a floating IP address.
        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: >
          Map of instance data that need to be configured on the CP instances created from the respective CPD.
          The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer.
          The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396).
          The map entry value shall be set to "null" in order to delete a "VnfExtCpConfig" entry identified by a
          particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed
          by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that
          instance in case it represents a subport. Deleting the last key from the map removes the affected instance
          of the "VnfExtCpData" structure from its parent data structure.
          Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity.
          Thus, given a particular value of the “cpdId’ attribute, there shall be one “cpConfig” entry for each VNFC
          instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute.
          If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same
          segmentationId, which means they are connected to the same set of external VLs via the trunk.
        type: object
        additionalProperties:
          $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"
      trunkResourceId:
        description: >
          Identifier of the trunk resource in the VIM.
          Shall be present if the present link port corresponds to the parent
          port that the trunk resource is associated with.

          The value of "trunkResourceId" is scoped by the value of "vimConnectionId"
          in the "resourceHandle" attribute.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"

  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
    anyOf:
      - required:
          - linkPortId
      - required:
          - cpProtocolData
    properties:
      parentCpConfigId:
        description: >
          Value of the key that identifies  to the "VnfExtCpConfig" entry that corresponds to the parent port of the trunk.
          Only present in "VnfExtCpConfig" map structures which provide configuration information for a CP which represents
          a subport in a trunk, and if parent ports are supported.
        $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":
          * At least one of the "linkPortId" and "cpProtocolData" attributes
            shall be present for a to-be-created external CP instance or an
            existing external CP instance.
          * 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"
      createExtLinkPort:
        description: >
          Indicates the need to create a dedicated link port for the external CP.
          If set to True, a link port is created. If set to False, no link port is created.
          This attribute is only applicable for external CP instances without a floating IP
          address that expose a VIP CP instance for which a dedicated IP address is allocated.
          It shall be present in that case and shall be absent otherwise.
        type: boolean
      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":
          * At least one of the "linkPortId" and "cpProtocolData" attributes
            shall be present for a to-be-created external CP instance or an
            existing external CP instance.
          * 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".
        type: array
        items:
          $ref: "#/definitions/CpProtocolData"

  IdentifierInNs:
    description: >
      An identifier that is unique with respect to a NS. Representation: string of variable length.