etsi-nfv-common.yang 31.8 KB
Newer Older
1
submodule etsi-nfv-common {
2
  yang-version 1.1;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
3
  belongs-to etsi-nfv-descriptors {
4
5
    prefix nfv;
  }
6
7
8
9
10
11
12

  import ietf-yang-types {
    prefix yang;
    reference
      "RFC 6991: Common YANG Data Types.";
  }

13
14
15
  organization
    "European Telecommunications Standards Institute (ETSI)";

16
  description
17
    "Common data types for ETSI data models.";
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

	revision 2022-03-08 {
    description
      "Version 3.6.1.

       Common data structures to support VNFD and NSD according to:
       ETSI GS NFV-IFA 014 Release 3
       ETSI GS NFV-IFA 011 Release 3.";
  }
	revision 2021-07-05 {
    description
      "Version 3.5.1.

       Common data structures to support VNFD and NSD according to:
       ETSI GS NFV-IFA 014 Release 3
       ETSI GS NFV-IFA 011 Release 3.";
  }
35

36
  revision 2020-06-10 {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
37
    description
38
      "Version 3.3.1.
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
39
40

       Common data structures to support VNFD and NSD according to:
41
42
       ETSI GS NFV-IFA 014 Release 3
       ETSI GS NFV-IFA 011 Release 3.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
43
44
  }

45
46
47
48
49
50
51
52
53
  revision 2020-06-01 {
    description
      "Version 2.8.1.

       Common data structures to support VNFD and NSD according to:
       ETSI GS NFV-IFA 014 271
       ETSI GS NFV-IFA 011 271.";
  }

Mahesh Jethanandani's avatar
Bug#251    
Mahesh Jethanandani committed
54
55
56
57
58
59
60
61
  revision 2019-10-01 {
    description
      "Version 2.7.1.

       Common data structures to support VNFD and NSD according to:
       ETSI GS NFV-IFA 014 Ed271v264
       ETSI GS NFV-IFA 011 Ed271v264";
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
62

63
  revision 2019-04-25 {
64
65
66
    description
      "Initial revision

67
       Common data structures to support VNFD and NSD according to:
68
69
       ETSI GS NFV-IFA 014 Ed261v252
       ETSI GS NFV-IFA 011 Ed261v254";
70
71
72
73
74
75
76
  }

  /*
   * Identities.
   */
  identity layer-protocol {
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
77
  identity ethernet {
78
79
    base layer-protocol;
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
80
  identity mpls {
81
82
    base layer-protocol;
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
83
  identity odu2 {
84
85
    base layer-protocol;
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
86
  identity ipv4 {
87
88
    base layer-protocol;
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
89
  identity ipv6 {
90
91
    base layer-protocol;
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
92
  identity pseudo-wire {
93
94
95
96
97
    base layer-protocol;
  }

  identity address-type {
    description
98
      "Describes the type of the address to be assigned to the CP
99
100
101
102
103
       instantiated from the parent CPD.
       Value:
       • MAC address.
       • IP address.
       • …
104
       The content type shall be aligned with the address type
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
       supported by the layerProtocol attribute of the parent CPD.";
    reference
      "GS NFV IFA011: Section 7.1.3.3, AddressData information
       element.";
  }
  identity mac-address {
    base address-type;
  }
  identity ip-address {
    base address-type;
  }

  identity supported-operation {
    description
      "Indicates which operations are available for this DF via the
       VNF LCM interface. Instantiate VNF, Query VNF and Terminate
       VNF are supported in all DF and therefore need not be
       included in this list.";
    reference
      "GS NFV IFA011: Section 7.1.8.2 VnfDf information element";
  }
  identity instantiate-vnf {
    base supported-operation;
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
    description
      "This operation instantiates a particular DF of a VNF based on
       the definition in the VNFD.";
    reference
      "GS NFV IFA007: Section 7.2.3 Instantiate VNF Operation";
  }
  identity scale-vnf {
    base supported-operation;
    description
      "This operation provides methods to request scaling a VNF in
       multiple ways:
       • horizontal scaling:
         - scale out: adding additional VNFC instances to the VNF to
           increase capacity
         - scale in: removing VNFC instances from the VNF, in order to
           release unused capacity";
    reference
      "GS NFV IFA007: Section 7.2.4 Scale VNF Operation";
  }
  identity scale-vnf-to-level {
    base supported-operation;
    description
      "This operation scales an instantiated VNF of a particular DF to
       a target size. The target size is either expressed as an
       instantiation level of that DF as defined in the VNFD, or given
       as a list of scale levels, one per scaling aspect of that DF.
       Instantiation levels and scaling aspects are declared in the
       VNFD. Typically, the result of this operation is adding and/or
       removing Network Functions Virtualization Infrastructure (NFVI)
       resources to/from the VNF.";
    reference
      "GS NFV IFA007: Section 7.2.5 Scale VNF To Level Operation";
  }
  identity change-vnf-flavour {
    base supported-operation;
    description
      "This operation changes the DF of a VNF instance.";
    reference
      "GS NFV IFA007: Section 7.2.6 Change VNF Flavour Operation";
167
168
169
  }
  identity terminate-vnf {
    base supported-operation;
170
171
172
173
174
175
176
177
178
179
180
181
182
183
    description
      "This operation terminates a VNF.

       A VNF can be terminated gracefully or forcefully. Graceful
       termination means that the VNFM arranges to take the
       VNF out of service, e.g. by asking the VNF's EM to take the
       VNF out of service, and only after that shuts down the
       VNF and releases the resources. Forceful termination means that
       the VNFM immediately shuts down the VNF and releases the
       resources. A time interval can be specified for taking the VNF
       out of service, after which the VNF is shut down if taking it
       out of service has not completed.";
    reference
      "GS NFV IFA007: Section 7.2.7 Terminate VNF Operation";
184
185
186
  }
  identity query-vnf {
    base supported-operation;
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
    description
      "This operation provides information about VNF instances. The
       applicable VNF instances can be chosen based on
       filtering criteria, and the information can be restricted to
       selected attributes.";
    reference
      "GS NFV IFA007: Section 7.2.9 Query VNF Operation";
  }
  identity heal-vnf {
    base supported-operation;
    description
      "This operation enables the NFVO to request a VNFM to perform a
       VNF healing procedure.";
    reference
      "GS NFV IFA007: Section 7.2.10 Heal VNF Operation";
  }
  identity operate-vnf {
    base supported-operation;
    description
      "This operation enables requesting to change the state of a VNF
       instance, including starting and stopping the VNF instance.";
    reference
      "GS NFV IFA007: Section 7.2.11 Operate VNF Operation";
  }
  identity modify-vnf-information {
    base supported-operation;
    description
      "This operation allows updating information about a VNF
       instance.";
    reference
      "GS NFV IFA007: Section 7.2.12 Modify VNF Operation";
  }

  identity cp-role {
    description
      "Identifies the role of the port in the context of the traffic
       flow patterns in the VNF or parent NS.";
    reference
      "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
  }
  identity root {
    base cp-role;
  }
  identity leaf {
    base cp-role;
232
233
  }

234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
  identity checksum-algorithm {
    description
      "Identifies the algorithms supported for the purpose of
       calculating the checksum.";
    reference
      "GS NFV IFA011: Section 7.1.6.10 Checksum information element.";
  }

  identity sha-224 {
    base checksum-algorithm;
    description
      "SHA-224.";
    reference
      "GS NFV IFA011: Section 7.1.6.10 Checksum information element.";
  }

  identity sha-256 {
    base checksum-algorithm;
    description
      "SHA-256.";
    reference
      "GS NFV IFA011: Section 7.1.6.10 Checksum information element.";
  }

  identity sha-384 {
    base checksum-algorithm;
    description
      "SHA-384.";
262
263
    reference
      "GS NFV IFA011: Section 7.1.6.10 Checksum information element.";
264
265
266
267
268
269
  }

  identity sha-512 {
    base checksum-algorithm;
    description
      "SHA-512.";
270
271
    reference
      "GS NFV IFA011: Section 7.1.6.10 Checksum information element.";
272
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
273
274
275
276
277
278

  identity storage-type {
    description
      "Base type of storage that identities can derive from.";
  }

Mahesh Jethanandani's avatar
Issue#2    
Mahesh Jethanandani committed
279
  identity block {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
280
281
    base storage-type;
    description
Mahesh Jethanandani's avatar
Issue#2    
Mahesh Jethanandani committed
282
      "Block type of storage.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
283
284
  }

Mahesh Jethanandani's avatar
Issue#2    
Mahesh Jethanandani committed
285
  identity object {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
286
287
    base storage-type;
    description
Mahesh Jethanandani's avatar
Issue#2    
Mahesh Jethanandani committed
288
      "Object type of storage.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
289
290
  }

Mahesh Jethanandani's avatar
Issue#2    
Mahesh Jethanandani committed
291
  identity file {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
292
293
    base storage-type;
    description
Mahesh Jethanandani's avatar
Issue#2    
Mahesh Jethanandani committed
294
      "File type of storage.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
295
  }
296

297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
  identity forwarding-behaviour {
    description
      "Base identity for forwarding behaviour.";
  }

  identity all {
    base forwarding-behaviour;
    description
      "Traffic flows shall be forwarded simultaneously to all CP
       or SAP instances created from the referenced CP profile(s).";
  }

  identity lb {
    base forwarding-behaviour;
    description
      "Traffic flows shall be forwarded to one CP or SAP instance
       created from the referenced CP profile(s) selected based on
       a load-balancing algorithm.";
  }

  identity vip-function {
    description
      "Indicates the function the virtual IP address is used for.";
  }

  identity high-availability {
    base vip-function;
    description
      "High availability function.";
  }

  identity load-balancing {
    base vip-function;
    description
      "Load balancing function.";
  }

jethanandani's avatar
jethanandani committed
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
  identity vnic-type {
    description
      "Describes the type of the virtual network interface realizing
       the CPs instantiated from this CPD. This is used to determine
       which mechanism driver(s) to be used to bind the port. Value:
       • NORMAL
       • VIRTIO
       • DIRECT
       • BAREMETAL
       • VIRTIO-FORWARDER
       • DIRECT-PHYSICAL
       • SMART-NIC";
  }

  identity normal {
    base vnic-type;
    description
      "Normal NIC.";
  }

  identity virtio {
    base vnic-type;
    description
      "VirtIO NIC.";
  }

  identity direct {
    base vnic-type;
    description
      "Direct NIC type.";
  }

  identity bare-metal {
    base vnic-type;
    description
      "Bare metal NIC type.";
  }

  identity virtio-forwarder {
    base vnic-type;
    description
      "VirtIO Forwarder NIC type.";
  }

  identity direct-physical {
    base vnic-type;
    description
      "Direct physical NIC type.";
  }

  identity smart-nic {
    base vnic-type;
    description
      "SmartNIC or Smart NIC type.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
388
  }
389

390
391
392
  /*
   * Typedefs
   */
393

394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
  typedef flow-pattern {
    type enumeration {
      enum line;
      enum tree;
      enum mesh;
    }
  }

  typedef affinity-type {
    type enumeration {
      enum "affinity";
      enum "anti-affinity";
    }
  }

  typedef affinity-scope {
    type enumeration {
      enum "nfvi-node";
      enum "zone-group";
      enum "zone";
      enum "nfvi-pop";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
415
      enum "network-link-and-node";
416
417
418
    }
  }

419
  typedef internal-lifecycle-management-script-event {
420
421
422
423
424
425
426
427
428
    type enumeration {
      enum "start-instantiation";
      enum "end-instantiation";
      enum "start-scaling";
      enum "end-scaling";
      enum "start-healing";
      enum "end-healing";
      enum "start-termination";
      enum "end-termination";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
429
430
      enum "start-vnf-flavour-change";
      enum "end-vnf-flavour-change";
431
432
433
434
435
436
      enum "start-vnf-operation-change";
      enum "end-vnf-operation-change";
      enum "start-vnf-ext-conn-change";
      enum "end-vnf-ext-conn-change";
      enum "start-vnfinfo-modification";
      enum "end-vnfinfo-modification";
Mahesh Jethanandani's avatar
Issue#5    
Mahesh Jethanandani committed
437
438
439
440
      enum "start-vnf-snapshot-creation";
      enum "end-vnf-snapshot-creation";
      enum "start-vnf-snapshot-reverting-to";
      enum "end-vnf-snapshot-reverting-to";
441
442
      enum "start-change-current-vnf-package";
      enum "end-change-current-vnf-package";
Mahesh Jethanandani's avatar
Issue#1    
Mahesh Jethanandani committed
443
444
445
446
447
448
449
450
451
452
453
454
455
    }
  }

  typedef external-lifecycle-management-script-event {
    type enumeration {
      enum "instantiation";
      enum "scaling";
      enum "healing";
      enum "termination";
      enum "vnf-flavour-change";
      enum "vnf-operation-change";
      enum "vnf-ext-conn-change";
      enum "vnfinfo-modification";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
456
457
458
      enum "vnf-snapshot-creation";
      enum "vnf-snapshot-reverting-to";
      enum "change-current-vnf-package";
459
460
461
    }
  }

462
463
464
465
466
467
  grouping nfvi-maintenance-info {
    container nfvi-maintenance-info {

      leaf impact-notification-lead-time {
        type yang:timeticks;
	mandatory true;
468
        description
469
470
471
472
          "The value specifies the minimum notification lead time
           requested for upcoming impact of the virtualised resource
           or their group (i.e. between the notification and the
           action causing the impact).";
473
        reference
474
475
          "GS NFV-IFA011: Section 7.1.8.17, NfviMaintenanceInfo
           information element";
476
477
      }

478
479
      leaf is-impact-mitigation-requested {
        type boolean;
480
        description
481
482
483
484
485
486
          "When set to True, it is requested that at the time of the
           notification of an upcoming change that is expected to have
           an impact on the VNF, virtualised resource(s) of the same
           characteristics as the impacted ones is/are provided to
           compensate for the impact. Cardinality 0 corresponds to the
           value False.";
487
        reference
488
489
490
491
492
493
494
495
496
497
498
499
500
501
          "GS NFV-IFA011: Section 7.1.8.17, NfviMaintenanceInfo
           information element";
      }

      leaf-list supported-migration-type {
        type enumeration {
          enum "no-migration";
          enum "offline-migration";
          enum "live-migration";
        }
        description
          "Applicable to VirtualComputeDesc and VirtualStorageDesc.
           When present, specifies the allowed migration types in the
           order of preference in case of an impact starting with the
502
503
504
505
506
           most preferred type.
           Values:
             • NO_MIGRATION
             • OFFLINE_MIGRATION
             • LIVE_MIGRATION.";
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
        reference
          "GS NFV-IFA011: Section 7.1.8.17, NfviMaintenanceInfo
           information element";
      }

      leaf max-undetectable-interruption-time {
        type yang:timeticks;
        description
          "Applicable to VirtualComputeDesc and VirtualStorageDesc.
           When present, it specifies the maximum interruption time
           that can go undetected at the VNF level and therefore
           which will not trigger VNFinternal recovery during live
           migration.";
        reference
          "GS NFV-IFA011: Section 7.1.8.17, NfviMaintenanceInfo
           information element";
      }

      leaf min-recovery-time-between-impacts {
        type yang:timeticks;
        description
          "When present, it specifies the time required by the group
           to recover from an impact, thus, the minimum time
           requested between consecutive impacts of the group.";
        reference
          "GS NFV-IFA011: Section 7.1.8.17, NfviMaintenanceInfo
           information element";
      }

      list max-number-of-impacted-instances {
        key "group-size";
        ordered-by user;
        must "./max-number-of-impacted-instances <= ./group-size";

        leaf group-size {
          type uint32;
          description
            "When present, it determines the size of the group for
             which the maxNumberOfImpactedInstances is specified.
             Otherwise the size is not limited.

             Each groupSize value specified for a group of virtual
             resources shall be unique, and it shall be possible
             to form an ascending ordered list of groupSizes.

             The number of instances in the group for which the
             maxNumberOfImpactedInstances is specified may be equal
             to groupSize or less. When the number of instances is
             less than the groupSize, it shall be at least 1 if this
             is the first groupSize in the ordered list of groupSizes,
             or it shall be greater by at least 1 than the previous
             groupSize in the ordered list of groupSizes.";

          reference
            "GS NFV-IFA011: Section 7.1.8.17, NfviMaintenanceInfo
             information element";
        }

        leaf max-number-of-impacted-instances {
          type uint32 {
            range "1 .. max";
          }
          description
            "The maximum number of instances that can be impacted
             simultaneously within the group of the specified size.";
          reference
            "GS NFV-IFA011: Section 7.1.8.17, NfviMaintenanceInfo
             information element";
        }
576
      }
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605

      list min-number-of-preserved-instances {
        key "group-size";
        ordered-by user;
        must "./min-number-of-preserved-instances <= ./group-size";

        leaf group-size {
          type uint32;
          description
            "When present, it determines the size of the group for
             which the minNumberOfPreservedInstances is specified.
             Otherwise the size is not limited.";
          reference
            "GS NFV-IFA011: Section 7.1.8.21, MinNumberOfPreserved
             Instances information element";
        }

        leaf min-number-of-preserved-instances {
          type uint32 {
            range "1 .. max";
          }
          description
            "The maximum number of instances that can be impacted
             simultaneously within the group of the specified size.";
          reference
            "GS NFV-IFA011: Section 7.1.8.21, MinNumberOfPreserved
             Instances information element";
        }
      }      
606
607
608
609
610
    }
  }

  grouping connectivity-type {
    container connectivity-type {
611
612
613
614
      leaf-list layer-protocol {
        type identityref {
          base layer-protocol;
        }
615
	min-elements 1;
616
        description
617
618
619
620
621
622
623
624
625
          "Specifies the protocols that the VL uses
           Values:
             • Ethernet
             • MPLS
             • ODU2
             • IPV4
             • IPV6
             • Pseudo-Wire
             • etc.";
626
627
628
629
630
631
632
633
        reference
          "GS NFV IFA011: Section 7.1.7.3, ConnectivityType
           information element.";
      }

      leaf flow-pattern {
        type flow-pattern;
        description
634
          "Specifies the flow pattern of the connectivity (Line,
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
           Tree, Mesh).";
        reference
          "GS NFV IFA011: Section 7.1.7.3, ConnectivityType
           information element.";
      }
    }
  }

  grouping link-bitrate-requirements {
    leaf root {
      type uint64;
      units "Mbps";
      mandatory true;
      description
        "Specifies the throughput requirement of
         the link (e.g. bitrate of E-Line, root bitrate
         of E-Tree, aggregate capacity of E-LAN).";
      reference
        "GS NFV IFA011: Section 7.1.8.6, LinkBitrateRequirements
         information element.";
    }

    leaf leaf {
      type uint64;
      units "Mbps";
      description
        "Specifies the throughput requirement of
        leaf connections to the link when
        applicable to the connectivity type (e.g. for
        E-Tree and E-LAN branches).";
      reference
        "GS NFV IFA011: Section 7.1.8.6, LinkBitrateRequirements
         information element.";
    }
  }

  grouping monitoring-parameter {
    leaf name {
      type string;
      description
        "Human readable name of the monitoring parameter.";
      reference
        "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
         information element.";
    }
    leaf performance-metric {
      type string;
      description
683
684
685
        "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";
686
687
      reference
        "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
688
         information element and Section 7.2 of ETSI GS NFV-IFA 027.";
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
    }
    leaf collection-period {
      type uint64;
      units "ms";
      description
        "An attribute that describes the recommended periodicity at
         which to collect the performance information. VNFM determines
         if this parameter is considered.

         The vendor may provide this information as a guidance for
         creating PmJobs if needed.";
      reference
        "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
         information element.";
    }
  }
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733

  grouping security-parameters {
    leaf signature {
      type string;
      description
        "Provides the signature of the signed part of the
         descriptor.";
      reference
        "GS NFV IFA014: Section 6.2.5, SecurityParameters
         information element.";
    }
    leaf algorithm {
      type string;
      description
        "Identifies the algorithm used to compute the signature.";
      reference
        "GS NFV IFA014: Section 6.2.5, SecurityParameters
         information element.";
    }
    leaf certificate {
      type string;
      description
        "Provides a certificate or a reference to a certificate to
         validate the signature.";
      reference
        "GS NFV IFA014: Section 6.2.5, SecurityParameters
         information element.";
    }
  }
734

735
736
  grouping cpd {
    description
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
737
738
      "A Cpd information element describes network
       connectivity to a compute resource or a VL.";
739
    reference
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
740
      "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
741

742
743
744
745
746
    leaf id {
      type string;
      description
        "Identifier of this Cpd information element.";
      reference
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
747
        "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
748
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
749
750

    leaf-list layer-protocol {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
751
      default ethernet;
752
      type identityref {
753
        base layer-protocol;
754
755
      }
      description
756
757
758
759
760
761
762
763
764
        "Specifies which protocol the CP uses for connectivity purposes
         Values:
           • Ethernet
           • MPLS
           • ODU2
           • IPV4
           • IPV6
           • Pseudo-Wire
           • etc.";
765
      reference
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
766
        "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
767
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
768

769
770
    leaf role {
      type identityref {
771
        base cp-role;
772
773
      }
      description
774
775
776
777
778
        "Identifies the role of the connection points
         corresponding to the CPD in the context of the traffic
         flow patterns in the VNF, PNF or NS. For example an NS with
         a tree flow pattern within the NS will have legal cpRoles
         of ROOT and LEAF.";
779
      reference
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
780
        "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
781
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
782

783
784
785
    leaf description {
      type string;
      description
786
787
788
        "Provides human-readable information on the purpose of the
         connection point (e.g. connection point for control plane
         traffic).";
789
      reference
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
790
        "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
791
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
792
793
794
795
796
797
798
799
800
801

    list protocol {
      key "associated-layer-protocol";

      leaf associated-layer-protocol {
        type identityref {
          base layer-protocol;
        }
        description
          "One of the values of the attribute layerProtocol of the Cpd
802
803
804
805
806
807
808
809
810
           IE.
           Values:
           • Ethernet
           • MPLS
           • ODU2
           • IPV4
           • IPV6
           • Pseudo-Wire
           • etc.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
        reference
          "GS NFV IFA011: Section 7.1.6.8 CpProtocolData information
           element";
      }

      list address-data {
        key "type";

        leaf type {
          type identityref {
            base address-type;
          }
          description
            "Describes the type of the address to be assigned to the
             CP instantiated from the parent CPD.
826
827
828
829
             Values:
               • MAC address
               • IP address
               • etc.
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
830
831
832
833
834
835
836
837
838
839
840
841
             The content type shall be aligned with the address type
             supported by the layerProtocol attribute of the parent
             CPD.";
          reference
            "GS NFV IFA011: Section 7.1.3.3 AddressData information
             element";
        }

        container l2-address-data {
          when "../type='mac-address'";
          leaf mac-address-assignment {
            type boolean;
842
            mandatory true;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
            description
              "Specify if the MAC address assignment is the
               responsibility of management and orchestration function
               or not. If it is set to True, it is the management and
               orchestration function responsibility. If it is set to
               False, it will be provided by an external entity,
               e.g. OSS/BSS.";
            reference
              "GS NFV IFA011: Section 7.1.3.5 L2AddressData
               information element";
          }

          description
            "Provides the information on the MAC addresses to be
             assigned to the CP(s) instantiated from the parent CPD.
             Shall be present when the addressType is MAC address.";
          reference
            "GS NFV IFA011: Section 7.1.3.3 AddressData information
             element";
        }

        container l3-address-data {
          when "../type='ip-address'";
          leaf ip-address-assignment {
            type boolean;
            description
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
              "Specify which mode is used for the address assignment.
               If set to True, IP configuration information shall be
               provided for the VNF by a management entity using the
               NFV MANO interfaces towards the VNFM.
               If it is set to False, the value of the
               'ipAddressAssignmentSubtype' attribute defines the
               method of IP address assignment.
               Shall be present if the 'fixedIpAddress' attribute
               is not present and should be absent otherwise.";
            reference
              "GS NFV IFA011: Section 7.1.3.4, L3AddressData
               information element.";
          }

          leaf ip-address-assignment-subtype {
            type enumeration {
              enum dynamic;
              enum vnf_pkg;
              enum external;
            }
            description
              "Method of IP address assignment in case the IP
               configuration is not provided using the NFV MANO
               interfaces towards the VNFM.
               Shall be present in case the 'ipAddressAssignment'
               attribute is set to 'False' and shall be absent
               otherwise.

               Valid values:
               DYNAMIC: the VNF gets an IP address dynamically from
               the NFVI (e.g., using DHCP)
               VNF_PKG: an IP address defined by the VNF provider is
               assigned by means included as part of the VNF package
               (e.g., LCM script)
               EXTERNAL: an IP address is provided by an external
               management entity (such as EM) directly towards the
               VNF.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
906
907
908
909
910
911
912
            reference
              "GS NFV IFA011: Section 7.1.3.4, L3AddressData
               information element.";
          }

          leaf floating-ip-activated {
            type boolean;
913
            mandatory true;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
914
915
916
917
918
919
920
921
922
923
924
925
926
927
            description
              "Specify if the floating IP scheme is activated on the CP
               or not.";
            reference
              "GS NFV IFA011: Section 7.1.3.4, L3AddressData
               information element.";
          }

          leaf ip-address-type {
            type enumeration {
              enum "ipv4";
              enum "ipv6";
            }
            description
928
929
930
931
              "Define address type.
               Values:
                 • IPV4
                 • IPV6.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
932
933
934
935
936
937
938
939
940
941
942
943
944
945
            reference
              "GS NFV IFA011: Section 7.1.3.4, L3AddressData
               information element.";
          }

          leaf number-of-ip-addresses {
            type uint32;
            description
              "Minimum number of IP addresses to be assigned based on
               this L3AddressData information element.";
            reference
              "GS NFV IFA011: Section 7.1.3.4, L3AddressData
               information element.";
          }
946
947
948
949

          leaf fixed-ip-address {
            type string;
            description
950
951
952
953
954
              "Fixed IP addresses to be assigned to the internal CP
               instance.
               This attribute enables the VNF provider to define
               fixed IP addresses for internal CP instances to be
               assigned by the VNFM or the NFVO.";
955
956
957
958
959
            reference
              "GS NFV IFA011: Section 7.1.3.4, L3AddressData
               information element.";
          }

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
        }
        description
          "Provides information on the addresses to be assigned to the
           CP(s) instantiated from the CPD.";
        reference
          "GS NFV IFA011: Section 7.1.6.8 CpProtocolData information
           element";
      }
      description
        "Identifies the protocol layering information the CP uses for
         connectivity purposes and associated information. There shall
         be one cpProtocol for each layer protocol as indicated by the
         attribute layerProtocol. When a PnfExtCpd as defined in ETSI
         GS NFV-IFA 014 [i.8] is inherited from this Cpd, the
         cardinality is set to 0.";
      reference
        "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
    }

979
980
981
    leaf trunk-mode {
      type boolean;
      description
982
983
984
985
986
987
        "Information about whether the Cp instantiated from this CPD
         is in Trunk mode (802.1Q or other). When operating in
         'trunk mode', the Cp is capable of carrying traffic for
         several VLANs. A cardinality of 0 implies that trunkMode
         is not configured for the Cp i.e. It is equivalent to
         Boolean value 'false'.";
988
      reference
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
989
        "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
990
    }
991
992
993
994
995
996
997
998
999
1000
  }

  grouping security-group-rule {
    list security-group-rule {
      key "id";

      leaf id {
        type string;
        description
          "Identifier of this SecurityGroupRule information
For faster browsing, not all history is shown. View entire blame