SOL005NSLifecycleManagement_def.yaml 245 KB
Newer Older
1
# Copyright (c) ETSI 2017.
2
3
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
4
5
6

  HealNsRequest:
    description: >
7
8
9
10
      This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
      instance, either by healing the complete NS instance or by healing one of more of the VNF instances that are part of this
      NS. It shall comply with the provisions defined in Table 6.5.2.13-1.
      Either the parameter healNsData or the parameter healVnfData, but not both shall be provided.
11
    type: object
12
13
14
15
16
    oneOf:
      - required:
          - healNsData
      - required:
          - healVnfData
17
18
19
    properties:
      healNsData:
        description: >
20
          Provides the information needed to heal an NS. See note
21
22
23
        $ref: "#/definitions/HealNsData"
      healVnfData:
        description: >
24
          Provides the information needed to heal a VNF. See note.
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
        type: array
        items:
          $ref: "#/definitions/HealVnfData"

  CancelMode:
    description: >
      This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. 
      It shall comply with the provisions defined in Table 6.5.2.16-1.
    type: object
    required:
      - cancelMode
    properties:
      cancelMode:
        description: >
          Cancellation mode to apply.
        $ref: "#/definitions/CancelModeType"

  HealNsData:
    description: >
      This type represents the information used to heal a NS. 
      It shall comply with the provisions defined in Table 6.5.3.43-1.
    type: object
    required:
      - degreeHealing
49
50
51
52
53
    oneOf:
      - required:
          - actionsHealing
      - required:
          - healScript
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
    properties:
      degreeHealing:
        description: >
          Indicates the degree of healing. Possible values
          include:
          - HEAL_RESTORE: Complete the healing of
          the NS restoring the state of the NS before
          the failure occurred
          - HEAL_QOS: Complete the healing of the NS
          based on the newest QoS values
          - HEAL_RESET: Complete the healing of the
          NS resetting to the original instantiation state of the NS
          - PARTIAL_HEALING
        type: string
        enum:
          - HEAL_RESTORE
          - HEAL_QOS
          - HEAL_RESET
          - PARTIAL_HEALING
      actionsHealing:
        description: >
          Used to specify dedicated healing actions in a
          particular order (e.g. as a script). The actionsHealing
          attribute can be used to provide a specific script whose
          content and actions might only be possible to be
          derived during runtime.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      healScript:
        description: >
          Reference to a script from the NSD that shall be used
          to execute dedicated healing actions in a particular
          order. The healScript, since it refers to a script in the
          NSD, can be used to execute healing actions which
          are defined during NS design time.
90
        $ref: "#/definitions/IdentifierInNsd"
91
92
93
94
95
96
97
98
99
      additionalParamsforNs:
        description: >
          Allows the OSS/BSS to provide additional
          parameter(s) to the healing process at the NS level.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  HealVnfData:
    description: >
      This type represents the information to heal a VNF that is part of an NS. 
100
      The NFVO shall then invoke the Heal VNF operation towards the appropriate VNFM.
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
      It shall comply with the provisions defined in Table 6.5.3.44-1.
    type: object
    required:
      - vnfInstanceId
    properties:
      vnfInstanceId:
        description: >
          Identifies the VNF instance, part of the NS, requiring a
          healing action.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      cause:
        description: >
          Indicates the reason why a healing procedure is required.
        type: string
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the healing process, specific to the VNF being healed.
          EXAMPLE: Input parameters to VNF-specific healing procedures.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  TerminateNsRequest:
    description: >
      This type represents a NS termination request. 
      It shall comply with the provisions defined in Table 6.5.2.15-1.
    type: object
    properties:
      terminationTime:
        description: >
          Timestamp indicating the end time of the NS, i.e. the NS
          will be terminated automatically at this timestamp.
          Cardinality "0" indicates the NS termination takes place immediately
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"

135
136
137
138
139
140
141
142
143
144
145
  CreateNsRequest:
    type: object
    required:
      - nsdId
      - nsName
      - nsDescription
    properties:
      nsdId:
        description: >
          Identifier of the NSD that defines the NS instance to be
          created.
146
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
147
148
149
150
151
152
153
154
      nsName:
        description: >
          Human-readable name of the NS instance to be created.
        type: string
      nsDescription:
        description: >
          Human-readable description of the NS instance to be created.
        type: string
155

156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  CancelModeType:
    description: >
      Cancellation mode.

      The NFVO shall not start any new VNF lifecycle management and resource
      management operation, and shall wait for the ongoing VNF lifecycle management
      and resource management operations in the underlying system, typically the VNFM
      and VIM, to finish execution or to time out. After that, the NFVO shall put the
      operation occurrence into the FAILED_TEMP state.

      The NFVO shall not start any new VNF lifecycle management and resource
      management operation, shall cancel the ongoing VNF lifecycle management and
      resource management operations in the underlying system, typically the VNFM and
      VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO
      shall put the operation occurrence into the FAILED_TEMP state.
    type: string
    enum:
      - GRACEFUL
      - FORCEFUL

176
177
178
179
180
181
182
183
184
185
186
187
  NsInstance:
    description: >
      This type represents a response for Query NS operation. 
      It shall comply with the provisions defined in Table 6.5.2.10-1.
    type: object
    required:
      - id
      - nsInstanceName
      - nsInstanceDescription
      - nsdId
      - nsdInfoId
      - nsState
188
      - _links
189
190
191
192
    properties:
      id:
        description: >
          Identifier of the NS instance.
193
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
194
195
196
197
198
199
200
201
202
203
      nsInstanceName:
        description: >
          Human readable name of the NS instance.
        type: string
      nsInstanceDescription:
        description: >
          Human readable description of the NS instance.
        type: string
      nsdId:
        description: >
204
          Identifier of the NSD on which the NS instance is based. The value is copied from the NSD.
205
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
206
207
208
      nsdInfoId:
        description: >
          Identifier of the NSD information object on which the
209
          NS instance is based. This identifier has been allocated by the NFVO.
210
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
211
212
213
214
215
      flavourId:
        description: >
          Identifier of the NS deployment flavor applied to
          the NS instance. This attribute shall be present if the nsState attribute
          value is INSTANTIATED.
216
        $ref: "#/definitions/IdentifierInNsd"
217
218
219
220
221
      vnfInstance:
        description: >
          Information on constituent VNF(s) of the NS instance.
        type: array
        items:
222
          $ref: "#/definitions/VnfInstance"
223
224
225
226
227
      pnfInfo:
        description: >
          Information on the PNF(s) that are part of the NS instance.
        type: array
        items:
228
          $ref: "#/definitions/PnfInfo"
229
230
231
232
233
234
235
236
      virtualLinkInfo:
        description: >
          Information on the VL(s) of the NS instance.
          This attribute shall be present if the nsState attribute
          value is INSTANTIATED and if the NS instance has
          specified connectivity.
        type: array
        items:
237
          $ref: "#/definitions/NsVirtualLinkInfo"
238
239
240
241
242
      vnffgInfo:
        description: >
          Information on the VNFFG(s) of the NS instance.
        type: array
        items:
243
          $ref: "#/definitions/VnffgInfo"
244
245
246
247
      sapInfo:
        description: >
          Information on the SAP(s) of the NS instance.
        type: array
248
        items:
249
250
251
252
253
          $ref: "#/definitions/SapInfo"
      nestedNsInstanceId:
        description: >
          Identifier of the nested NS(s) of the NS instance.
        type: array
254
        items:
255
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
256
257
258
259
260
261
      vnfSnapshotInfoIds:
        description: >
          Identifier of information on VNF snapshots of VNF instances that are part of this NS instance.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
262
263
264
265
266
267
268
269
      nsState:
        description: >
          The state of the NS instance.
          Permitted values:
          NOT_INSTANTIATED: The NS instance is
          terminated or not instantiated.
          INSTANTIATED: The NS instance is instantiated.
        type: string
270
        enum:
271
          - NOT_INSTANTIATED
272
          - INSTANTIATED
273
274
275
276
277
278
279
280
      monitoringParameter:
        description: >
          Performance metrics tracked by the NFVO (e.g. for
          auto-scaling purposes) as identified by the NS
          designer in the NSD.
        type: array
        items:
          $ref: "#/definitions/NsMonitoringParameter"
281
282
283
284
285
286
      nsScaleStatus:
        description: >
          Status of each NS scaling aspect declared in the
          applicable DF, how "big" the NS instance has been
          scaled w.r.t. that aspect.
          This attribute shall be present if the nsState attribute
287
          value is INSTANTIATED.
288
289
        type: array
        items:
290
          $ref: "#/definitions/NsScaleInfo"
291
292
293
294
295
296
      additionalAffinityOrAntiAffinityRule:
        description: >
          Information on the additional affinity or anti-affinity
          rule from NS instantiation operation. Shall not
          conflict with rules already specified in the NSD.
        type: array
297
        items:
298
          $ref: "#/definitions/AffinityOrAntiAffinityRule"
299
300
301
302
303
304
      wanConnectionInfo:
        description: >
          Information about WAN related connectivity enabling multi-site VLs.
        type: array
        items:
          $ref: "#/definitions/WanConnectionInfo"
305
306
      _links:
        type: object
307
        description: Links to resources related to this resource.
308
309
310
311
312
313
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
314
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
315
316
317
318
319
          nestedNsInstances:
            description: >
              Links to resources related to this notification.
            type: array
            items:
320
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
321
322
323
324
325
326
          vnfSnapshotInfos:
            description: >
              Links to the VNF snapshots associated to VNF instances which are part of this NS instance.
            type: array
            items:
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
327
328
329
330
331
332
          instantiate:
            description: >
              Link to the "instantiate" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance in
              NOT_INSTANTIATED state).
333
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
334
335
336
337
338
339
          terminate:
            description: >
              Link to the "terminate" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance is in
              INSTANTIATED state).
340
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
341
342
343
344
345
346
          update:
            description: >
              Link to the "update" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance is in
              INSTANTIATED state).
347
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
348
349
350
351
352
353
354
          scale:
            description: >
              Link to the "scale" task resource, if the related
              operation is supported for this NS instance, and is
              possible based on the current status of this NS
              instance resource (i.e. NS instance is in
              INSTANTIATED state).
355
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
356
357
358
359
360
361
362
          heal:
            description: >
              Link to the "heal" task resource, if the related
              operation is supported for this NS instance, and is
              possible based on the current status of this NS
              instance resource (i.e. NS instance is in
              INSTANTIATED state).
363
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
364

365
366
367
  VnfInstance:
    description: >
      This type represents a VNF instance.
368
369
370
      Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the
      different run-time information elements (CP, VL and link ports) used to represent the connectivity of a
      VNF.
371
372
373
374
375
376
377
378
379
380
381
382
383
384
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - vnfPkgId
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
385
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
386
387
388
      vnfInstanceName:
        description: >
          Name of the VNF instance.
389
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
390
391
392
393
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance.
394
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
395
396
397
398
        type: string
      vnfdId:
        description: >
          Identifier of the VNFD on which the VNF instance is based.
399
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
400
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
401
402
403
404
405
406
407
408
409
410
411
      vnfProvider:
        description: >
          Provider of the VNF and the VNFD. The value is copied from the VNFD.
        type: string
      vnfProductName:
        description: >
          Name to identify the VNF Product. The value is copied from the VNFD.
        type: string
      vnfSoftwareVersion:
        description: >
          Software version of the VNF. The value is copied from the VNFD.
412
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
413
414
415
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
416
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
417
418
      vnfPkgId:
        description: >
419
420
          Identifier of information held by the NFVO about
          the specific VNF package on which the VNF is
421
          based. This identifier has been allocated by the NFVO.
422
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
423
424
      vnfConfigurableProperties:
        description: >
425
426
427
428
429
430
431
432
433
434
435
436
          Additional VNF-specific attributes that provide the current values
          of the configurable properties of the VNF instance.

          These attributes represent values that are stored persistently in the
          VnfInstance structure and that correspond to configuration parameters
          of the VNF instance.
          Modifying these attributes affects the configuration of the VNF instance
          either directly(if the VNF instance is in INSTANTIATED state at the time
          of the modification) or as part of the subsequent VNF instantiation operation
          (if the VNF instance is in NOT_INSTANTIATED state at the time of the modification).

          Configurable properties referred in these attributes are declared in
437
          the VNFD.
438

439
440
441
442
443
444
445
446
447
448
449
450
451
          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
          based on TOSCA specifications.
          VNF configurable properties are sometimes also referred to as
          configuration parameters applicable to a VNF. Some of these are set
          prior to instantiation and cannot be modified if the VNF is
          instantiated, some are set prior to instantiation (are part of
          initial configuration) and can be modified later, and others can be
          set only after instantiation. The applicability of certain
          configuration may depend on the VNF and the required operation of
          the VNF at a certain point in time.
          These configurable properties include the following standard
          attributes, which are declared in the VNFD if auto-scaling and/or
          auto-healing are supported by the VNF: 
452
453
454
455
456
457
458
            - isAutoscaleEnabled: If present, the VNF supports auto-scaling. If
              set to true, auto-scaling is currently enabled. If set to false,
              auto-scaling is currently disabled.
            - isAutohealEnabled: If present, the VNF supports auto-healing. If
              set to true, auto-healing is currently enabled. If set to false,
              auto-healing is currently disabled.

459
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
460
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
461
462
463
      vimId:
        description: >
          Identifier of a VIM that manages resources for the VNF instance.
464
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
      instantiationState:
        description: >
          The instantiation state of the VNF.
        type: string
        enum:
          - NOT_INSTANTIATED
          - INSTANTIATED
      instantiatedVnfInfo:
        description: >
          Information specific to an instantiated VNF instance. This attribute
          shall be present if the instantiateState attribute value is INSTANTIATED.
        type: object
        required:
          - flavourId
          - vnfState
480
          - extCpInfo
481
482
483
484
        properties:
          flavourId:
            description: >
              Identifier of the VNF deployment flavor applied to this VNF instance.
485
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
486
487
488
489
490
491
492
493
494
495
496
          vnfState:
            description: >
              The state of the VNF instance.
            $ref: "#/definitions/VnfOperationalStateType"
          scaleStatus:
            description: >
              Scale status of the VNF, one entry per aspect. Represents for every
              scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
            type: array
            items:
              $ref: "#/definitions/VnfScaleInfo"
497
498
499
500
501
502
503
504
505
          maxScaleLevels:
            description: >
              Maximum allowed scale levels of the VNF, one
              entry per aspect.
              This attribute shall be present if the VNF
              supports scaling.
            type: array
            items:
              $ref: "#/definitions/VnfScaleInfo"
506
507
508
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance.
509
510
511
              When trunking is enabled, the list of entries includes both,
              external CPs corresponding to parent ports of a trunk, and external
              CPs associated to sub-ports of a trunk.
512
513
514
            type: array
            minItems: 1
            items:
515
              $ref: "#/definitions/VnfExtCpInfo"
516
517
518
519
520
521
522
523
524
          extVirtualLinkInfo:
            description: >
              Information about the external VLs the VNF instance is connected to.
            type: array
            items:
              $ref: "#/definitions/ExtVirtualLinkInfo"
          extManagedVirtualLinkInfo:
            description: >
              External virtual links the VNF instance is connected to.
525
526
527
528
              It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a multi-site
              VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same VNF internal VL
              shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance
              (refer to clause 6.5.3.59).
529
530
531
532
533
            type: array
            items:
              $ref: "#/definitions/ExtManagedVirtualLinkInfo"
          monitoringParameters:
            description: >
534
535
536
              Performance metrics tracked by the VNFM (e.g. for 
              auto-scaling purposes) as identified by the VNF 
              provider in the VNFD.
537
538
            type: array
            items:
539
              $ref: "#/definitions/VnfMonitoringParameter"
540
541
542
543
544
545
546
547
548
549
          localizationLanguage:
            description: >
              Information about localization language of the VNF (includes e.g.
              strings in the VNFD). The localization languages supported by a VNF
              can be declared in the VNFD, and localization language selection can
              take place at instantiation time.
              The value shall comply with the format defined in IETF RFC 5646.
            type: string
          vnfcResourceInfo:
            description: >
550
551
              Information about the virtualised compute and storage resources used
              by the VNFCs of the VNF instance.
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
            type: array
            items:
              $ref: "#/definitions/VnfcResourceInfo"
          virtualLinkResourceInfo:
            description: >
              Information about the virtualised network resources used by the VLs
              of the VNF instance.
            type: array
            items:
              $ref: "#/definitions/VnfVirtualLinkResourceInfo"
          virtualStorageResourceInfo:
            description: >
              Information on the virtualised storage resource(s) used as storage for the VNF instance.
            type: array
            items:
              $ref: "#/definitions/VirtualStorageResourceInfo"
      metadata:
        description: >
570
571
572
573
574
575
576
577
578
579
580
581
          Additional VNF-specific attributes that provide
          metadata describing the VNF instance.
          These attributes represent values that are
          stored persistently in the VnfInstance structure
          for consumption by functional blocks that
          invoke the VNF lifecycle management
          interface. They are not consumed by the
          VNFM, or the lifecycle management scripts.
          Modifying the values of these attributes has no
          effect on the VNF instance, it only affects the
          information represented in the VnfInstance
          structure.
582
583
          Metadata that the VNF provider foresees are expected to be declared in the VNFD.
          Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
584
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
585
586
      extensions:
        description: >
587
588
589
590
591
592
593
          Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
          These attributes represent values that are stored persistently in the VnfInstance structure
          for consumption by the VNFM, or by the lifecycle management scripts.  during the execution
          of VNF lifecycle management operations.
          Modifying the values of these attributes has no direct effect on the VNF instance; however,
          the modified attribute values can be considered during subsequent VNF lifecycle management
          operations, which means that the modified values can indirectly affect the configuration of the VNF instance.
594
595
          Extensions that are allowed for the VNF are declared in the VNFD.
          Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
596
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
597

598
599
  LccnLinks:
    type: object
600
    required:
601
      - nsInstance
602
    properties:
603
604
605
606
      nsInstance:
        description: >
          Link to the resource representing the NS instance to
          which the notified change applies..
607
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
608
609
610
      subscription:
        description: >
          Link to the subscription that triggered this notification.
611
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
612
      nslcmOpOcc:
613
614
615
616
        description: >
          Link to the lifecycle operation occurrence that this
          notification is related to. Shall be present if there is a
          related lifecycle operation occurrence
617
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
618

619
620
621
622
623
  VnfOperationalStateType:
    type: string
    enum:
      - STARTED
      - STOPPED
624

625
626
627
628
629
630
631
632
633
  VnfScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
634
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
635
636
637
638
639
640
      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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
      scaleLevel:
        description: >
          Indicates the scale level. The minimum value shall be 0 and the
          maximum value shall be <= maxScaleLevel as described in the VNFD.
        type: integer

  PnfInfo:
    description: >
      This type represents the information about a PNF that is part of an NS instance. 
      It shall comply with the provisions
      defined in Table 6.5.3.13-1.
    type: object
    required:
      - pnfId
      - pnfdId
      - pnfdInfoId
      - pnfProfileId
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
662
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
663
664
665
666
667
668
669
      pnfName:
        description: >
          Name of the PNF.
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
670
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
671
672
673
674
      pnfdInfoId:
        description: >
          Identifier of the PNFD information onject related to this
          PNF. This identifier is allocated by the NFVO
675
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
676
677
678
679
      pnfProfileId:
        description: >
          Identifier of the related PnfProfile in the NSD on which
          the PNF is based.
680
        $ref: "#/definitions/IdentifierInNsd"
681
682
683
684
      cpInfo:
        description: >
          Information on the external CP of the PNF.
        $ref: "#/definitions/PnfExtCpInfo"
685

686
687
688
689
690
691
692
693
694
695
696
697
698
  PnfExtCpInfo:
    description: >
      This type represents the information about the external CP of the PNF. 
      It shall comply with the provisions defined in
      Table 6.5.3.17-1.
    type: object
    required:
      - cpInstanceId
      - cpdId
    properties:
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
699
        $ref: "#/definitions/IdentifierInPnf"
700
701
702
703
      cpdId:
        description: >
          Identifier of (reference to) the Connection Point
          Descriptor (CPD) for this CP.
704
        $ref: "#/definitions/IdentifierInNsd"
705
706
707
708
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the CP.
        type: array
709
        items:
710
          $ref: "#/definitions/CpProtocolData"
711

712
713
714
715
716
717
718
719
720
  NsVirtualLinkInfo:
    description: >
      This type specifies the information about an NS VL instance. 
      It shall comply with the provisions defined in
      Table 6.5.3.53-1
    type: object
    required:
      - id
      - nsVirtualLinkDescId
721
      - nsVirtualLinkProfileId
722
723
724
725
    properties:
      id:
        description: >
          Identifier of the VL instance.
726
        $ref: "#/definitions/IdentifierInNs"
727
728
729
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD.
730
        $ref: "#/definitions/IdentifierInNsd"
731
732
733
      nsVirtualLinkProfileId:
        description: >
          Identifier of the VL profile in the NSD.
734
        $ref: "#/definitions/IdentifierInNsd"
735
736
      resourceHandle:
        description: >
737
738
739
740
741
742
743
          Identifier(s) of the virtualised network resource(s) and/or multi-site connectivity service(s)
          realizing the VL instance.
          As an NS can include NFs deployed in NFVI PoPs under the control of several different VIMs, therefore deploying
          an NS VL can involve several VIMs, each allocating different virtualised network resources, as well as WIMs
          handling the connectivity in between the NFVI-PoPs in the form of multi-site connectivity services. When this
          NsVirtualLink is provided as an ExtVirtualLink as input of a VNF LCM operation, the id of the ExtVirtualLink
          shall be the same as the corresponding NsVirtualLink.
744
        type: array
745
        items:
746
          $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
747
748
749
750
751
752
      linkPort:
        description: >
          Link ports of the VL instance.
          Cardinality of zero indicates that no port has yet been
          created for the VL instance.
        type: array
753
        items:
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
          $ref: "#/definitions/NsLinkPortInfo"

  VnffgInfo:
    description: >
      Information on the VNFFG(s) of the NS instance.
    type: object
    required:
      - id
      - vnffgdId
      - vnfInstanceId
      - pnfInfoId
    properties:
      id:
        description: >
          Identifier of this VNFFG instance.
769
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
770
771
772
      vnffgdId:
        description: >
          Identifier of the VNFFGD in the NSD.
773
        $ref: "#/definitions/IdentifierInNsd"
774
775
776
777
      vnfInstanceId:
        description: >
          Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
        type: array
778
        items:
779
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
780
781
782
783
784
      pnfdInfoId:
        description: >
          Identifier(s) of the constituent PNF instance(s) of this
          VNFFG instance.
        type: array
785
        items:
786
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
787
788
789
790
791
      nsVirtualLinkInfoId:
        description: >
          Identifier(s) of the constituent VL instance(s) of this
          VNFFG instance.
        type: array
792
        items:
793
          $ref: "#/definitions/IdentifierInNs"
794
795
796
797
798
799
      nsCpHandle:
        description: >
          Identifiers of the CP instances attached to the
          constituent VNFs and PNFs or the SAP instances of the
          VNFFG. See note.
        type: array
800
        items:
801
802
          $ref: "#/definitions/NsCpHandle"

803
804
805
806
807
808
809
810
811
812
813
814
815
  NfpInfo:
    description: >
      This type represents an NFP instance. It shall comply with 
      the provisions defined in Table 6.5.3.66-1.
    type: object
    required:
      - id
      - nfpRule
      - nfpState
    properties:
      id:
        description: >
          Identifier of this NFP instance.
816
        $ref: "#/definitions/IdentifierInNs"
817
818
819
820
821
      nfpdId:
        description: >
          Identifier of the NFPD used to instantiate this NFP
          instance. It shall be present if the NFP instance is
          instantiated from the NFPD.
822
        $ref: "#/definitions/IdentifierInNsd"
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
      nfpName:
        description: >
          Human readable name for the NFP instance.
        type: string
      description:
        description: >
          Human readable description for the NFP instance.
        type: string
      cpGroup:
        description: >
          Group(s) of CPs and/or SAPs which the NFP passes through.
          When multiple identifiers are included, the position of 
          the identifier in the CpGroup data type specifies the 
          position of the group in the path.
        type: array
        minItems: 1
        items:
          $ref: "#/definitions/NsCpHandle"
      totalCp:
        description: >
          Total number of CP and SAP instances in this NFP instance.
        type: integer
      nfpRule:
        description: >
          NFP classification and selection rule.
        $ref: "#/definitions/NfpRule"
      nfpState:
        description: >
          The state of the NFP instance.
          Permitted values:
          * ENABLED: The NFP instance is enabled.
          * DISABLED: The NFP instance is disabled.
        type: string
        enum:
          - ENABLED
          - DISABLED

860
861
862
863
864
  NsCpHandle:
    description: >
      This type represents an identifier of the CP or SAP instance. 
      It shall comply with the provisions defined in
      Table 6.5.3.56-1.
865
    type: object
866
867
868
869
870
871
872
873
874
875
    oneOf:
      - required:
          - vnfInstanceId
          - vnfExtCpInstanceId
      - required:
          - pnfInfoId
          - pnfExtCpInstanceId
      - required:
          - nsInstanceId
          - nsSapInstanceId
876
877
878
879
880
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance associated to the CP instance.
          This attribute shall be present if the CP instance is VNF external CP.
881
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
882
883
884
885
886
      vnfExtCpInstanceId:
        description: >
          Identifier of the VNF external CP instance in the scope
          of the VNF instance. This attribute shall be present if the CP instance is VNF
          external CP. See notes 1 and 4.
887
        $ref: "#/definitions/IdentifierInVnf"
888
889
890
891
892
      pnfInfoId:
        description: >
          Identifier of the PNF instance associated to the CP
          instance. This attribute shall be present if the CP instance is PNF
          external CP. See notes 2 and 4.          
893
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
894
895
896
897
898
      pnfExtCpInstanceId:
        description: >
          Identifier of the PNF external CP instance in the scope
          of the PNF. This attribute shall be present if the CP instance is PNF
          external CP. See notes 2 and 4.
899
        $ref: "#/definitions/IdentifierInPnf"
900
901
902
903
904
      nsInstanceId:
        description: >
          Identifier of the NS instance associated to the SAP
          instance. This attribute shall be present if the CP instance is NS
          SAP. See notes 3 and 4.           
905
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
906
907
908
909
910
      nsSapInstanceId:
        description: >
          Identifier of the SAP instance in the scope of the NS
          instance. This attribute shall be present if the CP instance is NS
          SAP. See notes 3 and 4.           
911
        $ref: "#/definitions/IdentifierInNs"
912

913
914
915
916
917
918
919
920
921
922
923
924
925
  SapInfo:
    description: >
      This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.
    type: object
    required:
      - id
      - sapdId
      - sapName
      - sapProtocolInfo
    properties:
      id:
        description: >
          Identifier of the SAP instance.
926
        $ref: "#/definitions/IdentifierInNs"
927
928
929
      sapdId:
        description: >
          Identifier of the SAPD in the NSD.
930
        $ref: "#/definitions/IdentifierInNsd"
931
932
933
934
935
936
937
938
939
940
941
942
      sapName:
        description: >
          Human readable name for the SAP instance.
        type: string
      description:
        description: >
          Human readable description for the SAP instance.
        type: string
      sapProtocolInfo:
        description: >
          Network protocol information for this SAP.
        type: array
943
        items:
944
          $ref: "#/definitions/CpProtocolInfo"
945

946
947
948
949
950
951
952
953
954
955
956
957
  NsMonitoringParameter:
    description: >
      This type represents a monitoring parameter that is tracked by the NFVO, for example, 
      for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1.
    type: object
    required:
      - id
      - performanceMetric
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the NSD.
958
        $ref: "#/definitions/IdentifierInNsd"
959
960
961
962
963
964
965
966
967
968
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the NSD.
        type: string
      performanceMetric:
        description: >
          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

969
970
971
972
973
974
975
976
977
978
979
980
  VnfMonitoringParameter:
    description: >
      This type represents a monitoring parameter that is tracked by the VNFM, for example, 
      for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1.
    type: object
    required:
      - id
      - performanceMetric
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
981
        $ref: "#/definitions/IdentifierInNsd"
982
983
984
985
986
987
      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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
988
989
990
991
992
993
994
995
996
997
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the VNFD.
        type: string
      performanceMetric:
        description: >
          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

998
999
1000
1001
1002
1003
1004
1005
  VnfExtCpInfo:
    description: >
      This type represents information about an external CP of a VNF. It shall comply 
      with the provisions defined in Table 6.5.3.70-1.
    type: object
    required:
      - id
      - cpdId
1006
    oneOf:
1007
1008
1009
1010
      - required:
        - associatedVnfcCpId
      - required:
        - associatedVnfVirtualLinkId
1011
1012
1013
1014
    properties:
      id:
        description: >
          Identifier of the external CP instance and the related information instance.
1015
        $ref: "#/definitions/IdentifierInVnf"
1016
1017
1018
      cpdId:
        description: >
          Identifier of the external CPD, VnfExtCpd, in the VNFD.
1019
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
      cpConfigId:
        description: >
          Identifier that references the applied "VnfExtCpConfig" entry in the "cpConfig"
          map of the "currentVnfExtCpData" in the "ExtVirtualLinkInfo" structure.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1032
1033
1034
1035
1036
1037
      cpProtocolInfo:
        description: >
          Network protocol information for this CP.
        type: array
        minItems: 1
        items:
1038
          $ref: "#/definitions/CpProtocolInfo"
1039
1040
1041
1042
1043
1044
1045
1046
      extLinkPortId:
        description: >
          Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" 
          structure. Shall be present if the CP is associated to a link port.
        $ref: "#/definitions/CpProtocolInfo"
      metadata:
        description: >
          Metadata about this external CP.
1047
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1048
1049
1050
1051
1052
1053
1054
      associatedVnfcCpId:
        description: >
          Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure 
          that represents the VNFC CP which is exposed by this external CP instance. 
          Shall be present in case this CP instance maps to a VNFC CP(s).
          The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are 
          mutually exclusive. One and only one shall be present.
1055
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1056
1057
1058
1059
1060
1061
1062
      associatedVnfVirtualLinkId:
        description: >
          Identifier of the "VnfVirtualLinkResourceInfo" structure that represents 
          the internal VL, which is exposed by this external CP instance. Shall be 
          present in case this CP instance maps to an internal VL.
          The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are 
          mutually exclusive. One and only one shall be present.
1063
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1064

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
  CpGroupInfo:
    description: >
      This type represents describes a group of CPs and/or SAPs pairs associated to 
      the same position in an NFP. It shall comply with the provisions defined in 
      Table 6.5.3.71-1.
    type: object
    properties:
      cpPairInfo:
        description: >
          One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by.
          All CP or SAP pairs in a group shall be instantiated from connection point 
          descriptors or service access point descriptors referenced in the corresponding 
          NfpPositionDesc.
        type: array
        minItems: 1
        items:
          $ref: "#/definitions/CpPairInfo"
      forwardingBehaviour:
        description: >
          Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of 
          the group.
          Permitted values:
          * ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs 
          of the group.
          * LB = Traffic flows shall be forwarded to one CP or SAP of the group selected 
          based on a loadbalancing algorithm.
        type: string
        enum:
          - ALL
          - LB
      forwardingBehaviourInputParameters:
        description: >
          Provides input parameters to configure the forwarding behaviour (e.g. identifies 
          a load balancing algorithm and criteria).
        $ref: "#/definitions/ForwardingBehaviourInputParameters"

1101
  CpPairInfo:
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
    description: >
      This type represents describes a pair of ingress and egress CPs or SAPs which 
      the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
    type: object
    properties:
      vnfExtCpIds:
        description: >
          Identifier(s) of the VNF CP(s) which form the pair.
          The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates 
          that the CP or SAP is used both as an ingress and egress port at a particular 
          NFP position.
        type: array
        maxItems: 2
        items:
1116
          $ref: "#/definitions/IdentifierInVnf"
1117
1118
1119
1120
1121
1122
1123
1124
1125
      pnfExtCpIds:
        description: >
          Identifier(s) of the PNF CP(s) which form the pair.
          The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates 
          that the CP or SAP is used both as an ingress and egress port at a particular 
          NFP position.
        type: array
        maxItems: 2
        items:
1126
          $ref: "#/definitions/IdentifierInPnf"
1127
1128
1129
1130
1131
1132
1133
1134
1135
      sapIds:
        description: >
          Identifier(s) of the SAP(s) which form the pair.
          The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates 
          that the CP or SAP is used both as an ingress and egress port at a particular 
          NFP position.
        type: array
        maxItems: 2
        items:
1136
          $ref: "#/definitions/IdentifierInNs"
1137

1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
  ForwardingBehaviourInputParameters:
    description: >
      This type represents provides input parameters to configure the forwarding behaviour. 
      It shall comply with the provisions defined in Table 6.5.3.73-1.
    type: object
    properties:
      algortihmName:
        description: >
          May be included if forwarding behaviour is equal to LB. Shall not be included otherwise.
          Permitted values:
          * ROUND_ROBIN
          * LEAST_CONNECTION
          * LEAST_TRAFFIC
          * LEAST_RESPONSE_TIME
          * CHAINED_FAILOVER
          * SOURCE_IP_HASH
          * SOURCE_MAC_HASH
        type: string
        enum:
          - ROUND_ROBIN
          - LEAST_CONNECTION
          - LEAST_TRAFFIC
          - LEAST_RESPONSE_TIME
          - CHAINED_FAILOVER
          - SOURCE_IP_HASH
1163
          - SOURCE_MAC_HASH
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
      algorithmWeights:
        description: >
          Percentage of messages sent to a CP instance. May be included if applicable to 
          the algorithm.
          If applicable to the algorithm but not provided, default values determined by 
          the VIM or NFVI are expected to be used.
          Weight applies to the CP instances in the order they have been created.
        type: array
        items:
          type: integer

1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
  CpProtocolInfo:
    description: >
      This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like
      addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.
    type: object
    required:
      - layerProtocol
      - ipOverEthernet
    properties:
      layerProtocol:
        description: >
          The identifier of layer(s) and protocol(s)
          associated to the network address information.
          Permitted values: IP_OVER_ETHERNET See note.
        type: string
        enum:
          - IP_OVER_ETHERNET
      ipOverEthernet:
        description: >
          IP addresses over Ethernet to assign to the CP
          or SAP instance. Shall be present if
          layerProtocol is equal to "
          IP_OVER_ETHERNET", and shall be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressInfo"

  IpOverEthernetAddressInfo:
1201
1202
1203
1204
    description: >
      This type represents information about a network address that has been assigned.
      It shall comply with the provisions defined in Table 6.5.3.18-1.
    type: object
1205
1206
1207
1208
1209
    anyOf:
      - required:
        - macAddress
      - required:
        - ipAddresses
1210
1211
1212
1213
    properties:
      macAddress:
        description: >
          Assigned MAC address.
1214
        $ref: "#/definitions/MacAddress"
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
      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
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
      ipAddresses:
        description: >
          Addresses assigned to the CP instance. Each entry represents IP
          addresses assigned by fixed or dynamic IP address assignment per
          subnet.
        type: array
        items:
          type: object
          required:
            - type
1236
1237
1238
1239
1240
          oneOf:
            - required:
                - addresses
            - required:
                - addressRange
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
          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).
              type: array
              items:
1256
                $ref: "#/definitions/IpAddress"
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
            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.
1276
                  $ref: "#/definitions/IpAddress"
1277
1278
1279
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
1280
                  $ref: "#/definitions/IpAddress"
1281
1282
1283
1284
1285
1286
            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.
1287
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah's avatar
Samir Medjiah committed
1288
1289


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
      type:
        description: >
          The type of the IP addresses
        type: string
        enum:
          - PV4
          - PV6
      addresses:
        description: >
          Fixed addresses assigned (from the subnet
          defined by "subnetId" if provided). See note.
        type: array
        items:
1303
        $ref: "#/definitions/IpAddress"
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
      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. See note.
        type: object
        required:
          - minAddress
          - maxAddress
        properties:
          minAddress:
            description: >
              Lowest IP address belonging to the range.
1324
            $ref: "#/definitions/IpAddress"
1325
1326
1327
          maxAddress:
            description: >
              Highest IP address belonging to the range
1328
            $ref: "#/definitions/IpAddress"
1329
1330
1331
      minAddress:
        description: >
          Lowest IP address belonging to the range
1332
        $ref: "#/definitions/IpAddress"
1333
1334
1335
      maxAddress:
        description: >
          Highest IP address belonging to the range.
1336
        $ref: "#/definitions/IpAddress"
1337
1338
1339
1340
1341
1342
      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.
1343
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
1344

1345
1346
1347
1348
1349
1350
1351
  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
1352
1353
1354
1355
1356
        description: >
          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.
1357
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1358
1359
1360
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
1361
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1362
1363
1364
1365
1366
1367
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"
1368
1369
1370
1371
1372
1373
      currentVnfExtCpData:
        description: >
          Allows the API consumer to read the current CP configuration information
          for the connection of external CPs to the external virtual link, as
          specified in clause 5.5.3.2 of ETSI GS NFV-SOL 003.
        $ref: "#/definitions/VnfExtCpData"
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387

  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:
        description: >
          Identifier of this link port as provided by the entity that has
          created the link port.
1388
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1389
1390
1391
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
1392
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1393
1394
1395
1396
1397
1398
      cpInstanceId:
        description: >
          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.
1399
        $ref: "#/definitions/IdentifierInVnf"
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412

  ExtManagedVirtualLinkInfo:
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
    properties:
      id:
        description: >
          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.
1413
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1414
1415
1416
1417
1418
1419
      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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1420
1421
1422
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1423
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1424
1425
      networkResource:
        description: >
1426
          Reference to the VirtualNetwork resource or multi-site connectivity service providing this VL.
1427
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1428
1429
1430
1431
1432
1433
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
1434
1435
1436
1437
1438
1439
1440
1441
      extManagedMultisiteVirtualLinkId:
        description: >
          Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFV-MANO entity
          that manages the externally managed multi-site VL instance. It shall be present when the present 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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451

  VnfLinkPortInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that has created the link port.
1452
        $ref: "#/definitions/IdentifierInVnf"
1453
1454
      resourceHandle:
        description: >
1455
          Reference to the virtualised resource realizing this link port.
1456
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"