SOL005NSLifecycleManagement_def.yaml 233 KB
Newer Older
3001
3002
3003
3004
3005
3006
3007
    type: object
    required:
      - pnfId
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3008
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpData:
        description: >
          Address assigned for the PNF external CP(s).
        type: array
        items:
          $ref: "#/definitions/PnfExtCpData"

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs.
    type: object
    required:
      - id
      - virtualLinkDescId
      - changeType
      - networkResource
    properties:
      id:
        description: >
          Identifier of the virtual link instance, identifying the applicable
          "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
3035
        $ref: "#/definitions/IdentifierInVnf"
3036
3037
3038
      virtualLinkDescId:
        description: >
          Identifier of the related VLD in the VNFD.
3039
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
      changeType:
        description: >
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          * LINK_PORT_ADDED
          * LINK_PORT_REMOVED
          For a temporary resource, an AffectedVirtualLink structure exists as
          long as the temporary resource exists.
3051
        type: string
3052
3053
3054
3055
3056
3057
3058
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
          - LINK_PORT_ADDED
          - LINK_PORT_REMOVED
3059
3060
3061
3062
3063
3064
3065
3066
3067
      linkPortIds:
        description: >
          Identifiers of the link ports of the affected VL (reference to the nsLinkPortInfo) related to the change.
          Shall be set when changeType is equal to "ADD_LINK_PORT" or "REMOVE_LINK_PORT", and the related linkPort
          structures are present (case "add") or have been present (case "remove") in the NsVirtualLinkInfo structure
          that is represented by the "virtualLink¬Info" attribute in the "NsInstance" structure.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
3068
      networkResource:
3069
        description: >
3070
3071
3072
          Reference to the VirtualNetwork resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
3073
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
3074
3075
3076
3077
3078
      metadata:
        description: >
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VnfVirtualLinkResourceInfo structure.
3079
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3080
3081

  AffectedVirtualStorage:
3082
    description: >
3083
3084
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
3085
3086
    type: object
    required:
3087
3088
3089
3090
      - id
      - virtualStorageDescId
      - changeType
      - storageResource
3091
    properties:
3092
      id:
3093
        description: >
3094
3095
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
3096
        $ref: "#/definitions/IdentifierInVnf"
3097
      virtualStorageDescId:
3098
        description: >
3099
          Identifier of the related VirtualStorage descriptor in the VNFD.
3100
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3101
      changeType:
3102
        description: >
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          For a temporary resource, an AffectedVirtualStorage structure exists
          as long as the temporary resource exists.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
      storageResource:
        description: >
          Reference to the VirtualStorage resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
3121
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
3122
      metadata:
3123
        description: >
3124
3125
3126
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
3127
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3128
3129
3130
3131
3132
3133
3134
3135
3136

  AffectedVnf:
    description: >
      This type provides information about added, deleted and modified VNFs. 
      It shall comply with the provisions in Table 6.5.3.2-1.
    type: object
    required:
      - vnfInstanceId
      - vnfdId
3137
      - vnfProfileId
3138
3139
3140
      - vnfName
      - changeType
      - changeResult
3141
3142
3143
3144
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance. 
3145
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3146
3147
3148
      vnfdId:
        description: >
          Identifier of the VNFD of the VNF Instance.
3149
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3150
3151
3152
      vnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3153
        $ref: "#/definitions/IdentifierInNsd"
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
      vnfName:
        description: >
          Name of the VNF Instance.
        type: string
      changeType:
        description: >
          Signals the type of change
          Permitted values:
          - ADD
          - REMOVE
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
          - OPERATE
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
3172
          -	CHANGE_VNFPKG
3173
3174
3175
        type: string
        enum:
          - ADD
3176
          - REMOVE
3177
3178
3179
3180
3181
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
3182
          - OPERATE
3183
3184
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
3185
          - CHANGE_VNFPKG
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3197
          - ROLLED_BACK
3198
3199
3200
3201
          - FAILED
      changedInfo:
        description: >
          Information about the changed VNF instance
3202
3203
3204
3205
          information, including VNF configurable properties,if applicable.
          When the "changedInfo" attribute is present, 
          either the "changedVnfInfo" attribute or the
          "changedExtConnectivity" attribute or both shall be present.
3206
        type: object
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
        anyOf:
          - required:
              - changedVnfInfo
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
        oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3219
        properties:
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
          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.
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
            type: array
            items:
              $ref: "#/definitions/ExtVirtualLinkInfo"
          modificationsTriggeredByVnfPkgChange:
            description: >
              Information about performed changes of "VnfInstance" attributes triggered by changing the current
              VNF package, if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
              At least one of the attributes "changedVnfInfo", "changedExtConnectivity" or "modificationsTriggeredByVnfPkgChange"
              shall be present. Not more than one of "changedVnfInfo" and "modificationsTriggeredByVnfPkgChange" shall be present.
            $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249

  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
3250
      - cpInstanceId
3251
3252
3253
3254
3255
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
3256
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3257
3258
3259
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3260
        $ref: "#/definitions/IdentifierInNsd"
3261
3262
3263
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3264
        $ref: "#/definitions/IdentifierInNsd"
3265
3266
3267
3268
3269
3270
3271
3272
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
3273
        items:
3274
          $ref: "#/definitions/IdentifierInPnf"
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
3285
3286
          - REMOVE
          - MODIFY
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3298
3299
3300
          - ROLLED_BACK
          - FAILED

3301
3302
3303
3304
3305
3306
3307
3308
  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
3309
      - vlProfileId
3310
3311
3312
3313
    properties:
      nsVirtualLinkInstanceId:
        description: >
          Identifier of the VL Instance.
3314
        $ref: "#/definitions/IdentifierInNs"
3315
3316
3317
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3318
        $ref: "#/definitions/IdentifierInNsd"
3319
3320
3321
      vlProfileId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3322
        $ref: "#/definitions/IdentifierInNsd"
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
        type: string
        enum:
          - ADD
3335
3336
          - DELETE
          - MODIFY
3337
          - ADD_LINK_PORT
3338
          - REMOVE_LINK_PORT
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3350
          - ROLLED_BACK
3351
          - FAILED
3352

3353
  AffectedVnffg:
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
    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.
3366
        $ref: "#/definitions/IdentifierInNs"
3367
3368
3369
      vnffgdId:
        description: >
          Identifier of the VNFFGD of the VNFFG instance.
3370
        $ref: "#/definitions/IdentifierInNsd"
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
      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

3397
  AffectedNs:
3398
3399
3400
3401
3402
3403
3404
    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
3405
3406
      - changeType
      - changeResult
3407
3408
3409
3410
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3411
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3412
3413
3414
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3415
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
      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
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
      changedInfo:
        description: >
          Information about the changed NS instance information, if applicable.
        type: object
        properties:
          wanConnectionInfoModifications:
            description: >
              Information about the modified WAN related connectivity information, if applicable.
            type: array
            items:
              $ref: "#/definitions/WanConnectionInfoModification"
3462
3463

  AffectedSap:
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
    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.
3475
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3476
3477
3478
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3479
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
      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

3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
  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
3529
      - ROLLED_BACK
3530
  NsLcmOpType:
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
    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
3548

3549
3550
3551
3552
3553
3554
3555
3556
3557
  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:
3558
      filter:
3559
        description: >
3560
3561
3562
3563
          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.
3564
3565
3566
3567
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
3568
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3569
3570
3571
3572
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
3573
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
3574
3575
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
3576
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
3577

3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
  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.
3591
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
      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.
3602
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
3613
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3614

3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
  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.
3630
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - NsLcmOperationOccurenceNotification
          - NsIdentifierCreationNotification
          - NsIdentifierDeletionNotification
          - NsChangeNotification
        type: array
        items:
          type: string
          enum:
            - NsLcmOperationOccurenceNotification
            - NsIdentifierCreationNotification
            - NsIdentifierDeletionNotification
3646
            - NsChangeNotification
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
      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
3657
        items:
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
          $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
3669
        items:
3670
3671
3672
3673
3674
3675
3676
3677
          $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
3678
        items:
3679
3680
3681
3682
3683
3684
3685
3686
3687
          $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
3688
        items:
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
          $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
3699
        items:
3700
          $ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
3701

3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
  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.
3713
        $ref: "#/definitions/IdentifierInNsd"
3714
3715
3716
      nsScaleLevelId:
        description: >
          Identifier of the NS scale level.
3717
        $ref: "#/definitions/IdentifierInNsd"
3718

3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
  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
3731
3732
        items:
          $ref: "#/definitions/VnfInstanceData"
3733
3734
3735
3736
3737
      vnfInstanceToBeRemoved:
        description: >
          The VNF instance to be removed from the NS
          instance as part of the scaling operation.
        type: array
3738
        items:
3739
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3740
3741
3742
3743
      scaleNsByStepsData:
        description: >
          The information used to scale an NS instance by
          one or more scaling steps.
3744
        $ref: "#/definitions/ScaleNsByStepsData"
3745
3746
3747
      scaleNsToLevelData:
        description: >
          The information used to scale an NS instance to a target size.
3748
        $ref: "#/definitions/ScaleNsToLevelData"
3749
3750
3751
3752
3753
3754
      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).
3755
        $ref: "#/definitions/ParamsForVnf"
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
      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
3766
3767
        items:
          $ref: "#/definitions/ParamsForVnf"
3768
3769
3770
3771
3772
3773
3774
      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
3775
3776
        items:
          $ref: "#/definitions/VnfLocationConstraint"
3777
3778
3779
3780
3781
3782
3783
      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"
3784
3785
3786
3787
3788
3789
3790
3791

  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
3792
      - scaleVnfType
3793
    properties:
3794
      vnfInstanceId:
3795
3796
        description: >
          Identifier of the VNF instance being scaled.
3797
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
      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
3809
        enum:
3810
          - SCALE_OUT
3811
3812
3813
          - SCALE_IN
          - SCALE_TO_INSTANTIATION_LEVEL
          - SCALE_TO_SCALE_LEVEL(S)
3814
3815
3816
      scaleToLevelData:
        description: >
          The information used for scaling to a given level.
3817
        $ref: "#/definitions/ScaleToLevelData"
3818
3819
3820
      scaleByStepData:
        description: >
          The information used for scaling by steps.
3821
3822
        $ref: "#/definitions/ScaleByStepData"

3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
  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.
3847
        $ref: "#/definitions/IdentifierInNsd"
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
      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.
3866
        $ref: "#/definitions/IdentifierInNsd"
3867
3868
3869
3870
3871
      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
3872
        items:
3873
          $ref: "#/definitions/NsScaleInfo"
3874

3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
  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.
3887
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3888
3889
3890
3891
3892
3893
      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
3894
3895
        items:
          $ref: "#/definitions/VnfScaleInfo"
3896
3897
3898
3899
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF being scaled.
3900
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914

  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.
3915
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3916
3917
3918
3919
3920
3921
3922
3923
3924
      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
3925
        default: 1
3926
3927
3928
3929
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the scaling process, specific to the VNF instance being scaled.
3930
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3931

3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
  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
3952

3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
  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
3965
      - NS
3966

3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
  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
3990
      - VNF_SCALE_TO_LEVEL
3991
3992
3993
3994
3995
3996
3997
3998
      - VNF_CHANGE_FLAVOUR
      - VNF_TERMINATE
      - VNF_HEAL
      - VNF_OPERATE
      - VNF_CHANGE_EXT_CONN
      - VNF_MODIFY_INFO
      - NS_INSTANTIATE
      - NS_SCALE
3999
      - NS_UPDATE
4000
      - NS_TERMINATE
For faster browsing, not all history is shown. View entire blame