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

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

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

          Permitted values:
          -	IPV4
          -	IPV6

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

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

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

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

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

  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.
piscione's avatar
piscione committed
3294
      NOTE:	At least one attribute shall be present.
3295
3296
3297
    type: object
    required:
      - pnfId
3298
3299
3300
3301
3302
    anyOf:
      - required:
          - pnfName
      - required:
          - cpData
3303
3304
3305
3306
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3307
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3308
3309
      pnfName:
        description: >
piscione's avatar
piscione committed
3310
          Name of the PNF. See note.
3311
3312
3313
        type: string
      cpData:
        description: >
piscione's avatar
piscione committed
3314
          Address assigned for the PNF external CP(s). See note.
3315
3316
3317
3318
3319
3320
3321
3322
        type: array
        items:
          $ref: "#/definitions/PnfExtCpData"

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs.
piscione's avatar
piscione committed
3323
3324
      NOTE:	The resource handles of the affected NS link ports can be
      found by dereferencing the identifiers in the "linkPortIds" attribute.
3325
3326
    type: object
    required:
Giacomo Bernini's avatar
Giacomo Bernini committed
3327
3328
3329
      - nsVirtualLinkInstanceId
      - nsVirtualLinkDescId
      - vlProfileId
3330
      - changeType
Giacomo Bernini's avatar
Giacomo Bernini committed
3331
      - changeResult
3332
    properties:
Giacomo Bernini's avatar
Giacomo Bernini committed
3333
      nsVirtualLinkInstanceId:
3334
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3335
3336
3337
          Identifier of the VL Instance.
        $ref: "#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
3338
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3339
3340
3341
3342
3343
3344
          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"
3345
3346
3347
      changeType:
        description: >
          Signals the type of change. Permitted values:
Giacomo Bernini's avatar
Giacomo Bernini committed
3348
3349
3350
3351
3352
          * ADD
          * DELETE
          * MODIFY
          * ADD_LINK_PORT
          * REMOVE_LINK_PORT
3353
        type: string
3354
        enum:
Giacomo Bernini's avatar
Giacomo Bernini committed
3355
3356
3357
3358
3359
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
3360
3361
      linkPortIds:
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3362
          Identifiers of the link ports of the affected VL related to the change. Each identifier references an
piscione's avatar
piscione committed
3363
3364
3365
3366
3367
3368
3369
3370
          "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.

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

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

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

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

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

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

3717
  AffectedNs:
3718
3719
3720
3721
3722
3723
3724
    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
3725
3726
      - changeType
      - changeResult
3727
3728
3729
3730
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3731
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3732
3733
3734
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3735
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3736
3737
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
      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
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
      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"
3782
3783

  AffectedSap:
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
    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.
3795
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3796
3797
3798
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3799
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3800
3801
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
      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

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

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

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

3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
  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
3954
3955
3956

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

          See note.
3973
3974
3975
3976
3977
3978
3979
        type: array
        items:
          type: string
          enum:
            - NsLcmOperationOccurenceNotification
            - NsIdentifierCreationNotification
            - NsIdentifierDeletionNotification
3980
            - NsChangeNotification
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
      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
3991
        items:
3992
3993
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"
          attribute contains the value
          "NsLcmOperationOccurrenceNotification", and
For faster browsing, not all history is shown. View entire blame