SOL002SOL003VNFLifecycleManagement_def.yaml 116 KB
Newer Older
1
2
3
4
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
5
  CreateVnfRequest:
6
7
    type: object
    required:
8
      - vnfdId
9
    properties:
10
      vnfdId:
11
        description: >
12
13
14
15
          Identifier that identifies the VNFD which defines the VNF instance to
          be created.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfInstanceName:
16
        description: >
17
18
19
          Human-readable name of the VNF instance to be created.
        type: string
      vnfInstanceDescription:
20
        description: >
21
22
23
          Human-readable description of the VNF instance to be created.
        type: string
      metadata:
24
        description: >
25
26
27
          If present, this attribute provides additional initial values, overriding those obtained from the VNFD, for
          the "metadata" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling metadata
          during the operation are defined in clause 5.4.2.3.1.
28
29
30
31
32
33
34
35
36
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  ScaleVnfRequest:
    type: object
    required:
      - type
      - aspectId
    properties:
      type:
37
        description: >
38
39
40
41
42
43
          Indicates the type of the scale operation requested.
          Permitted values:
          * SCALE_OUT: adding additional VNFC instances to the VNF to increase
            capacity
          * SCALE_IN: removing VNFC instances from the VNF in order to release
            unused capacity.
44
        type: string
45
46
47
48
49
50
51
52
53
54
55
56
57
58
        enum:
          - SCALE_OUT
          - SCALE_IN
      aspectId:
        description: >
          Identifier of the scaling aspect.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      numberOfSteps:
        description: >
          Number of scaling steps to be executed as part of this Scale VNF
          operation. It shall be a positive number and the default value
          shall be 1.
        type: integer
        default: 1
59
60
      additionalParams:
        description: >
61
62
63
          Additional parameters passed by the NFVO as input to the scaling
          process, specific to the VNF being scaled, as declared in the VNFD
          as part of "ScaleVnfOpConfig".
64
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
65
66
67
68
69
70

  ScaleVnfToLevelRequest:
    description: >
      This type represents request parameters for the "Scale VNF to Level"
      operation.
    type: object
71
72
73
74
75
76
    anyOf:
      - oneOf:
          - required:
              - instantiationLevelId
          - required:
              - scaleInfo
77
78
    properties:
      instantiationLevelId:
79
        description: >
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
          Identifier of the target instantiation level of the current
          deployment flavour to which the VNF is requested to be scaled.
          Either the instantiationLevelId attribute or the scaleInfo attribute
          shall be included.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      scaleInfo:
        description: >
          For each scaling aspect of the current deployment flavour, indicates
          the target scale level to which the VNF is to be scaled.
          Either the instantiationLevelId attribute or the scaleInfo attribute
          shall be included.
        type: array
        items:
          $ref: "#/definitions/ScaleInfo"
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the scaling
          process, specific to the VNF being scaled, as declared in the
          VNFD as part of "ScaleVnfToLevelOpConfig".
99
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
100

101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
  VnfInfoModificationRequest:
    description: >
      This type represents attribute modifications for an "Individual VNF instance" resource,
      i.e. modifications to a resource representation based on the "VnfInstance" data type.
      The attributes of "VnfInstance" that can be modified according to the provisions in clause 5.5.2.2
      are included in the "VnfInfoModificationRequest" data type.
      The "VnfInfoModificationRequest" data type shall comply with the provisions defined in table 5.5.2.12-1.
    type: object
    properties:
      vnfInstanceName:
        description: >
          New value of the "vnfInstanceName" attribute in "VnfInstance", or "null" to remove the attribute.
        type: string
      vnfInstanceDescription:
        description: >
          New value of the "vnfInstanceDescription" attribute in "VnfInstance", or "null" to remove the attribute.
        type: string
      vnfdId:
        description: >
          New value of the "vnfdId" attribute in "VnfInstance". The value "null" is not permitted.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfConfigurableProperties:
        description: >
          Modifications of the "vnfConfigurableProperties" attribute in "VnfInstance".
          If present, these modifications shall be applied according to the rules of
          JSON Merge PATCH (see IETF RFC 7396 [15]).
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          Modifications of the "metadattametadata" attribute in "VnfInstance".
          If present, these modifications shall be applied according to the rules of
          JSON Merge PATCH (see IETF  RFC  7396  [15]).
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          Modifications of the "extensions" attribute in "VnfInstance".
          If present, these modifications shall be applied according to the rules of
          JSON Merge PATCH (see IETF  RFC  7396  [15]).
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfcInfoModifications:
        description: >
          Modifications of certain entries in the "vnfcInfo" attribute array in the
          "instantiatedVnfInfo" attribute of "VnfInstance"." to be used as "newList" as defined below this table.
        type: array
        items:
          $ref: "#/definitions/VnfcInfoModifications"
      vnfcInfoModificationsDeleteIds:
        description: >
          List of identifiers entries to be deleted from the 'vnfcInfoModifications" attribute array
          to be used as "deleteIdList" as defined below this table.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"

  VnfInfoModifications:
    description: >
      This type represents attribute modifications that were performed on an
      "Individual VNF instance" resource. The attributes that can be included
      consist of those requested to be modified explicitly in the
      "VnfInfoModificationRequest" data structure, and additional attributes
      of the "VnfInstance" data structure that were modified implicitly e.g.
      when modifying the referenced VNF package.
    type: object
    properties:
      vnfInstanceName:
        description: >
          If present, this attribute signals modifications of the
          "vnfInstanceName" attribute in "VnfInstance".
        type: string
      vnfInstanceDescription:
        description: >
          If present, this attribute signals modifications of the
          "vnfInstanceDescription" attribute in "VnfInstance".
        type: string
      vnfConfigurableProperties:
        description: >
          If present, this attribute signals modifications of the
          "vnfConfigurableProperties" attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          If present, this attribute signals modifications of the "metadata"
          attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          If present, this attribute signals modifications of the "extensions"
          attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vnfdId:
        description: >
          If present, this attribute signals modifications of the "vnfdId"
          attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfProvider:
        description: >
          If present, this attribute signals modifications of the
          "vnfProvider" attribute in "VnfInstance".
          If present, this attribute (which depends on the value of the
          "vnfPkgId" attribute) was modified implicitly following a request to
          modify the "vnfPkgId" attribute, by copying the value of this
          attribute from the VNFD in the VNF Package identified by the
          "vnfPkgId” attribute.
        type: string
      vnfProductName:
        description: >
          If present, this attribute signals modifications of the
          "vnfProductName" attribute in "VnfInstance".
          If present, this attribute (which depends on the value of the
          "vnfPkgId" attribute) was modified implicitly following a request to
          modify the "vnfPkgId" attribute, by copying the value of this
          attribute from the VNFD in the VNF Package identified by the
          "vnfPkgId” attribute.
        type: string
      vnfSoftwareVersion:
        description: >
          If present, this attribute signals modifications of the
          "vnfSoftwareVersion" attribute in "VnfInstance".
        $ref: "SOL002SOL003_def.yaml#/definitions/Version"
      vnfdVersion:
        description: >
          If present, this attribute signals modifications of the
          "vnfdVersion" attribute in "VnfInstance".
          If present, this attribute (which depends on the value of the
225
226
          "vnfdId" attribute) was modified implicitly following a request to
          modify the "vnfdId" attribute, by copying the value of this
227
          attribute from the VNFD in the VNF Package identified by the
228
          "vnfdId” attribute.
229
        $ref: "SOL002SOL003_def.yaml#/definitions/Version"
230
231
232
233
234
235
236
237
238
      vnfcInfoModifications:
        description: >
          If present, this attribute signals modifications of certain
          entries in the "vnfcInfo" attribute array in the
          "instantiatedVnfInfo" attribute of "VnfInstance", as defined
          in clause 5.5.2.12
        type: array
        items:
          $ref: "#/definitions/VnfcInfoModifications"
239

240
241
  VnfLcmOpOcc:
    description: >
242
243
      This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the "id"
      attribute in the "Grant" representing the associated "Individual Grant", if such grant exists.
244
    type: object
245
246
247
248
249
    oneOf:
      - required:
        - changedInfo
      - required:
        - modificationsTriggeredByVnfPkgChange
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
    required:
      - id
      - operationState
      - stateEnteredTime
      - startTime
      - vnfInstanceId
      - operation
      - isAutomaticInvocation
      - isCancelPending
    properties:
      id:
        description: >
          Identifier of this VNF lifecycle management operation occurrence.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      operationState:
        description: >
          The state of the LCM operation.
        $ref: "#/definitions/LcmOperationStateType"
      stateEnteredTime:
        description: >
270
          Date-time when the current state has been entered.
271
272
273
274
275
276
277
278
279
280
281
282
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      startTime:
        description: >
          Date-time of the start of the operation.
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to which the operation applies
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      grantId:
        description: >
          Identifier of the grant related to this VNF LCM operation
283
284
285
          occurrence. Shall be set to the value of the "id" attribute 
          in the "Grant" representing the associated "Individual Grant", 
          if such grant exists.
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      operation:
        description: >
          Type of the actual LCM operation represented by this VNF LCM
          operation occurrence.
        $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType"
      isAutomaticInvocation:
        description: >
          Set to true if this VNF LCM operation occurrence has been triggered
          by an automated procedure inside the VNFM (i.e.
          ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
          triggered by auto-heal). Set to false otherwise.
        $ref: "SOL002SOL003_def.yaml#/definitions/Boolean"
      operationParams:
        description: >
          Input parameters of the LCM operation. This attribute shall be
          formatted according to the request data type of the related LCM
          operation. The following mapping between operationType and the
          data type of this attribute shall apply:
          * INSTANTIATE: InstantiateVnfRequest
          * SCALE: ScaleVnfRequest
          * SCALE_TO_LEVEL: ScaleVnfToLevelRequest
          * CHANGE_FLAVOUR: ChangeVnfFlavourRequest
          * OPERATE: OperateVnfRequest
          * HEAL: HealVnfRequest
          * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest
          * TERMINATE: TerminateVnfRequest
          * MODIFY_INFO: VnfInfoModifications
314
315
316
          * CREATE_SNAPSHOT: CreateVnfSnapshotRequest
          * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest
          * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
        type: object
      isCancelPending:
        description: >
          If the VNF LCM operation occurrence is in "STARTING", "PROCESSING"
          or "ROLLING_BACK" state and the operation is being cancelled, this
          attribute shall be set to true. Otherwise, it shall be set to false.
        $ref: "SOL002SOL003_def.yaml#/definitions/Boolean"
      cancelMode:
        description: >
          The mode of an ongoing cancellation. Shall be present when
          isCancelPending=true, and shall be absent otherwise.
        $ref: "#/definitions/CancelModeType"
      error:
        description: >
          If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState"
          is "PROCESSING" or "ROLLING_BACK" and previous value of
          "operationState" was "FAILED_TEMP", this attribute shall be present
          and contain error information, unless it has been requested to be
          excluded via an attribute selector.
        $ref: "SOL002SOL003_def.yaml#/definitions/ProblemDetails"
      resourceChanges:
        description: >
          This attribute contains information about the cumulative changes to
          virtualised resources that were performed so far by the LCM
          operation since its start, if applicable.
        type: object
        properties:
          affectedVnfcs:
            description: >
              Information about VNFC instances that were affected during the
              lifecycle operation.
348
349
              This allows the API consumer to obtain the information contained in
              the latest "result" notification if it has not received it due to an
350
351
352
353
354
355
356
357
              error or a wrongly configured subscription filter.
            type: array
            items:
              $ref: "SOL002SOL003_def.yaml#/definitions/AffectedVnfc"
          affectedVirtualLinks:
            description: >
              Information about VL instances that were affected during the
              lifecycle operation.
358
359
              This allows the API consumer to obtain the information contained in
              the latest "result" notification if it has not received it due to an
360
              error or a wrongly configured subscription filter.
361
362
363
364
365
366
367
368
369
              For a particular affected VL, there shall be as many "AffectedVirtualLink"
              entries as needed for signalling the different types of changes, i.e.,
              one per virtual link and change type. For instance, in the case of
              signaling affected VL instances involving the addition of a particular VL
              instance with links ports, one "AffectedVirtualLink" entry signals the
              addition of the VL by using the "changeType" attribute of "AffectedVirtualLink"
              structure equal to "ADDED", and another "AffectedVirtualLink" entry signals
              the addition of VNF link ports of the VL by using the "changeType" equal to
              "LINK_PORT_ADDED".
370
371
372
            type: array
            items:
              $ref: "#/definitions/AffectedVirtualLink"
373
374
375
376
377
378
379
380
          affectedExtLinkPorts:
            description: >
              Information about external VNF link ports that were affected during the lifecycle operation. This allows
              the API consumer to obtain the information contained in the latest "result" notification if it has not
              received it due to an error or a wrongly configured subscription filter.
            type: array
            items:
              $ref: "#/definitions/AffectedExtLinkPort"
381
382
383
384
          affectedVirtualStorages:
            description: >
              Information about virtualised storage instances that were affected
              during the lifecycle operation.
385
386
387
              This allows the API consumer to obtain the information contained
              in the latest "result" notification if it has not received it due to
              an error or a wrongly configured subscription filter.
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
            type: array
            items:
              $ref: "#/definitions/AffectedVirtualStorage"
      changedInfo:
        description: >
          Information about the changed VNF instance information, including
          VNF configurable properties, if applicable.
          This allows the NFVO to obtain the information contained in the
          latest "result" notification if it has not received it due to an
          error or a wrongly configured subscription filter.
        $ref: "#/definitions/VnfInfoModifications"
      changedExtConnectivity:
        description: >
          Information about changed external connectivity, if applicable.
          This allows the NFVO to obtain the information contained in the
          latest "result" notification if it has not received it due to an
          error or a wrongly configured subscription filter.
        type: array
        items:
          $ref: "#/definitions/ExtVirtualLinkInfo"
408
409
410
411
412
413
414
415
      modificationsTriggeredByVnfPkgChange:
        description: >
          Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package,
          if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
          This allows the API consumer to obtain the information contained in the latest "result" notification if it has
          not received it due to an error or a wrongly configured subscription filter.
          Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present.
        $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
416
      vnfSnapshotInfoId:
417
        description: >
418
419
          Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation,
          i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT".
420
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - vnfInstance
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          vnfInstance:
            description: >
              Link to the VNF instance that the operation applies to.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          grant:
            description: >
              Link to the grant for this operation, if one exists.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          cancel:
            description: >
              Link to the task resource that represents the "cancel" operation
              for this VNF LCM operation occurrence, if cancelling is
              currently allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          retry:
            description: >
              Link to the task resource that represents the "retry" operation
              for this VNF LCM operation occurrence, if retrying is currently
              allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          rollback:
            description: >
              Link to the task resource that represents the "rollback"
              operation for this VNF LCM operation occurrence, if rolling back
              is currently allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          fail:
            description: >
              Link to the task resource that represents the "fail" operation
              for this VNF LCM operation occurrence, if declaring as failed is
              currently allowed.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
465
466
467
468
469
          vnfSnapshot:
            description: >
              Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot.
              Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT".
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
470

471
  CancelMode:
472
    description: >
473
474
475
476
477
478
479
480
481
482
      This type represents a parameter to select the mode of cancelling an
      ongoing VNF LCM operation occurrence.
    type: object
    required:
      - cancelMode
    properties:
      cancelMode:
        description: >
          Cancellation mode to apply.
        $ref: "#/definitions/CancelModeType"
483

484
  LccnSubscriptionRequest:
485
    description: >
486
487
      This type represents a subscription request related to notifications
      about VNF lifecycle changes.
488
489
    type: object
    required:
490
      - callbackUri
491
    properties:
492
      filter:
493
        description: >
494
495
496
497
498
499
          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:
500
        description: >
501
502
503
          The URI of the endpoint to send the notification to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Uri"
      authentication:
504
        description: >
505
506
507
508
509
510
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
        $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
511
512
513
514
515
      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"
516

517
  LccnSubscription:
518
    description: >
519
520
      This type represents a subscription related to notifications about VNF
      lifecycle changes.
521
522
523
    type: object
    required:
      - id
524
      - callbackUri
525
      - verbosity
526
      - _links
527
528
529
    properties:
      id:
        description: >
530
531
532
          Identifier of this subscription resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      filter:
533
        description: >
534
535
536
537
538
539
          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:
540
        description: >
541
542
          The URI of the endpoint to send the notification to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Uri"
543
544
545
546
      verbosity:
        description: >
          This attribute signals the verbosity of LCM operation occurrence notifications.
        $ref: "#/definitions/LcmOpOccNotificationVerbosityType"
547
      _links:
548
        description: >
549
550
551
552
553
554
555
556
557
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
558
  
559
560
  ExtVirtualLinkInfo:
    type: object
561
    required:
562
563
      - id
      - resourceHandle
564
      - currentVnfExtCpData
565
    properties:
566
      id:
567
        description: >
568
569
570
571
572
573
          Identifier of the external VL and the related external VL
          information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      resourceHandle:
574
        description: >
575
576
577
578
579
580
581
582
          Reference to the resource realizing this VL.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"
583
584
585
586
587
588
589
590
591
592
593
594
595
      currentVnfExtCpData:
        description: >
          Allows the API consumer to read the current CP configuration information for the connection of external CPs
          to the external virtual link.
          This attribute reflects the current configuration information that has resulted from merging into this attribute
          the "VnfExtCpData" information which was passed as part of the "ExtVirtualLinkData" structure in the input of
          the most recent VNF LCM operation such as "InstantiateVnfRequest", "ChangeExtVnfConnectivityRequest",
          "ChangeVnfFlavourRequest" or "ChangeCurrentVnfPkgRequest", or has been provided by the NFVO during the granting
          procedure. If applying such change results in an empty list of "currentVnfExtCpData" structure instances, the
          affected instance of "ExtVirtualLinkInfo" shall be removed from its parent data structure.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/VnfExtCpData"
596

597
  ExtManagedVirtualLinkInfo:
598
599
    type: object
    required:
600
601
      - id
      - vnfVirtualLinkDescId
602
      - networkResource
603
    properties:
604
      id:
605
        description: >
606
607
608
609
610
611
          Identifier of the externally-managed internal VL and the related
          externally-managed VL information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfVirtualLinkDescId:
612
        description: >
613
614
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
615
616
617
618
619
620
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
621
622
      networkResource:
        description: >
623
          Reference to the VirtualNetwork resource providing this VL.
624
625
626
627
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      vnfLinkPorts:
        description: >
          Link ports of this VL.
628
629
        type: array
        items:
630
          $ref: "#/definitions/VnfLinkPortInfo"
631
632
633
634
635
636
637
638
639
      extManagedMultisiteVirtualLinkId:
        description: >
          Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO entity 
          that manages the externally managed multi-site VL instance. It shall be present when the externally-managed 
          internal VL is part of a multi-site VL, e.g., in support of multi-site VNF spanning several VIMs. 
          All externally-managed internal VL instances corresponding to an internal VL created based on the same 
          virtualLinkDescId shall refer to the same extManagedMultisiteVirtualLinkId.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"

640
  ScaleInfo:
641
    required:
642
643
644
      - aspectId
      - scaleLevel
    type: object
645
    properties:
646
      aspectId:
647
        description: >
648
649
          Identifier of the scaling aspect.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
650
651
652
653
654
655
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
656
      scaleLevel:
657
        description: >
658
659
660
          Indicates the scale level. The minimum value shall be 0 and the
          maximum value shall be <= maxScaleLevel as described in the VNFD.
        type: integer
661

662
663
664
665
  VnfcResourceInfo:
    description: >
      This type represents the information on virtualised compute and storage
      resources used by a VNFC in a VNF instance.
666
667
668
    type: object
    required:
      - id
669
670
      - vduId
      - computeResource
671
672
673
    properties:
      id:
        description: >
674
675
676
          Identifier of this VnfcResourceInfo instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vduId:
677
        description: >
678
679
          Reference to the applicable VDU in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
680
681
682
683
684
685
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
686
687
688
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
689
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
690
691
692
693
694
695
696
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the
          resource management layer (typically, the VIM), where
          the referenced VirtualCompute resource is placed.
          Shall be provided if this information is available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
697
      storageResourceIds:
698
        description: >
699
700
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
701
702
        type: array
        items:
703
704
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      reservationId:
705
        description: >
706
707
708
709
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfcCpInfo:
710
        description: >
711
          All the CPs of the VNFC instance.
712
713
714
715
          Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance 
          or is connected to an external CP of the VNF instance.  
          A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. 
          A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL.
716
          May be present otherwise.
717
        type: array
718
        items:
719
          type: object
720
          required:
721
722
            - id
            - cpdId
723
          properties:
724
            id:
725
              description: >
726
727
728
729
                Identifier of this VNFC CP instance and the associated array
                entry.
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            cpdId:
730
              description: >
731
732
733
734
                Identifier of the VDU CPD, cpdId, in the VNFD.
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
            vnfExtCpId:
              description: >
735
736
737
738
                Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of
                the VNF instance or connected to an external CP of the VNF instance (see note) and shall be absent otherwise.

                NOTE: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes 
739
                an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL.
740
741
742
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            cpProtocolInfo:
              description: >
743
744
                Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP.
                The information can be omitted because it is already available as part of the external CP information.
745
              type: array
746
              items:
747
748
                $ref: "#/definitions/CpProtocolInfo"
            vnfLinkPortId:
749
              description: >
750
751
                Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if
                the CP is associated to a link port on an internal VL of the VNF instance and shall be absent otherwise.
752
753
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            metadata:
754
              description: >
755
756
757
                Metadata about this CP.
              $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      metadata:
758
        description: >
759
760
          Metadata about this resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
761

762
  VnfVirtualLinkResourceInfo:
763
    description: >
764
765
      This type represents the information that allows addressing a virtualised
      resource that is used by an internal VL instance in a VNF instance.
766
767
768
    type: object
    required:
      - id
769
770
      - vnfVirtualLinkDescId
      - networkResource
771
772
773
    properties:
      id:
        description: >
774
775
776
          Identifier of this VnfVirtualLinkResourceInfo instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfVirtualLinkDescId:
777
        description: >
778
779
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
780
781
782
783
784
785
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
786
      networkResource:
787
        description: >
788
789
          Reference to the VirtualNetwork resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
790
791
792
793
794
795
796
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced
          VirtualNetwork resource is placed. Shall be provided if this
          information is available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
797
      reservationId:
798
        description: >
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfLinkPorts:
        description: >
          Links ports of this VL.
          Shall be present when the linkPort is used for external connectivity
          by the VNF (refer to VnfLinkPortInfo).
          May be present otherwise.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
815

816
  VirtualStorageResourceInfo:
817
    description: >
818
819
      This type represents the information that allows addressing a virtualised
      resource that is used by a VNF instance.
820
821
822
    type: object
    required:
      - id
823
824
      - virtualStorageDescId
      - storageResource
825
826
827
    properties:
      id:
        description: >
828
829
830
          Identifier of this VirtualStorageResourceInfo instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      virtualStorageDescId:
831
        description: >
832
833
          Identifier of the VirtualStorageDesc in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
834
835
836
837
838
839
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
840
      storageResource:
841
        description: >
842
843
          Reference to the VirtualStorage resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
844
845
846
847
848
849
850
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced
          VirtualStorage resource is placed. Shall be provided if this
          information is available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
851
852
853
854
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
855
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
856
      metadata:
857
        description: >
858
859
860
861
862
863
864
865
866
867
          Metadata about this resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  VnfLinkPortInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
868
        description: >
869
870
871
872
          Identifier of this link port as provided by the entity that has created the link port.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      resourceHandle:
        description: >
873
          Reference to the virtualised resource realizing this link
874
875
876
877
878
879
880
881
          port.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
        description: >
          When the link port is used for external connectivity by the VNF,
          this attribute represents the identifier of the external CP of the
          VNF to be connected to this link port.
          When the link port is used for internal connectivity in the VNF,
882
          this attribute represents the identifier of the VNFC CP to be connected to this link
883
884
885
886
887
888
889
890
          port.
          Shall be present when the link port is used for external
          connectivity by the VNF.
          May be present if used to reference a VNFC CP instance.
          There shall be at most one link port associated with any external
          connection point instance or internal connection point
          (i.e. VNFC CP) instance.
          The value refers to an "extCpInfo" item in the VnfInstance or a
891
          "vnfcCpInfo" item of a "vnfcResourceInfo" item in the VnfInstance.
892
893
894
895
896
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      cpInstanceType:
        description: >
          Type of the CP instance that is identified by cpInstanceId.
          Shall be present if "cpInstanceId" is present, and shall be absent otherwise.
897
          Permitted values:
898
899
          VNFC_CP: The link port is connected to a VNFC CP
          EXT_CP: The link port is associated to an external CP.
900
901
        type: string
        enum:
902
903
904
905
906
907
908
909
910
911
912
913
914
          - VNFC_CP
          - EXT_CP

  ExtLinkPortInfo:
    description: >
      This type represents information about a link port of an external VL,
      i.e. a port providing connectivity for the VNF to an NS VL.
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
915
        description: >
916
917
          Identifier of this link port as provided by the entity that has
          created the link port.
918
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
919
      resourceHandle:
920
        description: >
921
922
923
924
          Reference to the virtualised resource realizing this link
          port.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
925
        description: >
926
927
928
929
930
931
932
933
934
935
          Identifier of the external CP of the VNF connected to this link
          port. There shall be at most one link port associated with any
          external connection point instance. The value refers to an
          "extCpInfo" item in the VnfInstance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"

  CpProtocolInfo:
    description: >
      This type describes the protocol layer(s) that a CP uses together with
      protocol-related information, like addresses.
936
    type: object
937
938
939
940
    required:
      - layerProtocol
    properties:
      layerProtocol:
941
        description: >
942
943
944
945
946
947
948
949
950
951
952
          The identifier of layer(s) and protocol(s) associated to the network
          address information.
          Permitted values: IP_OVER_ETHERNET
          This attribute allows to signal the addition of further types of
          layer and protocol in future versions of the present document in a
          backwards-compatible way. In the current version of the present
          document, only IP over Ethernet is supported.
        type: string
        enum:
          - IP_OVER_ETHERNET
      ipOverEthernet:
953
        description: >
954
955
956
957
958
959
960
961
962
963
          IP addresses over Ethernet to assign to the extCP instance. Shall be
          present if layerProtocol is equal to " IP_OVER_ETHERNET", and shall
          be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressInfo"

  IpOverEthernetAddressInfo:
    description: >
      This type represents information about a network address that has been
      assigned.
    type: object
964
965
966
967
968
969
970
971
972
973
    anyOf:
      - required:
          - macAddress
      - required:
          - ipAddresses
    oneOf:
      - required:
          - addresses
      - required:
          - addressRange
974
975
    properties:
      macAddress:
976
        description: >
977
978
979
          MAC address, if assigned.
          At least one of "macAddress" or "ipAddresses" shall be present.
        $ref: "SOL002SOL003_def.yaml#/definitions/MacAddress"
980
981
982
983
984
985
986
987
988
989
      segmentationId:
        description: >
          Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a
          subport in a trunk, segmentationId shall be present.  Otherwise it shall not be present.
          Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment
          value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an
          identifier used between the application and the NFVI networking infrastructure to identify the network
          sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local
          segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.
        type: string
990
      ipAddresses:
991
        description: >
992
993
994
          Addresses assigned to the CP instance. Each entry represents IP
          addresses assigned by fixed or dynamic IP address assignment per
          subnet.
995
          At least one of "macAddress" or "ipAddresses" shall be present.
996
997
        type: array
        items:
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
          type: object
          required:
            - type
          properties:
            type:
              description: >
                The type of the IP addresses.
                Permitted values: IPV4, IPV6.
              type: string
              enum:
                - IPV4
                - IPV6
            addresses:
              description: >
                Fixed addresses assigned (from the subnet defined by
                "subnetId" if provided).
                Exactly one of "addresses" or "addressRange" shall be present.
              type: array
              items:
                $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress"
            isDynamic:
              description: >
                Indicates whether this set of addresses was assigned
                dynamically (true) or based on address information provided as
                input from the API consumer (false). Shall be present if
                "addresses" is present and shall be absent otherwise.
              type: boolean
            addressRange:
              description: >
                An IP address range used, e.g., in case of egress connections.
                Exactly one of "addresses" or "addressRange" shall be present.
              type: object
              required:
                - minAddress
                - maxAddress
              properties:
                minAddress:
                  description: >
                    Lowest IP address belonging to the range.
                  $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress"
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
                  $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress"
            subnetId:
              description: >
                Subnet defined by the identifier of the subnet resource in
                the VIM.
                In case this attribute is present, IP addresses are bound
                to that subnet.
1048
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVim"
1049

1050
  MonitoringParameter:
1051
1052
    type: object
    required:
1053
1054
      - id
      - performanceMetric
1055
    properties:
1056
      id:
1057
        description: >
1058
1059
          Identifier of the monitoring parameter defined in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
1060
1061
1062
1063
1064
1065
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
1066
      name:
1067
        description: >
1068
1069
1070
1071
          Human readable name of the monitoring parameter, as defined in the
          VNFD.
        type: string
      performanceMetric:
1072
        description: >
1073
1074
1075
          Performance metric that is monitored. This attribute shall contain the
          related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
        type: string
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091

  LifecycleChangeNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications
      about VNF lifecycle changes.
      At a particular nesting level in the filter structure, the following
      applies: All attributes shall match in order for the filter to match
      (logical "and" between different filter attributes). If an attribute is
      an array, the attribute shall match if at least one of the values in
      the array matches (logical "or" between the values of one filter
      attribute).
    type: object
    properties:
      vnfInstanceSubscriptionFilter:
        description: >
          Filter criteria to select VNF instances about which to notify.
1092
        $ref: "SOL002SOL003_def.yaml#/definitions/VnfInstanceSubscriptionFilter"
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          * VnfLcmOperationOccurrenceNotification
          * VnfIdentifierCreationNotification
          * VnfIdentifierDeletionNotification
          The permitted values of the "notificationTypes" attribute are
          spelled exactly as the names of the notification types to
          facilitate automated code generation systems.
1103
1104
1105
1106
1107
1108
1109
        type: array
        items:
          type: string
          enum:
            - VnfLcmOperationOccurrenceNotification
            - VnfIdentifierCreationNotification
            - VnfIdentifierDeletionNotification
1110
1111
1112
1113
1114
1115
1116
1117
      operationTypes:
        description: >
          Match particular VNF lifecycle operation types for the notification
          of type VnfLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes" attribute contains the
          value "VnfLcmOperationOccurrenceNotification", and shall be absent
          otherwise.
        type: array
1118
        items:
1119
          $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType"
1120
1121
1122
1123
1124
1125
1126
1127
      operationStates:
        description: >
          Match particular LCM operation state values as reported in
          notifications of type VnfLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes" attribute contains the
          value "VnfLcmOperationOccurrenceNotification", and shall be absent
          otherwise.
        type: array
1128
        items:
1129
1130
          $ref: "#/definitions/LcmOperationStateType"

1131
1132
1133
  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
1134
      temporary VLs, and added or removed VNF link ports.
1135
1136
1137
    type: object
    required:
      - id
1138
1139
1140
      - vnfVirtualLinkDescId
      - changeType
      - networkResource
1141
1142
1143
    properties:
      id:
        description: >
1144
1145
1146
1147
          Identifier of the virtual link instance, identifying the applicable
          "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfVirtualLinkDescId:
1148
        description: >
1149
1150
          Identifier of the related VLD in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
1151
1152
1153
1154
1155
1156
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is
          associated to a VLD which is referred from the source or destination VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
1157
      changeType:
1158
        description: >
1159
1160
1161
1162
1163
1164
1165
1166
1167
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          * LINK_PORT_ADDED
          * LINK_PORT_REMOVED
          For a temporary resource, an AffectedVirtualLink structure exists as
          long as the temporary resource exists.
1168
1169
1170
1171
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers to the affected virtual link instance, not the link port instance.
          The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the
          "vnfLinkPortIds" attribute.
1172
        type: string
1173
1174
1175
1176
1177
1178
1179
1180
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
          - LINK_PORT_ADDED
          - LINK_PORT_REMOVED
      networkResource:
1181
        description: >
1182
1183
1184
          Reference to the VirtualNetwork resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
1185
1186
1187
1188
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers to the affected virtual link instance, not the link port instance.
          The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in
          the "vnfLinkPortIds" attribute.
1189
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
1190
1191
1192
      vnfLinkPortIds:
        description: >
          Identifiers of the link ports of the affected VL (reference to the vnfLinkPortInfo) related to the change.
1193
1194
1195
1196
1197
1198
1199
1200
1201
          Each identifier references a "VnfLinkPortInfo" structure.
          Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", and the related
          “VnfLinkPortInfo” structures are present (case "added") or have been present (case "removed") in the
          “VnfVirtualLinkResourceInfo” or "ExtManagedVirtualLinkInfo" structures that are represented by the
          "vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" attribute in the "VnfInstance" structure.
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers to the affected virtual link instance, not the link port instance.
          The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the
          "vnfLinkPortIds" attribute.
1202
1203
1204
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
1205
1206
1207
1208
1209
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange
          related to the LCM operation occurrence. It shall be present when an
          applicable GrantInfo for the granted resource exists.
1210
1211
1212
1213
1214
1215
1216
1217
          When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
          "networkResource" attribute refers to the affected virtual link instance, not the link port instance.
          The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the
          "vnfLinkPortIds" attribute.
          The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist 
          in correlating the resource changes performed during the LCM operation with the granted resources in a
          specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle 
          management operation occurrence" and the "id" in the "Individual Grant".
1218
1219
1220
1221
1222
1223
1224
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierLocal"
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced VirtualNetwork
          resource is placed. Shall be provided if this information is available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
1225
      metadata:
1226
        description: >
1227
1228
1229
1230
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VnfVirtualLinkResourceInfo structure.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
1231

1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
  AffectedExtLinkPort:
    description: >
      This type provides information about added and deleted external link ports (link ports attached to external virtual links).
    type: object
    required:
      - id
      - changeType
      - extCpInstanceId
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data
1245
          type (see clause 5.5.3.2).
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          -	ADDED
          -	REMOVED
        type: string
        enum:
          - ADDED
          - REMOVED
      extCpInstanceId:
        description: >
          Identifier of the related external CP instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      resourceHandle:
        description: >
          Reference to the link port resource.
          Detailed information is (for added resources) or has been (for removed resources) available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
1266
1267
1268
1269
1270
1271
1272
1273
1274
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. 
          It shall be present when an applicable GrantInfo for the granted resource exists.
          The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in
          correlating the resource changes performed during the LCM operation with the granted resources in a
          specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle
          management operation occurrence" and the "id" in the "Individual Grant".
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierLocal"
1275

1276
  AffectedVirtualStorage:
1277
    description: >
1278
1279
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
1280
1281
1282
    type: object
    required:
      - id
1283
      - virtualStorageDescId
1284
      - changeType
1285
      - storageResource
1286
1287
1288
    properties:
      id:
        description: >
1289
1290
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
1291
1292
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      virtualStorageDescId:
1293
        description: >
1294
          Identifier of the related VirtualStorage descriptor in the VNFD.
1295
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
1296
1297
1298
1299
1300
1301
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage
          instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
      changeType:
        description: >
          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
1317
1318
      storageResource:
        description: >
1319
1320
1321
1322
          Reference to the VirtualStorage resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange
          related to the LCM operation occurrence. It shall be present when an
          applicable GrantInfo for the granted resource exists.
          The "resourceDefinitionId" attribute provides information to the API
          consumer (i.e. the NFVO) to assist in correlating the resource changes
          performed during the LCM operation with the granted resources in a
          specific Grant exchange, which is identified by the "grantId" available
          in the "Individual VNF lifecycle management operation occurrence" and
          the "id" in the "Individual Grant".
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierLocal"
Francesca Moscatelli's avatar
Francesca Moscatelli committed
1335
1336
1337
1338
1339
1340
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced VirtualNetwork
          resource is placed. Shall be provided if this information is available from the VIM.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
      metadata:
        description: >
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  LccnLinks:
    description: >
      This type represents the links to resources that a notification can
      contain.
    type: object
    required:
      - vnfInstance
      - subscription
    properties:
      vnfInstance:
        description: >
          Link to the resource representing the VNF instance to which the
          notified change applies.
        $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
      subscription: