SOL005NSLifecycleManagement_def.yaml 160 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
12
13
14
    type: object
    properties:
      healNsData:
        description: >
15
          Provides the information needed to heal an NS. See note
16
17
18
        $ref: "#/definitions/HealNsData"
      healVnfData:
        description: >
19
          Provides the information needed to heal a VNF. See note.
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
        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
    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.
80
        $ref: "#/definitions/IdentifierInNsd"
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
      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. 
      The NFVO shall then invoke the HealVNF
      operation towards the appropriate VNFM. 
      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"

126
127
128
129
130
131
132
133
134
135
136
  CreateNsRequest:
    type: object
    required:
      - nsdId
      - nsName
      - nsDescription
    properties:
      nsdId:
        description: >
          Identifier of the NSD that defines the NS instance to be
          created.
137
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
138
139
140
141
142
143
144
145
      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
146

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
  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

167
168
169
170
171
172
173
174
175
176
177
178
  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
179
      - _links
180
181
182
183
    properties:
      id:
        description: >
          Identifier of the NS instance.
184
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
185
186
187
188
189
190
191
192
193
194
195
      nsInstanceName:
        description: >
          Human readable name of the NS instance.
        type: string
      nsInstanceDescription:
        description: >
          Human readable description of the NS instance.
        type: string
      nsdId:
        description: >
          Identifier of the NSD on which the NS instance is based.
196
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
197
198
199
      nsdInfoId:
        description: >
          Identifier of the NSD information object on which the
200
          NS instance is based. This identifier has been allocated by the NFVO.
201
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
202
203
204
205
206
      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.
207
        $ref: "#/definitions/IdentifierInNsd"
208
209
210
211
212
      vnfInstance:
        description: >
          Information on constituent VNF(s) of the NS instance.
        type: array
        items:
213
          $ref: "#/definitions/VnfInstance"
214
215
216
217
218
      pnfInfo:
        description: >
          Information on the PNF(s) that are part of the NS instance.
        type: array
        items:
219
          $ref: "#/definitions/PnfInfo"
220
221
222
223
224
225
226
227
      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:
228
          $ref: "#/definitions/NsVirtualLinkInfo"
229
230
231
232
233
      vnffgInfo:
        description: >
          Information on the VNFFG(s) of the NS instance.
        type: array
        items:
234
          $ref: "#/definitions/VnffgInfo"
235
236
237
238
      sapInfo:
        description: >
          Information on the SAP(s) of the NS instance.
        type: array
239
        items:
240
241
242
243
244
          $ref: "#/definitions/SapInfo"
      nestedNsInstanceId:
        description: >
          Identifier of the nested NS(s) of the NS instance.
        type: array
245
        items:
246
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
247
248
249
250
251
252
253
254
      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
255
        enum:
256
          - NOT_INSTANTIATED
257
          - INSTANTIATED
258
259
260
261
262
263
264
265
      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"
266
267
268
269
270
271
      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
272
          value is INSTANTIATED.
273
274
        type: array
        items:
275
          $ref: "#/definitions/NsScaleInfo"
276
277
278
279
280
281
      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
282
        items:
283
284
285
          $ref: "#/definitions/AffinityOrAntiAffinityRule"
      _links:
        type: object
286
        description: Links to resources related to this resource.
287
288
289
290
291
292
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
293
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
294
295
296
297
298
          nestedNsInstances:
            description: >
              Links to resources related to this notification.
            type: array
            items:
299
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
300
301
302
303
304
305
          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).
306
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
307
308
309
310
311
312
          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).
313
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
314
315
316
317
318
319
          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).
320
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
321
322
323
324
325
326
327
          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).
328
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
329
330
331
332
333
334
335
          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).
336
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
337

338
339
340
  VnfInstance:
    description: >
      This type represents a VNF instance.
341
342
343
      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.
344
345
346
347
348
349
350
351
352
353
354
355
356
357
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - vnfPkgId
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
358
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
359
360
361
362
363
364
365
366
367
368
369
370
371
      vnfInstanceName:
        description: >
          Name of the VNF instance.
          This attribute can be modified with the PATCH method.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance.
          This attribute can be modified with the PATCH method.
        type: string
      vnfdId:
        description: >
          Identifier of the VNFD on which the VNF instance is based.
372
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
373
374
375
376
377
378
379
380
381
382
383
      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.
384
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
385
386
387
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
388
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
389
390
      vnfPkgId:
        description: >
391
392
          Identifier of information held by the NFVO about
          the specific VNF package on which the VNF is
393
          based. This identifier has been allocated by the NFVO.
394
395
          This attribute can be modified with the PATCH
          method.
396
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
397
398
      vnfConfigurableProperties:
        description: >
399
400
401
402
403
404
405
406
407
408
409
410
          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
411
          the VNFD.
412

413
414
415
416
417
418
419
420
421
422
423
424
425
          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: 
426
427
428
429
430
431
432
433
            - 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.

          These attributea can be modified with the PATCH method.
434
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
435
436
437
      vimId:
        description: >
          Identifier of a VIM that manages resources for the VNF instance.
438
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
      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
454
          - extCpInfo
455
456
457
458
        properties:
          flavourId:
            description: >
              Identifier of the VNF deployment flavor applied to this VNF instance.
459
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
460
461
462
463
464
465
466
467
468
469
470
          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"
471
472
473
474
475
476
477
478
479
          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"
480
481
482
483
484
485
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance.
            type: array
            minItems: 1
            items:
486
              $ref: "#/definitions/VnfExtCpInfo"
487
488
489
490
491
492
493
494
495
496
497
498
499
500
          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.
            type: array
            items:
              $ref: "#/definitions/ExtManagedVirtualLinkInfo"
          monitoringParameters:
            description: >
501
502
503
              Performance metrics tracked by the VNFM (e.g. for 
              auto-scaling purposes) as identified by the VNF 
              provider in the VNFD.
504
505
            type: array
            items:
506
              $ref: "#/definitions/VnfMonitoringParameter"
507
508
509
510
511
512
513
514
515
516
          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: >
517
518
              Information about the virtualised compute and storage resources used
              by the VNFCs of the VNF instance.
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
            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: >
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
          Additional VNF-specific attributes that provide
          metadata describing the VNF instance.
          Metadata that are writeable are declared in the
          VNFD (see note 2).
          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.
          Metadata that are writeable are declared in the
          VNFD (see note 2).
          These attributes can be modified with the
          PATCH method
555
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
556
557
      extensions:
        description: >
558
559
560
561
562
563
564
          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.
565
          Extensions that are writeable are declared in the VNFD.
566
567
          This attribute These attributes can be modified with the PATCH method.
          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
568
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
569

570
571
572
573
  LccnLinks:
    description: >
      This type represents the links to resources that a notification can contain.
    type: object
574
    required:
575
      - nsInstance
576
    properties:
577
578
579
580
      nsInstance:
        description: >
          Link to the resource representing the NS instance to
          which the notified change applies..
581
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
582
583
584
      subscription:
        description: >
          Link to the subscription that triggered this notification.
585
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
586
      nslcmOpOcc:
587
588
589
590
        description: >
          Link to the lifecycle operation occurrence that this
          notification is related to. Shall be present if there is a
          related lifecycle operation occurrence
591
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
592

593
594
595
596
597
  VnfOperationalStateType:
    type: string
    enum:
      - STARTED
      - STOPPED
598

599
600
601
602
603
604
605
606
607
  VnfScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
608
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
      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.
630
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
631
632
633
634
635
636
637
      pnfName:
        description: >
          Name of the PNF.
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
638
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
639
640
641
642
      pnfdInfoId:
        description: >
          Identifier of the PNFD information onject related to this
          PNF. This identifier is allocated by the NFVO
643
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
644
645
646
647
      pnfProfileId:
        description: >
          Identifier of the related PnfProfile in the NSD on which
          the PNF is based.
648
        $ref: "#/definitions/IdentifierInNsd"
649
650
651
652
      cpInfo:
        description: >
          Information on the external CP of the PNF.
        $ref: "#/definitions/PnfExtCpInfo"
653

654
655
656
657
658
659
660
661
662
663
664
665
666
  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.
667
        $ref: "#/definitions/IdentifierInPnf"
668
669
670
671
      cpdId:
        description: >
          Identifier of (reference to) the Connection Point
          Descriptor (CPD) for this CP.
672
        $ref: "#/definitions/IdentifierInNsd"
673
674
675
676
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the CP.
        type: array
677
        items:
678
          $ref: "#/definitions/CpProtocolData"
679

680
681
682
683
684
685
686
687
688
  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
689
      - nsVirtualLinkProfileId
690
691
692
693
    properties:
      id:
        description: >
          Identifier of the VL instance.
694
        $ref: "#/definitions/IdentifierInNs"
695
696
697
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD.
698
        $ref: "#/definitions/IdentifierInNsd"
699
700
701
      nsVirtualLinkProfileId:
        description: >
          Identifier of the VL profile in the NSD.
702
        $ref: "#/definitions/IdentifierInNsd"
703
704
705
706
707
      resourceHandle:
        description: >
          Identifier(s) of the virtualised network resource(s)
          realizing the VL instance. See note.
        type: array
708
        items:
709
          $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
710
711
712
713
714
715
      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
716
        items:
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
          $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.
732
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
733
734
735
      vnffgdId:
        description: >
          Identifier of the VNFFGD in the NSD.
736
        $ref: "#/definitions/IdentifierInNsd"
737
738
739
740
      vnfInstanceId:
        description: >
          Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
        type: array
741
        items:
742
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
743
744
745
746
747
      pnfdInfoId:
        description: >
          Identifier(s) of the constituent PNF instance(s) of this
          VNFFG instance.
        type: array
748
        items:
749
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
750
751
752
753
754
      nsVirtualLinkInfoId:
        description: >
          Identifier(s) of the constituent VL instance(s) of this
          VNFFG instance.
        type: array
755
        items:
756
          $ref: "#/definitions/IdentifierInNs"
757
758
759
760
761
      nsCpHandle:
        description: >
          Identifiers of the CP instances attached to the
          constituent VNFs and PNFs or the SAP instances of the
          VNFFG. See note.
Giacomo Bernini's avatar
Giacomo Bernini committed
762
        $ref: "#/definitions/NsCpHandle"
763

764
765
766
767
768
769
770
771
772
773
774
775
776
  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.
777
        $ref: "#/definitions/IdentifierInNs"
778
779
780
781
782
      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.
783
        $ref: "#/definitions/IdentifierInNsd"
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
      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:
Giacomo Bernini's avatar
Giacomo Bernini committed
801
          $ref: "#/definitions/CpGroupInfo"
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
      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

821
822
823
824
825
  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.
826
    type: object
827
828
829
830
831
    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.
832
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
833
834
835
836
837
      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.
838
        $ref: "#/definitions/IdentifierInVnf"
839
840
841
842
843
      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.          
844
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
845
846
847
848
849
      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.
850
        $ref: "#/definitions/IdentifierInPnf"
851
852
853
854
855
      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.           
856
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
857
858
859
860
861
      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.           
862
        $ref: "#/definitions/IdentifierInNs"
863

864
865
866
867
868
869
870
871
872
873
874
875
876
  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.
877
        $ref: "#/definitions/IdentifierInNs"
878
879
880
      sapdId:
        description: >
          Identifier of the SAPD in the NSD.
881
        $ref: "#/definitions/IdentifierInNsd"
882
883
884
885
886
887
888
889
890
891
892
893
      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
894
        items:
895
          $ref: "#/definitions/CpProtocolInfo"
896

897
898
899
900
901
902
903
904
905
906
907
908
  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.
909
        $ref: "#/definitions/IdentifierInNsd"
910
911
912
913
914
915
916
917
918
919
      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

920
921
922
923
924
925
926
927
928
929
930
931
  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.
932
        $ref: "#/definitions/IdentifierInNsd"
933
934
935
936
937
938
939
940
941
942
      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

943
944
945
946
947
948
949
950
951
952
953
954
  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
    properties:
      id:
        description: >
          Identifier of the external CP instance and the related information instance.
955
        $ref: "#/definitions/IdentifierInVnf"
956
957
958
      cpdId:
        description: >
          Identifier of the external CPD, VnfExtCpd, in the VNFD.
959
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
960
961
962
963
964
965
      cpProtocolInfo:
        description: >
          Network protocol information for this CP.
        type: array
        minItems: 1
        items:
966
          $ref: "#/definitions/CpProtocolInfo"
967
968
969
970
971
972
973
974
      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.
975
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
976
977
978
979
980
981
982
      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.
983
        $ref: "#/definitions/IdentifierInVnf"
984
985
986
987
988
989
990
      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.
991
        $ref: "#/definitions/IdentifierInVnf"
992

993
994
995
996
997
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
  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"

1029
  CpPairInfo:
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
    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:
1044
          $ref: "#/definitions/IdentifierInVnf"
1045
1046
1047
1048
1049
1050
1051
1052
1053
      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:
1054
          $ref: "#/definitions/IdentifierInPnf"
1055
1056
1057
1058
1059
1060
1061
1062
1063
      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:
1064
          $ref: "#/definitions/IdentifierInNs"
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
  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
1091
          - SOURCE_MAC_HASH
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
      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

1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
  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:
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
    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
    required:
      - macAddress
      - ipAddresses
    properties:
      macAddress:
        description: >
          Assigned MAC address.
1140
        $ref: "#/definitions/MacAddress"
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
      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
          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:
1166
                $ref: "#/definitions/IpAddress"
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
            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.
1186
                  $ref: "#/definitions/IpAddress"
1187
1188
1189
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
1190
                  $ref: "#/definitions/IpAddress"
1191
1192
1193
1194
1195
1196
            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.
1197
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah's avatar
Samir Medjiah committed
1198
1199


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
      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:
1213
        $ref: "#/definitions/IpAddress"
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
      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.
1234
            $ref: "#/definitions/IpAddress"
1235
1236
1237
          maxAddress:
            description: >
              Highest IP address belonging to the range
1238
            $ref: "#/definitions/IpAddress"
1239
1240
1241
      minAddress:
        description: >
          Lowest IP address belonging to the range
1242
        $ref: "#/definitions/IpAddress"
1243
1244
1245
      maxAddress:
        description: >
          Highest IP address belonging to the range.
1246
        $ref: "#/definitions/IpAddress"
1247
1248
1249
1250
1251
1252
      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.
1253
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
1254

1255
1256
1257
1258
1259
1260
1261
  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
1262
1263
1264
1265
1266
        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.
1267
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1268
1269
1270
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
1271
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"

  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.
1292
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1293
1294
1295
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
1296
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1297
1298
1299
1300
1301
1302
      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.
1303
        $ref: "#/definitions/IdentifierInVnf"
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316

  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.
1317
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1318
1319
1320
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1321
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1322
1323
1324
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
1325
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"

  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.
1342
        $ref: "#/definitions/IdentifierInVnf"
1343
1344
1345
      resourceHandle:
        description: >
          Reference to the virtualised network resource realizing this link port.
1346
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
      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,
          this attribute represents the VNFC CP to be connected to this link
          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
          "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance.
1363
        $ref: "#/definitions/IdentifierInVnf"
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
      cpInstanceType:
        description: >
          Type of the CP instance that is identified by cpInstanceId.
          Shall be present if "cpInstanceId" is present, and shall be
          absent otherwise.
          Permitted values:
          * VNFC_CP: The link port is connected to a VNFC CP
          * EXT_CP: The link port is associated to an external CP.
        type: string
        enum:
          - VNFC_CP
          - EXT_CP
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386

  MonitoringParameter:
    type: object
    required:
      - id
      - value
      - timeStamp
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
1387
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1388
1389
1390
1391
1392
1393
1394
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the VNFD.
        type: string
      value:
        description: >
          Value of the monitoring parameter known to the VNFM (e.g. obtained
1395
          for auto-scaling purposes).
1396
1397
1398
1399
          The type of the "value" attribute (i.e. scalar, structure (Object in
          JSON), or array (of scalars, arrays or structures/Objects)) is
          assumed to be defined in an external measurement specification.
        type: object
1400
1401
1402
1403
1404
1405
      timeStamp:
        description: >
          Represents the point in time when the measurement has been performed,
          as known to the VNFM.
          Should be formatted according to ETF RFC 3339.
        type: string
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419

  VnfcResourceInfo:
    description: >
      This type represents the information on virtualised compute and storage
      resources used by a VNFC in a VNF instance.
    type: object
    required:
      - id
      - vduId
      - computeResource
    properties:
      id:
        description: >
          Identifier of this VnfcResourceInfo instance.
1420
        $ref: "#/definitions/IdentifierInVnf"
1421
1422
1423
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
1424
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1425
1426
1427
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
1428
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1429
1430
1431
1432
1433
1434
      storageResourceIds:
        description: >
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
        type: array
        items:
1435
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1436
1437
1438
1439
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1440
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
      vnfcCpInfo:
        description: >
          CPs of the VNFC instance.
          Shall be present when that particular CP of the VNFC instance is
          associated to an external CP of the VNF instance.
          May be present otherwise.
        type: array
        items:
          type: object
          required:
            - id
            - cpdId
          properties:
            id:
              description: >
                Identifier of this VNFC CP instance and the associated array
                entry.
1458
              $ref: "#/definitions/IdentifierInVnf"
1459
1460
1461
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
1462
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1463
1464
1465
1466
            vnfExtCpId:
              description: >
                When the VNFC CP is exposed as external CP of the VNF, the
                identifier of this external VNF CP.
1467
              $ref: "#/definitions/IdentifierInVnf"
1468
1469
1470
1471
1472
1473
1474
1475
1476
            cpProtocolInfo:
              description: >
                Network protocol information for this CP.
              type: array
              items:
                $ref: "#/definitions/CpProtocolInfo"
            vnfLinkPortId:
              description: >
                Identifier of the "vnfLinkPorts" structure in the
1477
                "VnfVirtualLinkResourceInfo" structure. Shall be present if
1478
                the CP is associated to a link port.
1479
              $ref: "#/definitions/IdentifierInVnf"
1480
1481
1482
            metadata:
              description: >
                Metadata about this CP.
1483
              $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1484
1485
1486
      metadata:
        description: >
          Metadata about this resource.
1487
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1488
1489

  VnfVirtualLinkResourceInfo: