SOL005NSLifecycleManagement_def.yaml 270 KB
Newer Older
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
          of a false value) and wait for further guidance from
          OSS/BSS (i.e. waiting for OSS/BSS to issue NS
          lifecycle management operation to explicitly add/remove
          VNFs and modify information of VNF instances
          according to the new NSD).
          The synchronization to the new NSD means e.g.
          instantiating/adding those VNFs whose VNFD is
          referenced by the new NSD version but not referenced
          by the old one, terminating/removing those VNFs whose
          VNFD is referenced by the old NSD version but not
          referenced by the new NSD version, modifying
          information of VNF instances to the new applicable
          VNFD provided in the new NSD version.
          A cardinality of 0 indicates that synchronization shall not be done.
        type: boolean

  MoveVnfInstanceData:
    description: >
      This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance
      (destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination
      NS instance is specified in this data type (referred to targetNsInstanceId).
      It shall comply with the provisions defined in Table 6.5.3.35-1.
    type: object
    required:
      - targetNsInstanceId
    properties:
      targetNsInstanceId:
        description: >
          Specify the target NS instance where the VNF instances
          are moved to.
3031
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3032
3033
3034
3035
3036
      vnfInstanceId:
        description: >
          Specify the VNF instance that is moved.
        type: array
        items:
3037
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052

  AddVnffgData:
    description: >
      This type specifies the parameters used for the creation of a new VNFFG instance.
      It shall comply with the provisions defined in Table 6.5.3.36-1.
    type: object
    required:
      - vnffgdId
      - vnffgName
      - description
    properties:
      targetNsInstanceId:
        description: >
          Identifier of the VNFFGD used to create this VNFFG
          instance.
3053
        $ref: "#/definitions/IdentifierInNsd"
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
      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.
3074
        $ref: "#/definitions/IdentifierInNs"
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
      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:
3090
          $ref: "#/definitions/IdentifierInNs"
3091
3092
3093
3094
3095
3096

  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.
piscione's avatar
piscione committed
3097
3098
3099
3100
3101
      NOTE 1:	It shall be present for modified NFPs and shall be absent for the new NFP.
      NOTE 2:	It shall be present for the new NFP, and it may be present otherwise.
      NOTE 3:	At least a CP or an nfpRule shall be present.
      NOTE 4: 	When multiple identifiers are included, the position of the identifier
      in the cpGroup value specifies the position of the group in the path.
3102
3103
3104
3105
3106
3107
    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.
piscione's avatar
piscione committed
3108
          See note 1.
3109
        $ref: "#/definitions/IdentifierInNs"
3110
3111
3112
3113
      nfpName:
        description: >
          Human readable name for the NFP. It shall be present
          for the new NFP, and it may be present otherwise.
piscione's avatar
piscione committed
3114
          See note 2.
3115
3116
3117
3118
3119
        type: string
      description:
        description: >
          Human readable description for the NFP. It shall be
          present for the new NFP, and it may be present otherwise.
piscione's avatar
piscione committed
3120
          See note 2.
3121
        type: string
3122
      cpGroup:
3123
        description: >
3124
          Group(s) of CPs and/or SAPs which the NFP passes by.
3125
3126
3127
          Cardinality can be 0 if only updated or newly created
          NFP classification and selection rule which applied to an
          existing NFP is provided.
piscione's avatar
piscione committed
3128
          See note 3 and 4.
3129
3130
        type: array
        items:
3131
          $ref: "#/definitions/CpGroupInfo"
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
      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.
3143
3144
3145

      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.
3146
    type: object
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
    anyOf:
      - required:
          - etherDestinationAddress
      - required:
          - etherSourceAddress
      - required:
          - etherType
      - required:
          - vlanTag
      - required:
          - protocol
      - required:
          - dscp
      - required:
          - sourcePortRange
      - required:
          - destinationPortRange
      - required:
          - sourceIpAddressPrefix
      - required:
          - destinationIpAddressPrefix
      - required:
          - extendedCriteria
3170
3171
3172
    properties:
      etherDestinationAddress:
        description: >
3173
          Indicates a destination Mac address. See note.
3174
        $ref: "#/definitions/MacAddress"
3175
3176
      etherSourceAddress:
        description: >
3177
          Indicates a source Mac address. See note.
3178
        $ref: "#/definitions/MacAddress"
3179
3180
      etherType:
        description: >
3181
3182
3183
3184
3185
3186
3187
          Indicates the protocol carried over the Ethernet layer.

          Permitted values:
          -	IPV4
          -	IPV6

          See note.
3188
3189
3190
3191
3192
3193
        type: string
        enum:
          - IPV4
          - IPV6
      vlanTag:
        description: >
3194
          Indicates a VLAN identifier in an IEEE 802.1Q-2018
piscione's avatar
piscione committed
3195
          tag Multiple tags can be included for QinQ stacking. See note.
3196
3197
        type: array
        items:
3198
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
3199
3200
      protocol:
        description: >
piscione's avatar
piscione committed
3201
          Indicates the L4 protocol, For IPv4 this
3202
          corresponds to the field called "Protocol" to identify
piscione's avatar
piscione committed
3203
          the next level protocol. For IPv6 this
3204
3205
          corresponds to the field is called the "Next Header" field.
          Permitted values: Any keyword defined in the IANA
piscione's avatar
piscione committed
3206
          protocol registry, e.g.:
3207
3208
3209
          TCP
          UDP
          ICMP
3210
3211

          See note.
3212
3213
3214
3215
3216
3217
3218
        type: string
        enum:
          - TCP
          - UDP
          - ICMP
      dscp:
        description: >
piscione's avatar
piscione committed
3219
          For IPv4 a string of "0" and "1" digits that
3220
3221
          corresponds to the 6-bit Differentiated Services
          Code Point (DSCP) field of the IP header.
piscione's avatar
piscione committed
3222
          For IPv6 a string of "0" and "1" digits that
3223
          corresponds to the 6 differentiated services bits of
3224
3225
3226
          the traffic class header field.

          See note.
3227
3228
3229
        type: string
      sourcePortRange:
        description: >
3230
3231
          Indicates a range of source ports.
          See note.
3232
        $ref: "#/definitions/PortRange"
3233
3234
3235
      destinationPortRange:
        description: >
          Indicates a range of destination ports.
3236
          See note.
3237
        $ref: "#/definitions/PortRange"
3238
3239
3240
      sourceIpAddressPrefix:
        description: >
          Indicates the source IP address range in CIDR format.
3241
          See note.
3242
        $ref: "#/definitions/IpAddressPrefix"
3243
3244
3245
      destinationIpAddressPrefix:
        description: >
          Indicates the destination IP address range in CIDR format.
3246
          See note.
3247
        $ref: "#/definitions/IpAddressPrefix"
3248
3249
3250
      extendedCriteria:
        description: >
          Indicates values of specific bits in a frame.
3251
          See note.
3252
3253
        type: array
        items:
3254
          $ref: "#/definitions/Mask"
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267

  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: >
3268
          Identifier of the new NS DF to apply to this NS instance.
3269
        $ref: "#/definitions/IdentifierInNsd"
3270
3271
3272
3273
      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.
3274
        $ref: "#/definitions/IdentifierInNsd"
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289

  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.
3290
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3291
3292
3293
3294
3295
3296
3297
      pnfName:
        description: >
          Name of the PNF
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3298
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3299
3300
3301
      pnfProfileId:
        description: >
          Identifier of related PnfProfile in the NSD on which the PNF is based.
3302
        $ref: "#/definitions/IdentifierInNsd"
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
      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:
3319
      cpInstanceId:
3320
3321
        description: >
          Identifier of the CP. Shall be present for existing CP.
3322
        $ref: "#/definitions/IdentifierInPnf"
3323
3324
3325
      cpdId:
        description: >
          Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
3326
        $ref: "#/definitions/IdentifierInNsd"
3327
3328
3329
3330
3331
      cpProtocolData:
        description: >
          Address assigned for this CP.
        type: array
        items:
3332
          $ref: "#/definitions/CpProtocolData"
3333
3334
3335
3336
3337
3338

  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
3339
      NOTE:	At least one attribute shall be present.
3340
3341
3342
    type: object
    required:
      - pnfId
3343
3344
3345
3346
3347
    anyOf:
      - required:
          - pnfName
      - required:
          - cpData
3348
3349
3350
3351
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
3352
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3353
3354
      pnfName:
        description: >
piscione's avatar
piscione committed
3355
          Name of the PNF. See note.
3356
3357
3358
        type: string
      cpData:
        description: >
piscione's avatar
piscione committed
3359
          Address assigned for the PNF external CP(s). See note.
3360
3361
3362
3363
3364
3365
3366
3367
        type: array
        items:
          $ref: "#/definitions/PnfExtCpData"

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs.
piscione's avatar
piscione committed
3368
3369
      NOTE:	The resource handles of the affected NS link ports can be
      found by dereferencing the identifiers in the "linkPortIds" attribute.
3370
3371
    type: object
    required:
Giacomo Bernini's avatar
Giacomo Bernini committed
3372
3373
3374
      - nsVirtualLinkInstanceId
      - nsVirtualLinkDescId
      - vlProfileId
3375
      - changeType
Giacomo Bernini's avatar
Giacomo Bernini committed
3376
      - changeResult
3377
    properties:
Giacomo Bernini's avatar
Giacomo Bernini committed
3378
      nsVirtualLinkInstanceId:
3379
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3380
3381
3382
          Identifier of the VL Instance.
        $ref: "#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
3383
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3384
3385
3386
3387
3388
3389
          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"
3390
3391
3392
      changeType:
        description: >
          Signals the type of change. Permitted values:
Giacomo Bernini's avatar
Giacomo Bernini committed
3393
3394
3395
3396
3397
          * ADD
          * DELETE
          * MODIFY
          * ADD_LINK_PORT
          * REMOVE_LINK_PORT
3398
        type: string
3399
        enum:
Giacomo Bernini's avatar
Giacomo Bernini committed
3400
3401
3402
3403
3404
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
3405
3406
      linkPortIds:
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3407
          Identifiers of the link ports of the affected VL related to the change. Each identifier references an
piscione's avatar
piscione committed
3408
3409
3410
3411
3412
3413
3414
3415
          "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.

3416
3417
3418
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
Giacomo Bernini's avatar
Giacomo Bernini committed
3419
      changeResult:
3420
        description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          * COMPLETED
          * ROLLED_BACK
          * FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
3432
3433

  AffectedVirtualStorage:
3434
    description: >
3435
3436
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
3437
3438
    type: object
    required:
3439
3440
3441
3442
      - id
      - virtualStorageDescId
      - changeType
      - storageResource
3443
    properties:
3444
      id:
3445
        description: >
3446
3447
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
3448
        $ref: "#/definitions/IdentifierInVnf"
3449
      virtualStorageDescId:
3450
        description: >
3451
          Identifier of the related VirtualStorage descriptor in the VNFD.
3452
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
3453
      changeType:
3454
        description: >
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
          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.
3473
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
3474
      metadata:
3475
        description: >
3476
3477
3478
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
3479
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
3480
3481
3482

  AffectedVnf:
    description: >
piscione's avatar
piscione committed
3483
3484
3485
3486
3487
      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.
3488
3489
3490
3491
    type: object
    required:
      - vnfInstanceId
      - vnfdId
3492
      - vnfProfileId
3493
3494
3495
      - vnfName
      - changeType
      - changeResult
3496
3497
3498
3499
3500
3501
3502
3503
    anyOf:
      - required:
          - changedExtConnectivity
      - oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3504
3505
3506
3507
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance. 
3508
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3509
3510
3511
      vnfdId:
        description: >
          Identifier of the VNFD of the VNF Instance.
3512
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3513
3514
3515
      vnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3516
        $ref: "#/definitions/IdentifierInNsd"
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
      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
3535
          -	CHANGE_VNFPKG
3536
3537
3538
        type: string
        enum:
          - ADD
3539
          - REMOVE
3540
3541
3542
3543
3544
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
3545
          - OPERATE
3546
3547
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
3548
          - CHANGE_VNFPKG
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3560
          - ROLLED_BACK
3561
3562
3563
3564
          - FAILED
      changedInfo:
        description: >
          Information about the changed VNF instance
3565
3566
3567
3568
          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.
3569
        type: object
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
        anyOf:
          - required:
              - changedVnfInfo
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
        oneOf:
          - required:
              - changedVnfInfo
          - required:
              - modificationsTriggeredByVnfPkgChange
3582
        properties:
3583
3584
3585
3586
3587
          changedVnfInfo:
            description: >
              Information about the changed VNF instance
              information, including configurable properties, 
              if applicable.
piscione's avatar
piscione committed
3588
              See note.
3589
3590
3591
            $ref: "#/definitions/ModifyVnfInfoData"
          changedExtConnectivity:
            description: >
piscione's avatar
piscione committed
3592
3593
3594
              Information about changed external connectivity, if applicable.
              Only information about external VL instances that have been
              added or modified shall be provided. See note.
3595
3596
3597
3598
3599
            type: array
            items:
              $ref: "#/definitions/ExtVirtualLinkInfo"
          modificationsTriggeredByVnfPkgChange:
            description: >
piscione's avatar
piscione committed
3600
3601
3602
3603
              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.
3604
            $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614

  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
3615
      - cpInstanceId
3616
3617
3618
3619
3620
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
3621
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3622
3623
3624
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
3625
        $ref: "#/definitions/IdentifierInNsd"
3626
3627
3628
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
3629
        $ref: "#/definitions/IdentifierInNsd"
3630
3631
3632
3633
3634
3635
3636
3637
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
3638
        items:
3639
          $ref: "#/definitions/IdentifierInPnf"
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
3650
3651
          - REMOVE
          - MODIFY
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3663
3664
3665
          - ROLLED_BACK
          - FAILED

3666
3667
3668
3669
3670
3671
3672
3673
  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
3674
      - vlProfileId
3675
3676
3677
3678
    properties:
      nsVirtualLinkInstanceId:
        description: >
          Identifier of the VL Instance.
3679
        $ref: "#/definitions/IdentifierInNs"
3680
3681
3682
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3683
        $ref: "#/definitions/IdentifierInNsd"
3684
3685
3686
      vlProfileId:
        description: >
          Identifier of the VLD in the NSD for this VL.
3687
        $ref: "#/definitions/IdentifierInNsd"
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
        type: string
        enum:
          - ADD
3700
3701
          - DELETE
          - MODIFY
3702
          - ADD_LINK_PORT
3703
          - REMOVE_LINK_PORT
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
3715
          - ROLLED_BACK
3716
          - FAILED
3717

3718
  AffectedVnffg:
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
    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.
3731
        $ref: "#/definitions/IdentifierInNs"
3732
3733
3734
      vnffgdId:
        description: >
          Identifier of the VNFFGD of the VNFFG instance.
3735
        $ref: "#/definitions/IdentifierInNsd"
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
      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

3762
  AffectedNs:
3763
3764
3765
3766
3767
3768
3769
    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
3770
3771
      - changeType
      - changeResult
3772
3773
3774
3775
    properties:
      nsInstanceId:
        description: >
          Identifier of the nested NS instance.
3776
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3777
3778
3779
      nsdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3780
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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
3810
3811
3812
3813
3814
3815
      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
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
      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"
3827
3828

  AffectedSap:
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
    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.
3840
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3841
3842
3843
      sapdId:
        description: >
          Identifier of the NSD of the nested NS instance.
3844
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
      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

3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
  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
3894
      - ROLLED_BACK
3895
  NsLcmOpType:
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
    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
3913

3914
3915
3916
3917
3918
3919
3920
3921
3922
  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:
3923
      filter:
3924
        description: >
3925
3926
3927
3928
          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.
3929
3930
3931
3932
        $ref: "#/definitions/LifecycleChangeNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
3933
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3934
3935
3936
3937
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
3938
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
3939
3940
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
3941
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
3942
3943
3944
3945
3946
      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"
3947

3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
  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.
3961
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
      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.
3972
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
3973
3974
3975
3976
      verbosity:
        description: >
          This attribute signals the verbosity of LCM operation occurrence notifications.
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
3987
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
3988

3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
  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
3999
4000

      NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
For faster browsing, not all history is shown. View entire blame