SOL005NSLifecycleManagement_def.yaml 267 KB
Newer Older
4001
4002
          shall be absent otherwise.
        type: array
4003
        items:
4004
4005
4006
4007
4008
4009
4010
4011
          $ref: "#/definitions/LcmOperationStateType"
      nsComponentTypes:
        description: >
          Match particular NS component types for the
          notification of type NsChangeNotification.
          May be present if the "notificationTypes"
          attribute contains the value "NsChang.
        type: array
4012
        items:
4013
4014
4015
4016
4017
4018
4019
4020
4021
          $ref: "#/definitions/NsComponentType"
      lcmOpNameImpactingNsComponent:
        description: >
          Match particular LCM operation names for the
          notification of type NsChangeNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsChangeNotification", and shall be absent otherwise.
        type: array
4022
        items:
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
          $ref: "#/definitions/LcmOpNameForChangeNotificationType"
      lcmOpOccStatusImpactingNsComponent:
        description: >
          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
4033
        items:
4034
          $ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
4035

4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
  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.
4047
        $ref: "#/definitions/IdentifierInNsd"
4048
4049
4050
      nsScaleLevelId:
        description: >
          Identifier of the NS scale level.
4051
        $ref: "#/definitions/IdentifierInNsd"
4052

4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
  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
4065
4066
        items:
          $ref: "#/definitions/VnfInstanceData"
4067
4068
4069
4070
4071
      vnfInstanceToBeRemoved:
        description: >
          The VNF instance to be removed from the NS
          instance as part of the scaling operation.
        type: array
4072
        items:
4073
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
4074
4075
4076
4077
      scaleNsByStepsData:
        description: >
          The information used to scale an NS instance by
          one or more scaling steps.
4078
        $ref: "#/definitions/ScaleNsByStepsData"
4079
4080
4081
      scaleNsToLevelData:
        description: >
          The information used to scale an NS instance to a target size.
4082
        $ref: "#/definitions/ScaleNsToLevelData"
4083
4084
4085
4086
4087
      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
4088
          covered in additionalParamsForVnf).
4089
        $ref: "#/definitions/ParamsForVnf"
4090
4091
4092
4093
4094
      additionalParamsForVnf:
        description: >
          Allows the OSS/BSS to provide additional
          parameter(s) per VNF instance (as opposed to
          the NS level, which is covered in
4095
          additionalParamsforNs). This is for VNFs that are
4096
4097
4098
4099
          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
4100
4101
        items:
          $ref: "#/definitions/ParamsForVnf"
4102
4103
4104
4105
4106
4107
4108
      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
4109
4110
        items:
          $ref: "#/definitions/VnfLocationConstraint"
4111
4112
4113
4114
4115
4116
4117
      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"
4118
4119
4120
4121
4122
4123
4124

  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:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
4125
      - vnfInstanceId
4126
      - scaleVnfType
4127
4128
4129
4130
4131
    oneOf:
      - required:
          - scaleToLevelData
      - required:
          - scaleByStepData
4132
    properties:
4133
      vnfInstanceId:
4134
4135
        description: >
          Identifier of the VNF instance being scaled.
4136
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
      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
4148
        enum:
4149
          - SCALE_OUT
4150
4151
4152
          - SCALE_IN
          - SCALE_TO_INSTANTIATION_LEVEL
          - SCALE_TO_SCALE_LEVEL(S)
4153
4154
4155
      scaleToLevelData:
        description: >
          The information used for scaling to a given level.
4156
        $ref: "#/definitions/ScaleToLevelData"
4157
4158
4159
      scaleByStepData:
        description: >
          The information used for scaling by steps.
4160
4161
        $ref: "#/definitions/ScaleByStepData"

4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
  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.
4186
        $ref: "#/definitions/IdentifierInNsd"
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
      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
4200
4201
4202
4203
4204
    oneOf:
      - required:
          - nsInstantiationLevel
      - required:
          - nsScaleInfo
4205
4206
4207
4208
4209
    properties:
      nsInstantiationLevel:
        description: >
          Identifier of the target NS instantiation level of the
          current DF to which the NS instance is requested to be scaled.
4210
        $ref: "#/definitions/IdentifierInNsd"
4211
4212
4213
4214
4215
      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
4216
        items:
4217
          $ref: "#/definitions/NsScaleInfo"
4218

4219
4220
4221
4222
4223
4224
4225
  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
4226
4227
4228
4229
4230
    anyOf:
      - required:
          - vnfInstantiationLevelId
      - required:
          - vnfScaleInfo
4231
4232
4233
4234
4235
    properties:
      vnfInstantiationLevelId:
        description: >
          Identifier of the target instantiation level of the current
          deployment flavor to which the VNF is requested to be scaled.
4236
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
4237
4238
4239
4240
4241
4242
      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
4243
4244
        items:
          $ref: "#/definitions/VnfScaleInfo"
4245
4246
4247
4248
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF being scaled.
4249
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263

  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.
4264
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
4265
4266
4267
4268
4269
4270
4271
4272
4273
      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
4274
        default: 1
4275
4276
4277
4278
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF instance being scaled.
4279
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
4280

4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
  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
4301

4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
  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
4314
      - NS
4315

4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
  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
4339
      - VNF_SCALE_TO_LEVEL
4340
4341
4342
4343
4344
4345
4346
4347
      - VNF_CHANGE_FLAVOUR
      - VNF_TERMINATE
      - VNF_HEAL
      - VNF_OPERATE
      - VNF_CHANGE_EXT_CONN
      - VNF_MODIFY_INFO
      - NS_INSTANTIATE
      - NS_SCALE
4348
      - NS_UPDATE
4349
4350
      - NS_TERMINATE
      - NS_HEAL
4351

4352
4353
4354
4355
4356
4357
4358
4359
4360
  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.
4361
      PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS       component.
4362
4363
4364
4365
4366
4367
      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
4368
      - PARTIALLY_COMPLETED
4369
      - FAILED
4370
4371
4372
4373
4374
4375
      - 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.
piscione's avatar
piscione committed
4376
4377
4378
4379
4380
4381
4382
4383

      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
4384
4385
4386
4387
    type: object
    required:
      - id
      - operationState
4388
      - statusEnteredTime
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
      - nsInstanceId
      - lcmOperationType
      - startTime
      - isAutomaticInvocation
      - isCancelPending
      - _links
    properties:
      id:
        description: >
          Identifier of this NS lifecycle operation occurrence.
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
          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.
4409
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
4410
4411
4412
      operationState:
        description: >
          The state of the NS LCM operation.
4413
        $ref: "#/definitions/NsLcmOperationStateType"
4414
      stateEnteredTime:
4415
        description: >
4416
          Date-time when the current state has been entered.
4417
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
4418
4419
4420
      nsInstanceId:
        description: >
          Identifier of the NS instance to which the operation applies.
4421
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
4422
4423
4424
4425
      lcmOperationType:
        description: >
          Type of the actual LCM operation represented by this
          lcm operation occurrence.
4426
        $ref: "#/definitions/NsLcmOpType"
4427
4428
4429
      startTime:
        description: >
          Date-time of the start of the operation.
4430
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
      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.
4482
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
      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
4494
              represents the result of a lifecycle operation. See note 1.
4495
4496
            type: array
            items:
4497
              $ref: "#/definitions/AffectedVnf"
4498
4499
4500
4501
          affectedPnfs:
            description: >
              Information about the PNF instances that were affected
              during the lifecycle operation, if this notification
4502
              represents the result of a lifecycle operation. See note 1.
4503
4504
            type: array
            items:
4505
              $ref: "#/definitions/AffectedPnf"
4506
4507
4508
4509
          affectedVls:
            description: >
              Information about the VL instances that were affected
              during the lifecycle operation, if this notification
4510
              represents the result of a lifecycle operation. See note 1.
4511
4512
            type: array
            items:
4513
              $ref: "#/definitions/AffectedVirtualLink"
4514
4515
4516
4517
          affectedVnffgs:
            description: >
              Information about the VNFFG instances that were
              affected during the lifecycle operation, if this notification
4518
              represents the result of a lifecycle operation. See note 1.
4519
4520
            type: array
            items:
4521
              $ref: "#/definitions/AffectedVnffg"
4522
4523
4524
4525
          affectedNss:
            description: >
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
4526
              represents the result of a lifecycle operation. See note 1.
4527
4528
            type: array
            items:
4529
              $ref: "#/definitions/AffectedNs"
4530
4531
4532
4533
          affectedSaps:
            description: >
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
4534
              represents the result of a lifecycle operation. See note 1.
4535
4536
            type: array
            items:
4537
              $ref: "#/definitions/AffectedSap"
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565

      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"
4566
4567
4568
4569
4570
4571
4572
4573
              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"

4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
              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

4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - nsInstance
        properties:
          self:
            description: >
              URI of this resource.
4614
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
4615
4616
4617
          nsInstance:
            description: >
              Link to the NS instance that the operation applies to.
4618
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
4619
4620
4621
4622
4623
          cancel:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence, if
              cancelling is currently allowed.
4624
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
4625
4626
4627
4628
4629
          retry:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence,
              if cancelling is currently allowed.
4630
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
4631
4632
4633
4634
4635
          rollback:
            description: >
              Link to the task resource that represents the "rollback"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
4636
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
4637
4638
4639
4640
4641
          continue:
            description: >
              Link to the task resource that represents the "continue"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
4642
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
4643
4644
4645
4646
4647
          fail:
            description: >
              Link to the task resource that represents the "fail"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
            $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.
piscione's avatar
piscione committed
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
      NOTE 1:	At least one of "macAddress" or "ipAddresses" shall be present.
      NOTE 2:	Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" shall be present.
      NOTE 3:	If the CP instance represents a subport in a trunk, "segmentationId" shall be present.
      Otherwise it shall not be present.
      NOTE 4:	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.
4695
    type: object
4696
4697
4698
4699
4700
    anyOf:
      - required:
          - ipAddresses
      - required:
          - macAddress
4701
4702
4703
4704
    properties:
      macAddress:
        description: >
          MAC address. If this attribute is not present, it shall be chosen by the NFV MANO.
piscione's avatar
piscione committed
4705
          See note 1.
4706
        $ref: "#/definitions/MacAddress"
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
      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
4719
4720
      segmentationId:
        description: >
piscione's avatar
piscione committed
4721
          Identification of the network segment to which the CP instance connects to. See note 3 and note 4.
4722
        type: string
4723
4724
4725
4726
4727
      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.
piscione's avatar
piscione committed
4728
          If this attribute is not present, no IP address shall be assigned. See note 1.
4729
4730
4731
4732
4733
        type: array
        items:
          type: object
          required:
            - type
4734
4735
4736
4737
4738
4739
4740
          oneOf:
            - required:
                - fixedAddresses
            - required:
                - numDynamicAddresses
            - required:
                - addressRange
4741
4742
4743
4744
          properties:
            type:
              description: >
                The type of the IP addresses.
4745
4746
4747
                Permitted values:
                  - IPV4
                  - IPV6
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
              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:
4760
                $ref: "#/definitions/IpAddress"
4761
4762
4763
4764
            numDynamicAddresses:
              description: >
                Number of dynamic addresses to assign (from the subnet defined
                by "subnetId" if provided).
piscione's avatar
piscione committed
4765
                See note 2.
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
              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.
4781
                  $ref: "#/definitions/IpAddress"
4782
4783
4784
                maxAddress:
                  description: >
                    Highest IP address belonging to the range.
4785
                  $ref: "#/definitions/IpAddress"
4786
4787
4788
4789
4790
4791
4792
            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.
4793
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
4794
4795
4796

  ExtVirtualLinkData:
    description: >
piscione's avatar
piscione committed
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
      This type represents an external VL.

      NOTE:	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.

4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
    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.
4836
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
4837
4838
4839
4840
4841
4842
4843
4844
4845
      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
4846
4847
4848
          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.
piscione's avatar
piscione committed
4849
          See note.
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
        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:
4860
      - vnfVirtualLinkDescId
4861
4862
4863
4864
4865
4866
4867
      - resourceId
    properties:
      extManagedVirtualLinkId:
        description: >
          The identifier of the externally-managed internal VL
          instance, if provided.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
4868
      vnfVirtualLinkDescId:
4869
4870
        description: >
          The identifier of the VLD in the VNFD for this VL.
4871
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
      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.
4890
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
      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"
4907
4908
4909
4910
4911

  VnfExtCpData:
    description: >
      This type represents configuration information for external CPs created
      from a CPD.
piscione's avatar
piscione committed
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926

      NOTE 1:	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.
      NOTE 2: 	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.
      NOTE 3: 	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.
4927
4928
4929
4930
4931
4932
4933
    type: object
    required:
      - cpdId
    properties:
      cpdId:
        description: >
          The identifier of the CPD in the VNFD.
piscione's avatar
piscione committed
4934
          See note 1.
4935
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
4936
4937
      cpConfig:
        description: >
4938
4939
4940
          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).
piscione's avatar
piscione committed
4941
          See note 2 and note 3.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
4942
4943
        type: object
        additionalProperties:
4944
4945
4946
4947
4948
4949
          $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.
piscione's avatar
piscione committed
4950
      NOTE:	The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute.
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
    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"
4965
4966
4967
4968
4969
      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.
piscione's avatar
piscione committed
4970
          See note.
4971
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
4972
4973
4974
4975
4976
4977
4978
4979
4980

  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.
piscione's avatar
piscione committed
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
      NOTE 1:	The following conditions apply to the attributes "linkPortId" and "cpProtocolData":
        -	At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for
        an external CP instance representing a subport that is to be created, or an external CP instance
        that is to be created by creating the corresponding VNFC or VNF instance during the current or
        a subsequent LCM operation, or for an existing external CP instance that is to be re-configured
        or added to a particular external virtual link.
        -	If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided
       referencing a pre-created link port with pre-configured address information.
        -	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".
      NOTE 2:	In case the NFVO manages its own identifier space, the NFVO may remap this identifier
      when communicating with the VNFM. If the NFVO knows that there can be an identifier collision
      when communicating with the VNFM by using the identifier from the OSS/BSS, the NFVO shall remap it.
4994
    type: object
4995
4996
4997
4998
4999
    anyOf:
      - required:
          - linkPortId
      - required:
          - cpProtocolData
5000
    properties:
For faster browsing, not all history is shown. View entire blame