SOL005NSLifecycleManagement_def.yaml 269 KB
Newer Older
3001
3002
3003
3004
3005
3006
3007
3008
3009
    required:
      - vnffgdId
      - vnffgName
      - description
    properties:
      targetNsInstanceId:
        description: >
          Identifier of the VNFFGD used to create this VNFFG
          instance.
3010
        $ref: "#/definitions/IdentifierInNsd"
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
      vnffgName:
        description: >
          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.
3031
        $ref: "#/definitions/IdentifierInNs"
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
      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:
3047
          $ref: "#/definitions/IdentifierInNs"
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059

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

      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.
3104
    type: object
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
    anyOf:
      - required:
          - etherDestinationAddress
      - required:
          - etherSourceAddress
      - required:
          - etherType
      - required:
          - vlanTag
      - required:
          - protocol
      - required:
          - dscp
      - required:
          - sourcePortRange
      - required:
          - destinationPortRange
      - required:
          - sourceIpAddressPrefix
      - required:
          - destinationIpAddressPrefix
      - required:
          - extendedCriteria
3128
3129
3130
    properties:
      etherDestinationAddress:
        description: >
3131
          Indicates a destination Mac address. See note.
3132
        $ref: "#/definitions/MacAddress"
3133
3134
      etherSourceAddress:
        description: >
3135
          Indicates a source Mac address. See note.
3136
        $ref: "#/definitions/MacAddress"
3137
3138
      etherType:
        description: >
3139
3140
3141
3142
3143
3144
3145
          Indicates the protocol carried over the Ethernet layer.

          Permitted values:
          -	IPV4
          -	IPV6

          See note.
3146
3147
3148
3149
3150
3151
        type: string
        enum:
          - IPV4
          - IPV6
      vlanTag:
        description: >
3152
          Indicates a VLAN identifier in an IEEE 802.1Q-2018
3153
3154
3155
          tag [6] Multiple tags can be included for QinQ stacking. See note.
        type: array
        items:
3156
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
      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
3168
3169

          See note.
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
        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
3182
3183
3184
          the traffic class header field.

          See note.
3185
3186
3187
        type: string
      sourcePortRange:
        description: >
3188
3189
          Indicates a range of source ports.
          See note.
3190
        $ref: "#/definitions/PortRange"
3191
3192
3193
      destinationPortRange:
        description: >
          Indicates a range of destination ports.
3194
          See note.
3195
        $ref: "#/definitions/PortRange"
3196
3197
3198
      sourceIpAddressPrefix:
        description: >
          Indicates the source IP address range in CIDR format.
3199
          See note.
3200
        $ref: "#/definitions/IpAddressPrefix"
3201
3202
3203
      destinationIpAddressPrefix:
        description: >
          Indicates the destination IP address range in CIDR format.
3204
          See note.
3205
        $ref: "#/definitions/IpAddressPrefix"
3206
3207
3208
      extendedCriteria:
        description: >
          Indicates values of specific bits in a frame.
3209
          See note.
3210
3211
        type: array
        items:
3212
          $ref: "#/definitions/Mask"
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225

  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: >
3226
          Identifier of the new NS DF to apply to this NS instance.
3227
        $ref: "#/definitions/IdentifierInNsd"
3228
3229
3230
3231
      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.
3232
        $ref: "#/definitions/IdentifierInNsd"
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247

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

  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
3300
3301
3302
3303
3304
    anyOf:
      - required:
          - pnfName
      - required:
          - cpData
3305
3306
3307
3308
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3309
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
      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.
piscione's avatar
piscione committed
3325
3326
      NOTE:	The resource handles of the affected NS link ports can be
      found by dereferencing the identifiers in the "linkPortIds" attribute.
3327
3328
    type: object
    required:
Giacomo Bernini's avatar
Giacomo Bernini committed
3329
3330
3331
      - nsVirtualLinkInstanceId
      - nsVirtualLinkDescId
      - vlProfileId
3332
      - changeType
Giacomo Bernini's avatar
Giacomo Bernini committed
3333
      - changeResult
3334
    properties:
Giacomo Bernini's avatar
Giacomo Bernini committed
3335
      nsVirtualLinkInstanceId:
3336
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3337
3338
3339
          Identifier of the VL Instance.
        $ref: "#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
3340
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3341
3342
3343
3344
3345
3346
          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"
3347
3348
3349
      changeType:
        description: >
          Signals the type of change. Permitted values:
Giacomo Bernini's avatar
Giacomo Bernini committed
3350
3351
3352
3353
3354
          * ADD
          * DELETE
          * MODIFY
          * ADD_LINK_PORT
          * REMOVE_LINK_PORT
3355
        type: string
3356
        enum:
Giacomo Bernini's avatar
Giacomo Bernini committed
3357
3358
3359
3360
3361
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
3362
3363
      linkPortIds:
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3364
          Identifiers of the link ports of the affected VL related to the change. Each identifier references an
piscione's avatar
piscione committed
3365
3366
3367
3368
3369
3370
3371
3372
          "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 "virtualLink¬Info" attribute
          in the "NsInstance" structure.
          See note.

3373
3374
3375
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
Giacomo Bernini's avatar
Giacomo Bernini committed
3376
      changeResult:
3377
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          * COMPLETED
          * ROLLED_BACK
          * FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
3389
3390

  AffectedVirtualStorage:
3391
    description: >
3392
3393
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
3394
3395
    type: object
    required:
3396
3397
3398
3399
      - id
      - virtualStorageDescId
      - changeType
      - storageResource
3400
    properties:
3401
      id:
3402
        description: >
3403
3404
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
3405
        $ref: "#/definitions/IdentifierInVnf"
3406
      virtualStorageDescId:
3407
        description: >
3408
          Identifier of the related VirtualStorage descriptor in the VNFD.
3409
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3410
      changeType:
3411
        description: >
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
          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.
3430
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
3431
      metadata:
3432
        description: >
3433
3434
3435
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
3436
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3437
3438
3439

  AffectedVnf:
    description: >
piscione's avatar
piscione committed
3440
3441
3442
3443
3444
      This type provides information about added, deleted and modified VNFs.

      NOTE:	At least one of the attributes "changedVnfInfo", "changedExtConnectivity"
      or "modificationsTriggeredByVnfPkgChange" shall be present. Not more than one
      of "changedVnfInfo" and "modificationsTriggeredByVnfPkgChange" shall be present.
3445
3446
3447
3448
    type: object
    required:
      - vnfInstanceId
      - vnfdId
3449
      - vnfProfileId
3450
3451
3452
      - vnfName
      - changeType
      - changeResult
3453
3454
3455
3456
3457
3458
3459
3460
    anyOf:
      - required:
          - changedExtConnectivity
      - oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3461
3462
3463
3464
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance. 
3465
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3466
3467
3468
      vnfdId:
        description: >
          Identifier of the VNFD of the VNF Instance.
3469
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3470
3471
3472
      vnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3473
        $ref: "#/definitions/IdentifierInNsd"
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
      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
3492
          -	CHANGE_VNFPKG
3493
3494
3495
        type: string
        enum:
          - ADD
3496
          - REMOVE
3497
3498
3499
3500
3501
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
3502
          - OPERATE
3503
3504
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
3505
          - CHANGE_VNFPKG
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3517
          - ROLLED_BACK
3518
3519
3520
3521
          - FAILED
      changedInfo:
        description: >
          Information about the changed VNF instance
3522
3523
3524
3525
          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.
3526
        type: object
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
        anyOf:
          - required:
              - changedVnfInfo
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
        oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3539
        properties:
3540
3541
3542
3543
3544
          changedVnfInfo:
            description: >
              Information about the changed VNF instance
              information, including configurable properties, 
              if applicable.
piscione's avatar
piscione committed
3545
              See note.
3546
3547
3548
            $ref: "#/definitions/ModifyVnfInfoData"
          changedExtConnectivity:
            description: >
piscione's avatar
piscione committed
3549
3550
3551
              Information about changed external connectivity, if applicable.
              Only information about external VL instances that have been
              added or modified shall be provided. See note.
3552
3553
3554
3555
3556
            type: array
            items:
              $ref: "#/definitions/ExtVirtualLinkInfo"
          modificationsTriggeredByVnfPkgChange:
            description: >
piscione's avatar
piscione committed
3557
3558
3559
3560
              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".
              See note.
3561
            $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571

  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
3572
      - cpInstanceId
3573
3574
3575
3576
3577
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
3578
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3579
3580
3581
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3582
        $ref: "#/definitions/IdentifierInNsd"
3583
3584
3585
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3586
        $ref: "#/definitions/IdentifierInNsd"
3587
3588
3589
3590
3591
3592
3593
3594
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
3595
        items:
3596
          $ref: "#/definitions/IdentifierInPnf"
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
3607
3608
          - REMOVE
          - MODIFY
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3620
3621
3622
          - ROLLED_BACK
          - FAILED

3623
3624
3625
3626
3627
3628
3629
3630
  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
3631
      - vlProfileId
3632
3633
3634
3635
    properties:
      nsVirtualLinkInstanceId:
        description: >
          Identifier of the VL Instance.
3636
        $ref: "#/definitions/IdentifierInNs"
3637
3638
3639
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3640
        $ref: "#/definitions/IdentifierInNsd"
3641
3642
3643
      vlProfileId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3644
        $ref: "#/definitions/IdentifierInNsd"
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
        type: string
        enum:
          - ADD
3657
3658
          - DELETE
          - MODIFY
3659
          - ADD_LINK_PORT
3660
          - REMOVE_LINK_PORT
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3672
          - ROLLED_BACK
3673
          - FAILED
3674

3675
  AffectedVnffg:
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
    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.
3688
        $ref: "#/definitions/IdentifierInNs"
3689
3690
3691
      vnffgdId:
        description: >
          Identifier of the VNFFGD of the VNFFG instance.
3692
        $ref: "#/definitions/IdentifierInNsd"
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
      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

3719
  AffectedNs:
3720
3721
3722
3723
3724
3725
3726
    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
3727
3728
      - changeType
      - changeResult
3729
3730
3731
3732
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3733
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3734
3735
3736
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3737
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
      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
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
      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"
3784
3785

  AffectedSap:
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
    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.
3797
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3798
3799
3800
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3801
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
      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

3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
  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
3851
      - ROLLED_BACK
3852
  NsLcmOpType:
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
    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
3870

3871
3872
3873
3874
3875
3876
3877
3878
3879
  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:
3880
      filter:
3881
        description: >
3882
3883
3884
3885
          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.
3886
3887
3888
3889
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
3890
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3891
3892
3893
3894
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
3895
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
3896
3897
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
3898
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
3899
3900
3901
3902
3903
      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"
3904

3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
  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.
3918
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
      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.
3929
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3930
3931
3932
3933
      verbosity:
        description: >
          This attribute signals the verbosity of LCM operation occurrence notifications.
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
3944
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3945

3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
  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).
piscione's avatar
piscione committed
3956
3957
3958

      NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
      of the notification types to facilitate automated code generation systems.
3959
3960
3961
3962
3963
    type: object
    properties:
      nsInstanceSubscriptionFilter:
        description: >
          Filter criteria to select NS instances about which to notify.
3964
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
3965
3966
3967
3968
3969
3970
3971
3972
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - NsLcmOperationOccurenceNotification
          - NsIdentifierCreationNotification
          - NsIdentifierDeletionNotification
          - NsChangeNotification
piscione's avatar
piscione committed
3973
3974

          See note.
3975
3976
3977
3978
3979
3980
3981
        type: array
        items:
          type: string
          enum:
            - NsLcmOperationOccurenceNotification
            - NsIdentifierCreationNotification
            - NsIdentifierDeletionNotification
3982
            - NsChangeNotification
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
      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
3993
        items:
3994
3995
3996
3997
3998
3999
4000
          $ref: "#/definitions/NsLcmOpType"
      operationStates:
        description: >
          Match particular LCM operation state values as
          reported in notifications of type
          NsLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes"
For faster browsing, not all history is shown. View entire blame