SOL005NSLifecycleManagement_def.yaml 162 KB
Newer Older
3001
3002
          either the "changedVnfInfo" attribute or the
          "changedExtConnectivity" attribute or both shall be present.
3003
3004
3005
3006
        type: object
        required:
          - self
        properties:
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
          changedVnfInfo:
            description: >
              Information about the changed VNF instance
              information, including configurable properties, 
              if applicable.
            $ref: "#/definitions/ModifyVnfInfoData"
          changedExtConnectivity:
            description: >
              Information about changed external connectivity,
              if applicable.
            $ref: "#/definitions/ExtVirtualLinkInfo"
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027

  AffectedPnf:
    description: >
      This type provides information about added, deleted and modified PNFs. 
      It shall comply with the provisions in Table 6.5.3.3-1.
    type: object
    required:
      - pnfId
      - pnfdId
      - pnfProfileId
3028
      - cpInstanceId
3029
3030
3031
3032
3033
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
3034
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3035
3036
3037
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3038
        $ref: "#/definitions/IdentifierInNsd"
3039
3040
3041
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3042
        $ref: "#/definitions/IdentifierInNsd"
3043
3044
3045
3046
3047
3048
3049
3050
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
3051
        items:
3052
          $ref: "#/definitions/IdentifierInPnf"
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
3063
3064
          - REMOVE
          - MODIFY
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3076
3077
3078
          - ROLLED_BACK
          - FAILED

3079
3080
3081
3082
3083
3084
3085
3086
  AffectedVl:
    description: >
      This type provides information about added, deleted and modified VLs. 
      It shall comply with the provisions in Table 6.5.3.4-1.
    type: object
    required:
      - nsVirtualLinkInstanceId
      - nsVirtualLinkDescId
3087
      - vlProfileId
3088
3089
3090
3091
    properties:
      nsVirtualLinkInstanceId:
        description: >
          Identifier of the VL Instance.
3092
        $ref: "#/definitions/IdentifierInNs"
3093
3094
3095
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3096
        $ref: "#/definitions/IdentifierInNsd"
3097
3098
3099
      vlProfileId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3100
        $ref: "#/definitions/IdentifierInNsd"
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
        type: string
        enum:
          - ADD
3113
3114
          - DELETE
          - MODIFY
3115
          - ADD_LINK_PORT
3116
          - REMOVE_LINK_PORT
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3128
          - ROLLED_BACK
3129
          - FAILED
3130

3131
  AffectedVnffg:
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
    description: >
      This type provides information about added, deleted and modified VNFFG instances.
      It shall comply with the
      provisions in Table 6.5.3.5-1.
    type: object
    required:
      - vnffgInstanceId
      - vnffgdId
    properties:
      vnffgInstanceId:
        description: >
          Identifier of the VNFFG instance.
3144
        $ref: "#/definitions/IdentifierInNs"
3145
3146
3147
      vnffgdId:
        description: >
          Identifier of the VNFFGD of the VNFFG instance.
3148
        $ref: "#/definitions/IdentifierInNsd"
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
        type: string
        enum:
          - ADD
          - DELETE
          - MODIFY
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK
          - FAILED

3175
  AffectedNs:
3176
3177
3178
3179
3180
3181
3182
    description: >
      This type provides information about added, deleted and modified nested NSs.
      It shall comply with the provisions in Table 6.5.3.6-1.
    type: object
    required:
      - nsInstanceId
      - nsdId
3183
3184
      - changeType
      - changeResult
3185
3186
3187
3188
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3189
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3190
3191
3192
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3193
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
      changeType:
        description: >
          Signals the type of lifecycle change.
          Permitted values:
          - ADD
          - REMOVE
          - INSTANTIATE
          - SCALE
          - UPDATE
          - HEAL
          - TERMINATE
        type: string
        enum:
          - ADD
          - REMOVE
          - INSTANTIATE
          - SCALE
          - UPDATE
          - HEAL
          - TERMINATE
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
          - PARTIALLY_COMPLETED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
          - PARTIALLY_COMPLETED
3229
3230

  AffectedSap:
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
    description: >
      This type provides information about added, deleted and modified SAP of a NS.
      It shall comply with the provisions in Table 6.5.3.7-1.
    type: object
    required:
      - sapInstanceId
      - sapdId
    properties:
      sapInstanceId:
        description: >
          Identifier of the nested NS instance.
3242
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3243
3244
3245
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3246
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
      sapName:
        description: >
          Human readable name for the SAP.
        type: string
      changeType:
        description: >
          Signals the type of lifecycle change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
          - REMOVE
          - MODIFY
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK
          - FAILED

3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
  NsLcmOperationStateType:
    description: >
      The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1.
      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 won't 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 VNF prior to the original operation invocation has been restored as closely as possible.
    type: string
    enum:
      - PROCESSING
      - COMPLETED
      - FAILED_TEMP
      - FAILED
      - ROLLING_BACK
3296
      - ROLLED_BACK
3297
  NsLcmOpType:
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
    description: >
      The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation
      occurrence notification.
      Value | Description
      ------|------------
      INSTANTIATE | Represents the "Instantiate NS" LCM operation.
      SCALE | Represents the "Scale NS" LCM operation.
      UPDATE | Represents the "Update NS" LCM operation.
      TERMINATE | Represents the "Terminate NS" LCM operation.
      HEAL | Represents the "Heal NS" LCM operation.
    type: string
    enum:
      - INSTANTIATE
      - SCALE
      - UPDATE
      - TERMINATE
      - HEAL
3315

3316
3317
3318
3319
3320
3321
3322
3323
3324
  LccnSubscriptionRequest:
    description: >
      This type represents a subscription request related to notifications 
      about NS lifecycle changes. It shall comply with the
      provisions defined in Table 6.5.2.2-1..
    type: object
    required:
      - callbackUri
    properties:
3325
      filter:
3326
        description: >
3327
3328
3329
3330
          Filter settings for this subscription, to define the subset
          of all notifications this subscription relates to. A
          particular notification is sent to the subscriber if the filter
          matches, or if there is no filter.
3331
3332
3333
3334
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
3335
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3336
3337
3338
3339
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
3340
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
3341
3342
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
3343
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
3344

3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
  LccnSubscription:
    description: >
      This type represents a subscription related to notifications about NS lifecycle changes. 
      It shall comply with the provisions defined in Table 6.5.2.4-1.
    type: object
    required:
      - id
      - callbackUri
      - _links
    properties:
      id:
        description: >
          Identifier of this subscription resource.
3358
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
3369
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
3380
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3381

3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
  LifecycleChangeNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications about 
      NS lifecycle changes. It shall comply with the
      provisions defined in Table 6.5.3.8-1.
      At a particular nesting level in the filter structure, the following applies: 
      All attributes shall match in order for the filter
      to match (logical "and" between different filter attributes). 
      If an attribute is an array, the attribute shall match if at least
      one of the values in the array matches (logical "or" between the values of one filter attribute).
    type: object
    properties:
      nsInstanceSubscriptionFilter:
        description: >
          Filter criteria to select NS instances about which to notify.
3397
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - NsLcmOperationOccurenceNotification
          - NsIdentifierCreationNotification
          - NsIdentifierDeletionNotification
          - NsChangeNotification
        type: array
        items:
          type: string
          enum:
            - NsLcmOperationOccurenceNotification
            - NsIdentifierCreationNotification
            - NsIdentifierDeletionNotification
3413
            - NsChangeNotification
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
      operationTypes:
        description: >
          Match particular NS lifecycle operation types
          for the notification of type
          NsLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsLcmOperationOccurrenceNotification", and
          shall be absent otherwise.
        type: array
3424
        items:
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
          $ref: "#/definitions/NsLcmOpType"
      operationStates:
        description: >
          Match particular LCM operation state values as
          reported in notifications of type
          NsLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsLcmOperationOccurrenceNotification", and
          shall be absent otherwise.
        type: array
3436
        items:
3437
3438
3439
3440
3441
3442
3443
3444
          $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
3445
        items:
3446
3447
3448
3449
3450
3451
3452
3453
3454
          $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
3455
        items:
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
          $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
3466
        items:
3467
          $ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
3468

3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
  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.
3480
        $ref: "#/definitions/IdentifierInNsd"
3481
3482
3483
      nsScaleLevelId:
        description: >
          Identifier of the NS scale level.
3484
        $ref: "#/definitions/IdentifierInNsd"
3485

3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
  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
3498
3499
        items:
          $ref: "#/definitions/VnfInstanceData"
3500
3501
3502
3503
3504
      vnfInstanceToBeRemoved:
        description: >
          The VNF instance to be removed from the NS
          instance as part of the scaling operation.
        type: array
3505
        items:
3506
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3507
3508
3509
3510
      scaleNsByStepsData:
        description: >
          The information used to scale an NS instance by
          one or more scaling steps.
3511
        $ref: "#/definitions/ScaleNsByStepsData"
3512
3513
3514
      scaleNsToLevelData:
        description: >
          The information used to scale an NS instance to a target size.
3515
        $ref: "#/definitions/ScaleNsToLevelData"
3516
3517
3518
3519
3520
3521
      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 additionalParamForVnf).
3522
        $ref: "#/definitions/ParamsForVnf"
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
      additionalParamsForVnf:
        description: >
          Allows the OSS/BSS to provide additional
          parameter(s) per VNF instance (as opposed to
          the NS level, which is covered in
          additionalParamforNs). 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
3533
3534
        items:
          $ref: "#/definitions/ParamsForVnf"
3535
3536
3537
3538
3539
3540
3541
      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
3542
3543
        items:
          $ref: "#/definitions/VnfLocationConstraint"
3544
3545
3546
3547
3548
3549
3550
3551

  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
3552
      - scaleVnfType
3553
3554
3555
3556
    properties:
      vnfInstanceid:
        description: >
          Identifier of the VNF instance being scaled.
3557
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
      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
3569
        enum:
3570
          - SCALE_OUT
3571
3572
3573
          - SCALE_IN
          - SCALE_TO_INSTANTIATION_LEVEL
          - SCALE_TO_SCALE_LEVEL(S)
3574
3575
3576
      scaleToLevelData:
        description: >
          The information used for scaling to a given level.
3577
        $ref: "#/definitions/ScaleToLevelData"
3578
3579
3580
      scaleByStepData:
        description: >
          The information used for scaling by steps.
3581
3582
        $ref: "#/definitions/ScaleByStepData"

3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
  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.
3607
        $ref: "#/definitions/IdentifierInNsd"
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
      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
    properties:
      nsInstantiationLevel:
        description: >
          Identifier of the target NS instantiation level of the
          current DF to which the NS instance is requested to be scaled.
3626
        $ref: "#/definitions/IdentifierInNsd"
3627
3628
3629
3630
3631
      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
3632
        items:
3633
          $ref: "#/definitions/NsScaleInfo"
3634

3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
  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
    properties:
      vnfInstantiationLevelId:
        description: >
          Identifier of the target instantiation level of the current
          deployment flavor to which the VNF is requested to be scaled.
3647
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3648
3649
3650
3651
3652
3653
      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
3654
3655
        items:
          $ref: "#/definitions/VnfScaleInfo"
3656
3657
3658
3659
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF being scaled.
3660
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674

  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.
3675
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3676
3677
3678
3679
3680
3681
3682
3683
3684
      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
3685
        default: 1
3686
3687
3688
3689
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF instance being scaled.
3690
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3691

3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
  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
3712

3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
  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
3725
      - NS
3726

3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
  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
3750
      - VNF_SCALE_TO_LEVEL
3751
3752
3753
3754
3755
3756
3757
3758
      - VNF_CHANGE_FLAVOUR
      - VNF_TERMINATE
      - VNF_HEAL
      - VNF_OPERATE
      - VNF_CHANGE_EXT_CONN
      - VNF_MODIFY_INFO
      - NS_INSTANTIATE
      - NS_SCALE
3759
      - NS_UPDATE
3760
3761
      - NS_TERMINATE
      - NS_HEAL
3762

3763
3764
3765
3766
3767
3768
3769
3770
3771
  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.
3772
      PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS       component.
3773
3774
3775
3776
3777
3778
      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
3779
      - PARTIALLY_COMPLETED
3780
      - FAILED
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
      - 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
3791
      - statusEnteredTime
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
      - nsInstanceId
      - lcmOperationType
      - startTime
      - isAutomaticInvocation
      - isCancelPending
      - _links
    properties:
      id:
        description: >
          Identifier of this NS lifecycle operation occurrence.
3802
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3803
3804
3805
      operationState:
        description: >
          The state of the NS LCM operation.
3806
        $ref: "#/definitions/NsLcmOperationStateType"
3807
      statusEnteredTime:
3808
        description: >
3809
          Date-time when the current state has been entered.
3810
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
3811
3812
3813
      nsInstanceId:
        description: >
          Identifier of the NS instance to which the operation applies.
3814
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3815
3816
3817
3818
      lcmOperationType:
        description: >
          Type of the actual LCM operation represented by this
          lcm operation occurrence.
3819
        $ref: "#/definitions/NsLcmOpType"
3820
3821
3822
      startTime:
        description: >
          Date-time of the start of the operation.
3823
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
      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.
3875
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
      resourceChanges:
        description: >
          This attribute contains information about the cumulative
          changes to virtualised resources that were performed so
          far by the LCM operation since its start, if applicable
        type: object
        properties:
          affectedVnfs:
            description: >
              Information about the VNF instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
            type: array
            items:
3890
              $ref: "#/definitions/AffectedVnf"
3891
3892
3893
3894
3895
3896
3897
          affectedPnfs:
            description: >
              Information about the PNF instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
            type: array
            items:
3898
              $ref: "#/definitions/AffectedPnf"
3899
3900
3901
3902
3903
3904
3905
          affectedVls:
            description: >
              Information about the VL instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
            type: array
            items:
3906
              $ref: "#/definitions/AffectedVirtualLink"
3907
3908
3909
3910
3911
3912
3913
          affectedVnffgs:
            description: >
              Information about the VNFFG instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note
            type: array
            items:
3914
              $ref: "#/definitions/AffectedVnffg"
3915
3916
3917
3918
3919
3920
3921
          affectedNss:
            description: >
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note.
            type: array
            items:
3922
              $ref: "#/definitions/AffectedNs"
3923
3924
3925
3926
3927
3928
3929
          affectedSaps:
            description: >
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note.
            type: array
            items:
3930
              $ref: "#/definitions/AffectedSap"
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - nsInstance
        properties:
          self:
            description: >
              URI of this resource.
3942
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3943
3944
3945
          nsInstance:
            description: >
              Link to the NS instance that the operation applies to.
3946
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3947
3948
3949
3950
3951
          cancel:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence, if
              cancelling is currently allowed.
3952
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3953
3954
3955
3956
3957
          retry:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence,
              if cancelling is currently allowed.
3958
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3959
3960
3961
3962
3963
          rollback:
            description: >
              Link to the task resource that represents the "rollback"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
3964
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3965
3966
3967
3968
3969
          continue:
            description: >
              Link to the task resource that represents the "continue"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
3970
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3971
3972
3973
3974
3975
          fail:
            description: >
              Link to the task resource that represents the "fail"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
            $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:
For faster browsing, not all history is shown. View entire blame