SOL005NSLifecycleManagement_def.yaml 246 KB
Newer Older
3001
        items:
3002
          $ref: "#/definitions/Mask"
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015

  ChangeNsFlavourData:
    description: >
      This type specifies an existing NS instance for which the DF needs to be changed.
      This specifies the new DF, the instantiationLevel of the new DF that may be used and
      the additional parameters as input for the flavour change.
      It shall comply with the provisions defined in Table 6.5.3.39-1.
    type: object
    required:
      - newNsFlavourId
    properties:
      newNsFlavourId:
        description: >
3016
          Identifier of the new NS DF to apply to this NS instance.
3017
        $ref: "#/definitions/IdentifierInNsd"
3018
3019
3020
3021
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment flavour to be instantiated.
          If not present, the default instantiation level as declared in the NSD is instantiated.
3022
        $ref: "#/definitions/IdentifierInNsd"
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037

  AddPnfData:
    description: >
      This type specifies an PNF to be added to the NS instance and the PNF Profile
      to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.
    type: object
    required:
      - pnfId
      - pnfName
      - pnfdId
      - pnfProfileId
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3038
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3039
3040
3041
3042
3043
3044
3045
      pnfName:
        description: >
          Name of the PNF
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3046
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3047
3048
3049
      pnfProfileId:
        description: >
          Identifier of related PnfProfile in the NSD on which the PNF is based.
3050
        $ref: "#/definitions/IdentifierInNsd"
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
      cpData:
        description: >
          Address assigned for the PNF external CP(s).
        type: array
        items:
          $ref: "#/definitions/PnfExtCpData"

  PnfExtCpData:
    description: >
      This type represents the configuration data on the external CP of the PNF.
      It shall comply with the provisions defined in
      Table 6.5.3.16-1.
    type: object
    required:
      - cpProtocolData
    properties:
3067
      cpInstanceId:
3068
3069
        description: >
          Identifier of the CP. Shall be present for existing CP.
3070
        $ref: "#/definitions/IdentifierInPnf"
3071
3072
3073
      cpdId:
        description: >
          Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
3074
        $ref: "#/definitions/IdentifierInNsd"
3075
3076
3077
3078
3079
      cpProtocolData:
        description: >
          Address assigned for this CP.
        type: array
        items:
3080
          $ref: "#/definitions/CpProtocolData"
3081
3082
3083
3084
3085
3086
3087
3088
3089

  ModifyPnfData:
    description: >
      This type specifies an PNF to be modified in the NS instance.
      It shall comply with the provisions defined in
      Table 6.5.3.15-1.
    type: object
    required:
      - pnfId
3090
3091
3092
3093
3094
    anyOf:
      - required:
          - pnfName
      - required:
          - cpData
3095
3096
3097
3098
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3099
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
      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.
3126
        $ref: "#/definitions/IdentifierInVnf"
3127
3128
3129
      virtualLinkDescId:
        description: >
          Identifier of the related VLD in the VNFD.
3130
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
      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.
3142
        type: string
3143
3144
3145
3146
3147
3148
3149
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
          - LINK_PORT_ADDED
          - LINK_PORT_REMOVED
3150
3151
      linkPortIds:
        description: >
3152
3153
3154
          Identifiers of the link ports of the affected VL related to the change.
          Each identifier references an "NsLinkPortInfo" structure.
          Shall be set when changeType is equal to "ADD_LINK_PORT" or "REMOVE_LINK_PORT", and the related "NsLinkPortInfo"
3155
3156
          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.
3157
3158
          The resource handles of the affected NS link ports can be found by dereferencing the identifiers in the
          "linkPortIds" attribute.
3159
3160
3161
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
3162
      networkResource:
3163
        description: >
3164
3165
3166
          Reference to the VirtualNetwork resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
3167
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
3168
3169
3170
3171
3172
      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.
3173
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3174
3175

  AffectedVirtualStorage:
3176
    description: >
3177
3178
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
3179
3180
    type: object
    required:
3181
3182
3183
3184
      - id
      - virtualStorageDescId
      - changeType
      - storageResource
3185
    properties:
3186
      id:
3187
        description: >
3188
3189
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
3190
        $ref: "#/definitions/IdentifierInVnf"
3191
      virtualStorageDescId:
3192
        description: >
3193
          Identifier of the related VirtualStorage descriptor in the VNFD.
3194
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3195
      changeType:
3196
        description: >
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
          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.
3215
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
3216
      metadata:
3217
        description: >
3218
3219
3220
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
3221
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3222
3223
3224
3225
3226
3227
3228
3229
3230

  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
3231
      - vnfProfileId
3232
3233
3234
      - vnfName
      - changeType
      - changeResult
3235
3236
3237
3238
3239
3240
3241
3242
    anyOf:
      - required:
          - changedExtConnectivity
      - oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3243
3244
3245
3246
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance. 
3247
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3248
3249
3250
      vnfdId:
        description: >
          Identifier of the VNFD of the VNF Instance.
3251
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3252
3253
3254
      vnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3255
        $ref: "#/definitions/IdentifierInNsd"
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
      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
3274
          -	CHANGE_VNFPKG
3275
3276
3277
        type: string
        enum:
          - ADD
3278
          - REMOVE
3279
3280
3281
3282
3283
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
3284
          - OPERATE
3285
3286
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
3287
          - CHANGE_VNFPKG
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3299
          - ROLLED_BACK
3300
3301
3302
3303
          - FAILED
      changedInfo:
        description: >
          Information about the changed VNF instance
3304
3305
3306
3307
          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.
3308
        type: object
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
        anyOf:
          - required:
              - changedVnfInfo
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
        oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3321
        properties:
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
          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.
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
            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"
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351

  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
3352
      - cpInstanceId
3353
3354
3355
3356
3357
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
3358
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3359
3360
3361
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3362
        $ref: "#/definitions/IdentifierInNsd"
3363
3364
3365
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3366
        $ref: "#/definitions/IdentifierInNsd"
3367
3368
3369
3370
3371
3372
3373
3374
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
3375
        items:
3376
          $ref: "#/definitions/IdentifierInPnf"
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
3387
3388
          - REMOVE
          - MODIFY
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3400
3401
3402
          - ROLLED_BACK
          - FAILED

3403
3404
3405
3406
3407
3408
3409
3410
  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
3411
      - vlProfileId
3412
3413
3414
3415
    properties:
      nsVirtualLinkInstanceId:
        description: >
          Identifier of the VL Instance.
3416
        $ref: "#/definitions/IdentifierInNs"
3417
3418
3419
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3420
        $ref: "#/definitions/IdentifierInNsd"
3421
3422
3423
      vlProfileId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3424
        $ref: "#/definitions/IdentifierInNsd"
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
        type: string
        enum:
          - ADD
3437
3438
          - DELETE
          - MODIFY
3439
          - ADD_LINK_PORT
3440
          - REMOVE_LINK_PORT
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3452
          - ROLLED_BACK
3453
          - FAILED
3454

3455
  AffectedVnffg:
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
    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.
3468
        $ref: "#/definitions/IdentifierInNs"
3469
3470
3471
      vnffgdId:
        description: >
          Identifier of the VNFFGD of the VNFFG instance.
3472
        $ref: "#/definitions/IdentifierInNsd"
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
      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

3499
  AffectedNs:
3500
3501
3502
3503
3504
3505
3506
    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
3507
3508
      - changeType
      - changeResult
3509
3510
3511
3512
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3513
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3514
3515
3516
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3517
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
      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
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
      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"
3564
3565

  AffectedSap:
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
    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.
3577
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3578
3579
3580
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3581
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
      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

3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
  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
3631
      - ROLLED_BACK
3632
  NsLcmOpType:
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
    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
3650

3651
3652
3653
3654
3655
3656
3657
3658
3659
  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:
3660
      filter:
3661
        description: >
3662
3663
3664
3665
          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.
3666
3667
3668
3669
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
3670
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3671
3672
3673
3674
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
3675
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
3676
3677
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
3678
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
3679
3680
3681
3682
3683
      verbosity:
        description: >
          This attribute signals the requested verbosity of LCM operation occurrence notifications.
          If it is not present, it shall default to the value "FULL".
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"
3684

3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
  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.
3698
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
      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.
3709
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3710
3711
3712
3713
      verbosity:
        description: >
          This attribute signals the verbosity of LCM operation occurrence notifications.
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
3724
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3725

3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
  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.
3741
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - NsLcmOperationOccurenceNotification
          - NsIdentifierCreationNotification
          - NsIdentifierDeletionNotification
          - NsChangeNotification
        type: array
        items:
          type: string
          enum:
            - NsLcmOperationOccurenceNotification
            - NsIdentifierCreationNotification
            - NsIdentifierDeletionNotification
3757
            - NsChangeNotification
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
      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
3768
        items:
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
          $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
3780
        items:
3781
3782
3783
3784
3785
3786
3787
3788
          $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
3789
        items:
3790
3791
3792
3793
3794
3795
3796
3797
3798
          $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
3799
        items:
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
          $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
3810
        items:
3811
          $ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
3812

3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
  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.
3824
        $ref: "#/definitions/IdentifierInNsd"
3825
3826
3827
      nsScaleLevelId:
        description: >
          Identifier of the NS scale level.
3828
        $ref: "#/definitions/IdentifierInNsd"
3829

3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
  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
3842
3843
        items:
          $ref: "#/definitions/VnfInstanceData"
3844
3845
3846
3847
3848
      vnfInstanceToBeRemoved:
        description: >
          The VNF instance to be removed from the NS
          instance as part of the scaling operation.
        type: array
3849
        items:
3850
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3851
3852
3853
3854
      scaleNsByStepsData:
        description: >
          The information used to scale an NS instance by
          one or more scaling steps.
3855
        $ref: "#/definitions/ScaleNsByStepsData"
3856
3857
3858
      scaleNsToLevelData:
        description: >
          The information used to scale an NS instance to a target size.
3859
        $ref: "#/definitions/ScaleNsToLevelData"
3860
3861
3862
3863
3864
3865
      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).
3866
        $ref: "#/definitions/ParamsForVnf"
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
      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
3877
3878
        items:
          $ref: "#/definitions/ParamsForVnf"
3879
3880
3881
3882
3883
3884
3885
      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
3886
3887
        items:
          $ref: "#/definitions/VnfLocationConstraint"
3888
3889
3890
3891
3892
3893
3894
      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"
3895
3896
3897
3898
3899
3900
3901
3902

  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
3903
      - scaleVnfType
3904
3905
3906
3907
3908
    oneOf:
      - required:
          - scaleToLevelData
      - required:
          - scaleByStepData
3909
    properties:
3910
      vnfInstanceId:
3911
3912
        description: >
          Identifier of the VNF instance being scaled.
3913
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
      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
3925
        enum:
3926
          - SCALE_OUT
3927
3928
3929
          - SCALE_IN
          - SCALE_TO_INSTANTIATION_LEVEL
          - SCALE_TO_SCALE_LEVEL(S)
3930
3931
3932
      scaleToLevelData:
        description: >
          The information used for scaling to a given level.
3933
        $ref: "#/definitions/ScaleToLevelData"
3934
3935
3936
      scaleByStepData:
        description: >
          The information used for scaling by steps.
3937
3938
        $ref: "#/definitions/ScaleByStepData"

3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
  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.
3963
        $ref: "#/definitions/IdentifierInNsd"
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
      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
3977
3978
3979
3980
3981
    oneOf:
      - required:
          - nsInstantiationLevel
      - required:
          - nsScaleInfo
3982
3983
3984
3985
3986
    properties:
      nsInstantiationLevel:
        description: >
          Identifier of the target NS instantiation level of the
          current DF to which the NS instance is requested to be scaled.
3987
        $ref: "#/definitions/IdentifierInNsd"
3988
3989
3990
3991
3992
      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
3993
        items:
3994
          $ref: "#/definitions/NsScaleInfo"
3995

3996
3997
3998
3999
4000
  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
For faster browsing, not all history is shown. View entire blame