SOL005NSLifecycleManagement_def.yaml 267 KB
Newer Older
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
          Human readable name for the VNFFG.
        type: string
      description:
        description: >
          Human readable description for the VNFFG.
        type: string

  UpdateVnffgData:
    description: >
      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.
3019
        $ref: "#/definitions/IdentifierInNs"
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
      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:
3035
          $ref: "#/definitions/IdentifierInNs"
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047

  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.
3048
3049
          It shall be present for modified NFPs and shall be absent 
          for the new NFP.
3050
        $ref: "#/definitions/IdentifierInNs"
3051
3052
3053
3054
      nfpName:
        description: >
          Human readable name for the NFP. It shall be present
          for the new NFP, and it may be present otherwise.
3055
3056
          It shall be present for the new NFP, and it may be 
          present otherwise.
3057
3058
3059
3060
3061
        type: string
      description:
        description: >
          Human readable description for the NFP. It shall be
          present for the new NFP, and it may be present otherwise.
3062
3063
          It shall be present for the new NFP, and it may be 
          present otherwise.
3064
        type: string
3065
      cpGroup:
3066
        description: >
3067
          Group(s) of CPs and/or SAPs which the NFP passes by.
3068
3069
3070
          Cardinality can be 0 if only updated or newly created
          NFP classification and selection rule which applied to an
          existing NFP is provided.
3071
3072
3073
3074
          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.
3075
3076
        type: array
        items:
3077
          $ref: "#/definitions/CpGroupInfo"
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
      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.
3089
3090
3091

      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.
3092
    type: object
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
    anyOf:
      - required:
          - etherDestinationAddress
      - required:
          - etherSourceAddress
      - required:
          - etherType
      - required:
          - vlanTag
      - required:
          - protocol
      - required:
          - dscp
      - required:
          - sourcePortRange
      - required:
          - destinationPortRange
      - required:
          - sourceIpAddressPrefix
      - required:
          - destinationIpAddressPrefix
      - required:
          - extendedCriteria
3116
3117
3118
    properties:
      etherDestinationAddress:
        description: >
3119
          Indicates a destination Mac address. See note.
3120
        $ref: "#/definitions/MacAddress"
3121
3122
      etherSourceAddress:
        description: >
3123
          Indicates a source Mac address. See note.
3124
        $ref: "#/definitions/MacAddress"
3125
3126
      etherType:
        description: >
3127
3128
3129
3130
3131
3132
3133
          Indicates the protocol carried over the Ethernet layer.

          Permitted values:
          -	IPV4
          -	IPV6

          See note.
3134
3135
3136
3137
3138
3139
        type: string
        enum:
          - IPV4
          - IPV6
      vlanTag:
        description: >
3140
          Indicates a VLAN identifier in an IEEE 802.1Q-2018
3141
3142
3143
          tag [6] Multiple tags can be included for QinQ stacking. See note.
        type: array
        items:
3144
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
      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
3156
3157

          See note.
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
        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
3170
3171
3172
          the traffic class header field.

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

  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: >
3214
          Identifier of the new NS DF to apply to this NS instance.
3215
        $ref: "#/definitions/IdentifierInNsd"
3216
3217
3218
3219
      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.
3220
        $ref: "#/definitions/IdentifierInNsd"
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235

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

  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
3288
3289
3290
3291
3292
    anyOf:
      - required:
          - pnfName
      - required:
          - cpData
3293
3294
3295
3296
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3297
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
      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
3315
3316
3317
      - nsVirtualLinkInstanceId
      - nsVirtualLinkDescId
      - vlProfileId
3318
      - changeType
Giacomo Bernini's avatar
Giacomo Bernini committed
3319
      - changeResult
3320
    properties:
Giacomo Bernini's avatar
Giacomo Bernini committed
3321
      nsVirtualLinkInstanceId:
3322
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3323
3324
3325
          Identifier of the VL Instance.
        $ref: "#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
3326
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3327
3328
3329
3330
3331
3332
          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"
3333
3334
3335
      changeType:
        description: >
          Signals the type of change. Permitted values:
Giacomo Bernini's avatar
Giacomo Bernini committed
3336
3337
3338
3339
3340
          * ADD
          * DELETE
          * MODIFY
          * ADD_LINK_PORT
          * REMOVE_LINK_PORT
3341
        type: string
3342
        enum:
Giacomo Bernini's avatar
Giacomo Bernini committed
3343
3344
3345
3346
3347
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
3348
3349
      linkPortIds:
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3350
3351
3352
3353
3354
3355
          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.
3356
3357
3358
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
Giacomo Bernini's avatar
Giacomo Bernini committed
3359
      changeResult:
3360
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          * COMPLETED
          * ROLLED_BACK
          * FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
3372
3373

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

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

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

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

3653
  AffectedVnffg:
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
    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.
3666
        $ref: "#/definitions/IdentifierInNs"
3667
3668
3669
      vnffgdId:
        description: >
          Identifier of the VNFFGD of the VNFFG instance.
3670
        $ref: "#/definitions/IdentifierInNsd"
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
      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

3697
  AffectedNs:
3698
3699
3700
3701
3702
3703
3704
    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
3705
3706
      - changeType
      - changeResult
3707
3708
3709
3710
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3711
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3712
3713
3714
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3715
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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
3742
3743
3744
3745
3746
3747
3748
3749
3750
      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
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
      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"
3762
3763

  AffectedSap:
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
    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.
3775
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3776
3777
3778
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3779
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
      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

3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
  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
3829
      - ROLLED_BACK
3830
  NsLcmOpType:
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
    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
3848

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

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

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