SOL005NSLifecycleManagement_def.yaml 266 KB
Newer Older
3001
3002
3003
3004
3005
3006
3007
3008
3009
      This type specifies the parameters used for the update of an existing VNFFG instance.
      It shall comply with the provisions defined in Table 6.5.3.37-1.
    type: object
    required:
      - vnffgInfoId
    properties:
      vnffgInfoId:
        description: >
          Identifier of an existing VNFFG to be updated for the NS Instance.
3010
        $ref: "#/definitions/IdentifierInNs"
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
      nfp:
        description: >
          Indicate the desired new NFP(s) for a given VNFFG
          after the operations of addition/removal of NS
          components (e.g. VNFs, VLs, etc.) have been
          completed, or indicate the updated or newly created
          NFP classification and selection rule which applied to an existing NFP.
        type: array
        items:
          $ref: "#/definitions/NfpData"
      nfpInfoId:
        description: >
          Identifier(s) of the NFP to be deleted from a given VNFFG.
        type: array
        items:
3026
          $ref: "#/definitions/IdentifierInNs"
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038

  NfpData:
    description: >
      This type contains information used to create or modify NFP instance parameters
      for the update of an existing VNFFG instance.
      It shall comply with the provisions defined in Table 6.5.3.38-1.
    type: object
    properties:
      nfpInfoId:
        description: >
          Identifier of the NFP to be modified. It shall be present
          for modified NFPs and shall be absent for the new NFP.
3039
3040
          It shall be present for modified NFPs and shall be absent 
          for the new NFP.
3041
        $ref: "#/definitions/IdentifierInNs"
3042
3043
3044
3045
      nfpName:
        description: >
          Human readable name for the NFP. It shall be present
          for the new NFP, and it may be present otherwise.
3046
3047
          It shall be present for the new NFP, and it may be 
          present otherwise.
3048
3049
3050
3051
3052
        type: string
      description:
        description: >
          Human readable description for the NFP. It shall be
          present for the new NFP, and it may be present otherwise.
3053
3054
          It shall be present for the new NFP, and it may be 
          present otherwise.
3055
        type: string
3056
      cpGroup:
3057
        description: >
3058
          Group(s) of CPs and/or SAPs which the NFP passes by.
3059
3060
3061
          Cardinality can be 0 if only updated or newly created
          NFP classification and selection rule which applied to an
          existing NFP is provided.
3062
3063
3064
3065
          At least a CP or an nfpRule shall be present.
          When multiple identifiers are included, the position of 
          the identifier in the cpGroup value specifies the position 
          of the group in the path.
3066
3067
        type: array
        items:
3068
          $ref: "#/definitions/CpGroupInfo"
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
      nfpRule:
        description: >
          NFP classification and selection rule. See note 1.
        $ref: "#/definitions/NfpRule"

  NfpRule:
    description: >
      The NfpRule data type is an expression of the conditions that shall be met
      in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and
      it is met only if all the values expressed in the condition are matched
      by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1.
3080
3081
3082

      NOTE:	At least one attribute shall be present. If multiple attributes are present, a logical "AND"
      operation shall be applied to those attributes when matching packets against the rule.
3083
    type: object
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
    anyOf:
      - required:
          - etherDestinationAddress
      - required:
          - etherSourceAddress
      - required:
          - etherType
      - required:
          - vlanTag
      - required:
          - protocol
      - required:
          - dscp
      - required:
          - sourcePortRange
      - required:
          - destinationPortRange
      - required:
          - sourceIpAddressPrefix
      - required:
          - destinationIpAddressPrefix
      - required:
          - extendedCriteria
3107
3108
3109
    properties:
      etherDestinationAddress:
        description: >
3110
          Indicates a destination Mac address. See note.
3111
        $ref: "#/definitions/MacAddress"
3112
3113
      etherSourceAddress:
        description: >
3114
          Indicates a source Mac address. See note.
3115
        $ref: "#/definitions/MacAddress"
3116
3117
      etherType:
        description: >
3118
3119
3120
3121
3122
3123
3124
          Indicates the protocol carried over the Ethernet layer.

          Permitted values:
          -	IPV4
          -	IPV6

          See note.
3125
3126
3127
3128
3129
3130
        type: string
        enum:
          - IPV4
          - IPV6
      vlanTag:
        description: >
3131
          Indicates a VLAN identifier in an IEEE 802.1Q-2018
3132
3133
3134
          tag [6] Multiple tags can be included for QinQ stacking. See note.
        type: array
        items:
3135
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
      protocol:
        description: >
          Indicates the L4 protocol, For IPv4 [7] this
          corresponds to the field called "Protocol" to identify
          the next level protocol. For IPv6 [28] this
          corresponds to the field is called the "Next Header" field.
          Permitted values: Any keyword defined in the IANA
          protocol registry [1], e.g.:
          TCP
          UDP
          ICMP
3147
3148

          See note.
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
        type: string
        enum:
          - TCP
          - UDP
          - ICMP
      dscp:
        description: >
          For IPv4 [7] a string of "0" and "1" digits that
          corresponds to the 6-bit Differentiated Services
          Code Point (DSCP) field of the IP header.
          For IPv6 [28] a string of "0" and "1" digits that
          corresponds to the 6 differentiated services bits of
3161
3162
3163
          the traffic class header field.

          See note.
3164
3165
3166
        type: string
      sourcePortRange:
        description: >
3167
3168
          Indicates a range of source ports.
          See note.
3169
        $ref: "#/definitions/PortRange"
3170
3171
3172
      destinationPortRange:
        description: >
          Indicates a range of destination ports.
3173
          See note.
3174
        $ref: "#/definitions/PortRange"
3175
3176
3177
      sourceIpAddressPrefix:
        description: >
          Indicates the source IP address range in CIDR format.
3178
          See note.
3179
        $ref: "#/definitions/IpAddressPrefix"
3180
3181
3182
      destinationIpAddressPrefix:
        description: >
          Indicates the destination IP address range in CIDR format.
3183
          See note.
3184
        $ref: "#/definitions/IpAddressPrefix"
3185
3186
3187
      extendedCriteria:
        description: >
          Indicates values of specific bits in a frame.
3188
          See note.
3189
3190
        type: array
        items:
3191
          $ref: "#/definitions/Mask"
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204

  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: >
3205
          Identifier of the new NS DF to apply to this NS instance.
3206
        $ref: "#/definitions/IdentifierInNsd"
3207
3208
3209
3210
      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.
3211
        $ref: "#/definitions/IdentifierInNsd"
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226

  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.
3227
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3228
3229
3230
3231
3232
3233
3234
      pnfName:
        description: >
          Name of the PNF
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3235
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3236
3237
3238
      pnfProfileId:
        description: >
          Identifier of related PnfProfile in the NSD on which the PNF is based.
3239
        $ref: "#/definitions/IdentifierInNsd"
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
      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:
3256
      cpInstanceId:
3257
3258
        description: >
          Identifier of the CP. Shall be present for existing CP.
3259
        $ref: "#/definitions/IdentifierInPnf"
3260
3261
3262
      cpdId:
        description: >
          Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
3263
        $ref: "#/definitions/IdentifierInNsd"
3264
3265
3266
3267
3268
      cpProtocolData:
        description: >
          Address assigned for this CP.
        type: array
        items:
3269
          $ref: "#/definitions/CpProtocolData"
3270
3271
3272
3273
3274
3275
3276
3277
3278

  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
3279
3280
3281
3282
3283
    anyOf:
      - required:
          - pnfName
      - required:
          - cpData
3284
3285
3286
3287
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3288
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
      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:
Giacomo Bernini's avatar
Giacomo Bernini committed
3306
3307
3308
      - nsVirtualLinkInstanceId
      - nsVirtualLinkDescId
      - vlProfileId
3309
      - changeType
Giacomo Bernini's avatar
Giacomo Bernini committed
3310
      - changeResult
3311
    properties:
Giacomo Bernini's avatar
Giacomo Bernini committed
3312
      nsVirtualLinkInstanceId:
3313
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3314
3315
3316
          Identifier of the VL Instance.
        $ref: "#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
3317
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3318
3319
3320
3321
3322
3323
          Identifier of the VLD in the NSD for this VL.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
      vlProfileId:
        description: >
          Name of the VL profile.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
3324
3325
3326
      changeType:
        description: >
          Signals the type of change. Permitted values:
Giacomo Bernini's avatar
Giacomo Bernini committed
3327
3328
3329
3330
3331
          * ADD
          * DELETE
          * MODIFY
          * ADD_LINK_PORT
          * REMOVE_LINK_PORT
3332
        type: string
3333
        enum:
Giacomo Bernini's avatar
Giacomo Bernini committed
3334
3335
3336
3337
3338
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
3339
3340
      linkPortIds:
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3341
3342
3343
3344
3345
3346
          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" structures are present (case "add") or have been present (case "remove") in
          the "NsVirtualLinkInfo" structure that is represented by the "virtualLinkInfo" attribute in the "NsInstance"
          structure. The resource handles of the affected NS link ports can be found by dereferencing the identifiers
          in the "linkPortIds" attribute.
3347
3348
3349
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
Giacomo Bernini's avatar
Giacomo Bernini committed
3350
      changeResult:
3351
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          * COMPLETED
          * ROLLED_BACK
          * FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
3363
3364

  AffectedVirtualStorage:
3365
    description: >
3366
3367
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
3368
3369
    type: object
    required:
3370
3371
3372
3373
      - id
      - virtualStorageDescId
      - changeType
      - storageResource
3374
    properties:
3375
      id:
3376
        description: >
3377
3378
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
3379
        $ref: "#/definitions/IdentifierInVnf"
3380
      virtualStorageDescId:
3381
        description: >
3382
          Identifier of the related VirtualStorage descriptor in the VNFD.
3383
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3384
      changeType:
3385
        description: >
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
          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.
3404
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
3405
      metadata:
3406
        description: >
3407
3408
3409
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
3410
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3411
3412
3413
3414
3415
3416
3417
3418
3419

  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
3420
      - vnfProfileId
3421
3422
3423
      - vnfName
      - changeType
      - changeResult
3424
3425
3426
3427
3428
3429
3430
3431
    anyOf:
      - required:
          - changedExtConnectivity
      - oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3432
3433
3434
3435
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance. 
3436
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3437
3438
3439
      vnfdId:
        description: >
          Identifier of the VNFD of the VNF Instance.
3440
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3441
3442
3443
      vnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3444
        $ref: "#/definitions/IdentifierInNsd"
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
      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
3463
          -	CHANGE_VNFPKG
3464
3465
3466
        type: string
        enum:
          - ADD
3467
          - REMOVE
3468
3469
3470
3471
3472
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
3473
          - OPERATE
3474
3475
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
3476
          - CHANGE_VNFPKG
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3488
          - ROLLED_BACK
3489
3490
3491
3492
          - FAILED
      changedInfo:
        description: >
          Information about the changed VNF instance
3493
3494
3495
3496
          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.
3497
        type: object
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
        anyOf:
          - required:
              - changedVnfInfo
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
        oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3510
        properties:
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
          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.
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
            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"
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540

  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
3541
      - cpInstanceId
3542
3543
3544
3545
3546
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
3547
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3548
3549
3550
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3551
        $ref: "#/definitions/IdentifierInNsd"
3552
3553
3554
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3555
        $ref: "#/definitions/IdentifierInNsd"
3556
3557
3558
3559
3560
3561
3562
3563
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
3564
        items:
3565
          $ref: "#/definitions/IdentifierInPnf"
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
3576
3577
          - REMOVE
          - MODIFY
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3589
3590
3591
          - ROLLED_BACK
          - FAILED

3592
3593
3594
3595
3596
3597
3598
3599
  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
3600
      - vlProfileId
3601
3602
3603
3604
    properties:
      nsVirtualLinkInstanceId:
        description: >
          Identifier of the VL Instance.
3605
        $ref: "#/definitions/IdentifierInNs"
3606
3607
3608
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3609
        $ref: "#/definitions/IdentifierInNsd"
3610
3611
3612
      vlProfileId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3613
        $ref: "#/definitions/IdentifierInNsd"
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
        type: string
        enum:
          - ADD
3626
3627
          - DELETE
          - MODIFY
3628
          - ADD_LINK_PORT
3629
          - REMOVE_LINK_PORT
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3641
          - ROLLED_BACK
3642
          - FAILED
3643

3644
  AffectedVnffg:
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
    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.
3657
        $ref: "#/definitions/IdentifierInNs"
3658
3659
3660
      vnffgdId:
        description: >
          Identifier of the VNFFGD of the VNFFG instance.
3661
        $ref: "#/definitions/IdentifierInNsd"
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
      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

3688
  AffectedNs:
3689
3690
3691
3692
3693
3694
3695
    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
3696
3697
      - changeType
      - changeResult
3698
3699
3700
3701
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3702
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3703
3704
3705
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3706
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
      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
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
      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"
3753
3754

  AffectedSap:
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
    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.
3766
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3767
3768
3769
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3770
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
      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

3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
  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
3820
      - ROLLED_BACK
3821
  NsLcmOpType:
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
    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
3839

3840
3841
3842
3843
3844
3845
3846
3847
3848
  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:
3849
      filter:
3850
        description: >
3851
3852
3853
3854
          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.
3855
3856
3857
3858
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
3859
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3860
3861
3862
3863
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
3864
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
3865
3866
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
3867
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
3868
3869
3870
3871
3872
      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"
3873

3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
  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.
3887
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
      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.
3898
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3899
3900
3901
3902
      verbosity:
        description: >
          This attribute signals the verbosity of LCM operation occurrence notifications.
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
3913
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3914

3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
  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.
3930
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - NsLcmOperationOccurenceNotification
          - NsIdentifierCreationNotification
          - NsIdentifierDeletionNotification
          - NsChangeNotification
        type: array
        items:
          type: string
          enum:
            - NsLcmOperationOccurenceNotification
            - NsIdentifierCreationNotification
            - NsIdentifierDeletionNotification
3946
            - NsChangeNotification
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
      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
3957
        items:
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
          $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
3969
        items:
3970
3971
3972
3973
3974
3975
3976
3977
          $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
3978
        items:
3979
3980
3981
3982
3983
3984
3985
3986
3987
          $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
3988
        items:
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
          $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
3999
        items:
4000
          $ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
For faster browsing, not all history is shown. View entire blame