etsi-nfv-vnf.yang 89.7 KB
Newer Older
1
submodule etsi-nfv-vnf {
2
  yang-version 1.1;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
3
  belongs-to etsi-nfv-descriptors {
4
5
6
    prefix nfv;
  }

7
8
  include etsi-nfv-common;

9
10
11
12
13
14
15
16
17
18
  import ietf-inet-types {
    prefix inet;
  }
  import ietf-yang-types {
    prefix yang;
  }

  description
    "Models for VNFD according to GS NFV-IFA 011.";

19
  revision 2019-03-18 {
20
21
22
23
    description
      "Initial revision.

       Common data structure to support VNFD according to:
24
       VNFD according to ETSI GS NFV-IFA 011 Ed261v254";
25
26

    reference
27
      "ETSI GS NFV-IFA 011 Ed261v254";
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
  }

  grouping virtual-network-interface-requirements {
    list virtual-network-interface-requirement {
      key "name";
      description
        "Specifies requirements on a virtual network interface
         realising the CPs instantiated from this CPD.";
      reference
        "GS NFV-IFA011: Section 7.1.6.4, VduCpd information
         element";

      leaf name {
        type string;
        description
          "Provides a human readable name for the requirement.";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
48

49
50
51
52
53
54
55
56
      leaf description {
        type string;
        description
          "Provides a human readable description of the requirement.";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
57

58
      leaf support-mandatory {
59
	status "deprecated";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
60
        default "false";
61
62
63
64
65
66
67
68
69
        type boolean;
        description
          "Indicates whether fulfilling the constraint is
           mandatory (true) for successful operation or desirable
           (false).";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
70

71
72
      list network-interface-requirements {
        key "key";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
73
        min-elements "1";
74
        max-elements "1";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
75

76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
        leaf key {
          type string;
        }
        leaf value {
          type string;
        }
        description
          "The network interface requirements. An element from an
           array of key-value pairs that articulate the network
           interface deployment requirements.";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
    }
  }

  grouping vnfd {
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
    leaf id {
      type string;
      description
        "Identifier of this VNFD information element. This attribute
         shall be globally unique. The format will be defined in the
         data model specification phase.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf provider {
      type string;
      mandatory true;
      description
        "Provider of the VNF and of the VNFD";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf product-name {
      type string;
      mandatory true;
      description
        "Name to identify the VNF Product. Invariant for the VNF
         Product lifetime.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf software-version {
      type string;
      mandatory true;
      description
        "Software version of the VNF. This is changed when there is
         any change to the software that is included in the VNF
         Package";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf version {
      type string;
      mandatory true;
      description
        "Identifies the version of the VNFD";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf product-info-name {
      type string;
      description
        "Human readable name of the VNFD. Can change
         during the VNF Product lifetime.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf product-info-description {
      type string;
      description
        "Human readable description of the VNFD. Can change during
         the VNF Product lifetime.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf-list vnfm-info {
      type string;
      min-elements 1;
      description
        "Identifies VNFM(s) compatible with the VNF described in
         this version of the VNFD.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf localization-language {
      type string;
173
      description
174
        "Information about the language of the VNF.";
175
176
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
    }

    leaf default-localization-language {
      when "../localization-language";
      type string;
      description
        "Default localization language that is instantiated if no
         information about selected localization language is
         available. Shall be present if 'localization-language'
         is present and shall be absent otherwise.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    list vdu {
      key "id";
      min-elements 1;
      description
        "The Virtualisation Deployment Unit (VDU) is a construct supporting
         the description of the deployment and operational behaviour of a
         VNF component, or the entire VNF if it was not componentized in
         components.";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD information element";

202
203
204
      leaf id {
        type string;
        description
205
          "Unique identifier of this VDU in VNFD.";
206
        reference
207
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
208
      }
209
210

      leaf name {
211
212
213
        type string;
        mandatory true;
        description
214
          "Human readable name of the VDU.";
215
        reference
216
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
217
      }
218
219

      leaf description {
220
221
        type string;
        description
222
          "Human readable description of the VDU.";
223
        reference
224
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
225
      }
226
227
228
229

      list int-cpd {
        key "id";
        min-elements 1;
230
        description
231
232
233
234
          "A internal-connection-point element is a type of
           connection point and describes network connectivity
           between a VDU instance and an internal Virtual Link or
           an external connection point.";
235
        reference
236
237
238
239
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";

        leaf int-virtual-link-desc {
          type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
240
            path "/nfv:nfv/nfv:vnfd/nfv:int-virtual-link-desc/nfv:id";
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
          }
          description
            "Reference of the internal VLD which this internal CPD
             connects to.";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element";
        }

        leaf bitrate-requirement {
          type uint64;
          units "Mbps";
          description
            "Bitrate requirement on this CP.";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element.";
        }
        uses virtual-network-interface-requirements;

        leaf nicio-requirements {
          type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
263
            path "/nfv:nfv/nfv:vnfd/nfv:virtual-compute-desc/nfv:id";
264
265
266
267
268
269
270
271
272
273
274
275
276
          }
          description
            "This references (couples) the CPD with any logical node I/O
             requirements (for network devices) that may have been
             created. Linking these attributes is necessary so that so
             that I/O requirements that need to be articulated at the
             logical node level can be associated with the network
             interface requirements associated with the CPD.";
          reference
            "GS NFV-IFA011: Section 7.1.6.6,
             VirtualNetworkInterfaceRequirements information element";
        }

jethanandani's avatar
jethanandani committed
277
        leaf order {
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
          type uint32;
          description
            "The order of the NIC to be assigned on the compute
             instance (e.g. 2 for eth2).

             Note: when binding more than one port to a single
             compute (aka multi vNICs) and ordering is desired, it
             is mandatory that all ports will be set with an order
             value. The order values shall represent a positive,
             arithmetic progression that starts with 0 (i.e. 0, 1,
             2,..., n).

             If the property is not present, it shall be left to the
             VIM to assign a value when creating the instance.";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element.";
        }
jethanandani's avatar
jethanandani committed
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

        leaf vnic-type {
	  type identityref {
	    base 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";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element.";
        }
317
318
319
320
321
322
323
324
325
326
327
328
        uses cpd;

        leaf security-group-rule-id {
          type leafref {
            path "../../../security-group-rule/id";
          }
          description
            "Reference of the security group rules bound to this
             CPD.";
          reference
            "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
        }
329
      }
330
331
332
333
334
335
336
337
338
339

      leaf virtual-compute-desc {
        type leafref {
          path "../../virtual-compute-desc/id";
        }
        must "../../virtual-compute-desc[id=current()]/" +
             "virtual-memory/size >=" +
             "../../sw-image-desc[id=current()/" +
             "../sw-image-desc]/min-ram" {
        }
340
        description
341
342
          "Describes CPU, Memory and acceleration requirements of
           the Virtualisation Container realizing this VDU.";
343
        reference
344
345
346
          "GS NFV IFA011: Section 7.1.6.2, VDU information
           element, and Section 7.1.9.2.2, VirtualComputeDesc
           information element.";
347
      }
348
349
350
351
352

      leaf-list virtual-storage-desc {
        type leafref {
          path "../../virtual-storage-desc/id";
        }
353
        description
354
355
356
          "Describes storage requirements for a VirtualStorage
           instance attached to the virtualisation container
           created from virtualComputeDesc defined for this VDU.";
357
        reference
358
359
360
          "GS NFV IFA011: Section 7.1.6.2, VDU information
           element, and Section 7.1.9.4, Information elements
           related to Virtual Storage.";
361
      }
362
363
364
365
366
367
368
369
370
371
372
373
374
375

      list boot-order {
        ordered-by user;
        key "key";

        leaf key {
          type uint32;
        }

        leaf value {
          type leafref {
            path "../../virtual-storage-desc";
          }
        }
376
        description
377
378
379
380
381
382
383
384
          "The key indicates the boot index (lowest index defines
           highest boot priority). The Value references a descriptor
           from which a valid boot device is created e.g.
           VirtualStorageDesc from which a VirtualStorage instance
           is created.

           Editor's note: The boot-order node requires further
           study.";
385
        reference
386
387
          "GS NFV IFA011: Section 7.1.6.2, Vdu information
           element.";
388
      }
389
390
391
392
393

      leaf sw-image-desc {
        type leafref {
          path "../../sw-image-desc/id";
        }
394
        description
395
396
          "Describes the software image which is directly loaded on
           the virtualisation container realising this Vdu.";
397
        reference
398
399
          "GS NFV IFA011: Section 7.1.6.2, Vdu information
           element.";
400
      }
401
402

      leaf-list nfvi-constraint {
403
404
        type string;
        description
405
406
407
408
          "Describes constraints on the NFVI for the VNFC
           instance(s) created from this Vdu. For example, aspects
           of a secure hosting environment for the VNFC instance
           that involve additional entities or processes.";
409
        reference
410
411
          "GS NFV IFA011: Section 7.1.6.2, VDU Information
           element.";
412
      }
413

414
      list monitoring-parameter {
415
416
417
418
        key "id";
        leaf id {
          type string;
          description
419
            "Unique identifier of the monitoring parameter.";
420
          reference
421
422
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
423
        }
424
425
426
427
428
429
        uses monitoring-parameter;
      }

      list configurable-properties {
        key "key";
        leaf key {
430
431
          type string;
        }
432
        leaf value {
433
434
          type string;
        }
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
        description
          "It provides VNFC configurable properties that can be
           modified using the ModifyVnfInfo operation.";
        reference
          "GS NFV IFA011: Section 7.1.6.7,
           VnfcConfigurableProperties Information element.";
      }

      leaf boot-data {
        type string;
        description
          "Contains a string or a URL to a file contained in the
           VNF package used to customize a virtualised compute
           resource at boot time. The bootData may contain variable
           parts that are replaced by deployment specific values
           before being sent to the VIM.";
        reference
          "GS NFV IFA011: Section 7.1.6.7,
           VnfcConfigurableProperties Information element.";
      }
    }

    list virtual-compute-desc {
      key "id";
      description
        "Defines descriptors of virtual compute resources to be
         used by the VNF.";
      leaf id {
        type string;
        description
          "Unique identifier of this VirtualComputeDesc in the
           VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.9.2, Information elements
           related to Virtual CPU.";
      }

      list logical-node {
        key "id";

        leaf id {
          type string;
477
          description
478
            "Identifies this set of logical node requirements.";
479
          reference
480
481
482
            "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
             Information elements.";
        }
483

484
485
        list requirement-detail {
          key "key";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
486

487
488
          leaf key {
            type string;
489
          }
490
491
492

          leaf value {
            type string;
493
          }
494
          description
495
496
497
498
499
500
501
502
503
504
            "The logical node-level compute, memory and I/O
             requirements. An array of key-value pairs that
             articulate the deployment requirements.

             This could include the number of CPU cores on this
             logical node, a memory configuration specific to a
             logical node (e.g. such as available in the Linux
             kernel via the libnuma library) or a requirement
             related to the association of an I/O device with the
             logical node.";
505
          reference
506
            "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
507
508
             information element.";
        }
509
510
511
512
513
514
        description
          "The logical node requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.2, VirtualComputeDesc
           information element.";
      }
515

516
517
518
519
520
      list request-additional-capability {
        key "name";

        leaf name {
          type string;
521
          description
522
523
524
            "Identifies a requested additional capability for the
             VDU. ETSI GS NFV-IFA 002 [i.1] describes acceleration
             capabilities.";
525
          reference
526
527
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
528
        }
529

530
531
532
533
534
        leaf support-mandatory {
          type boolean;
          description
            "Indicates whether the requested additional capability
             is mandatory for successful operation.";
535
          reference
536
537
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information
538
             element.";
539
        }
540
541
542

        leaf min-version {
          type string;
543
          description
544
545
            "Identifies the minimum version of the requested
             additional capability.";
546
          reference
547
548
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
549
        }
550
551

        leaf preferred-version {
552
553
          type string;
          description
554
555
            "Identifies the preferred version of the requested
             additional capability.";
556
          reference
557
558
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
559
        }
560
561

        list target-performance-parameters {
562
          key "key";
563

564
565
566
          leaf key {
            type string;
          }
567

568
569
570
          leaf value {
            type string;
          }
571
          description
572
573
            "Identifies specific attributes, dependent on the
             requested additional capability type.";
574
          reference
575
576
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
577
578
        }
      }
579

580
581
      leaf compute-requirements {
        type string;
582
        description
583
584
585
586
587
          "Specifies compute requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";
      }
588

589
590
591
592
593
      container virtual-memory {
        leaf size {
          type decimal64 {
            fraction-digits 1;
            range "0..max";
594
          }
595
596
597
598
599
600
601
602
          units "GB";
          default 1;
          description
            "Amount of virtual memory in GB.";
          reference
            "GS NFV IFA011: Section 7.1.9.3, Information elements
             related to Virtual Memory.";
        }
603

604
605
        leaf over-subscription-policy {
          type string;
606
          description
607
608
609
610
            "The memory core oversubscription policy in terms of
             virtual memory to physical memory on the platform.
             The cardinality can be 0 during the allocation
             request, if no particular value is requested.";
611
          reference
612
613
            "GS NFV IFA011: Section 7.1.9.3, Information elements
             related to Virtual Memory.";
614
615
        }

616
617
        list vdu-mem-requirements {
          key "key";
618

619
          leaf key {
620
621
622
            type string;
          }

623
          leaf value {
624
625
            type string;
          }
626
627
628
629
630
631
          description
            "Array of key-value pair requirements on the memory for
             the VDU.";
          reference
            "GS NFV IFA011: Section 7.1.9.3.2, VirtualMemoryData
             information element.";
632
633
        }

634
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
        leaf numa-enabled {
          type boolean;
          description
            "It specifies the memory allocation to be cognisant of
             the relevant process/core allocation. The cardinality
             can be 0 during the allocation request, if no
             particular value is requested.";
          reference
            "GS NFV IFA011: Section 7.1.9.3, Information elements
             related to Virtual Memory.";
        }
        description
          "The virtual memory of the virtualised compute.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";
      }

      container virtual-cpu {
        description
          "The virtual CPU(s)of the virtualised compute.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";

        leaf cpu-architecture {
660
661
          type string;
          description
662
663
664
            "CPU architecture type. Examples are x86, ARM. The
             cardinality can be 0 during the allocation request,
             if no particular CPU architecture type is requested.";
665
          reference
666
667
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
668
669
        }

670
671
672
        leaf num-virtual-cpu {
          type uint16 {
            range "1..max";
673
          }
674
675
676
677
678
679
680
          default 1;
          description
            "Number of virtual CPUs.";
          reference
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
        }
681

682
683
684
        leaf clock {
          type uint32;
          units "MHz";
685
          description
686
687
688
            "Minimum virtual CPU clock rate (e.g. in MHz). The
             cardinality can be 0 during the allocation request,
             if no particular value is requested.";
689
          reference
690
691
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
692
        }
693
694
695

        leaf oversubscription-policy {
          type string;
696
          description
697
698
699
700
            "The CPU core oversubscription policy e.g. the relation
             of virtual CPU cores to physical CPU cores/threads.
             The cardinality can be 0 during the allocation request,
             if no particular value is requested.";
701
          reference
702
703
704
705
706
707
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
        }

        list vdu-cpu-requirements {
          key "key";
708

709
          leaf key {
710
711
            type string;
          }
712
713

          leaf value {
714
            type string;
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
          }
          description
            "Array of key-value pair requirements on the compute
             (CPU) for the VDU.";
          reference
            "GS NFV IFA011: Section 7.1.9.3.2, VirtualCpuData
             information element.";
        }

        container pinning {
          presence "Set to specify CPU pinning.";

          leaf policy {
            default "dynamic";
            type enumeration {
              enum "static";
              enum "dynamic";
            }
733
            description
734
735
736
737
738
739
740
741
              "The policy can take values of 'static' or 'dynamic'.
               In case of 'static' the virtual CPU cores are
               requested to be allocated to logical CPU cores
               according to the rules defined in
               virtualCpuPinningRules. In case of 'dynamic' the
               allocation of virtual CPU cores to logical CPU cores
               is decided by the VIM. (e.g. SMT (Simultaneous
               MultiThreading) requirements).";
742
            reference
743
744
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
745
          }
746
747
748

          list rule {
            when "../policy = 'static'";
749
            key "key";
750

751
752
753
754
755
756
757
            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            description
758
759
760
              "A list of rules that should be considered during the
               allocation of the virtual CPUs to logical CPUs in case
               of 'static' virtualCpuPinningPolicy.";
761
            reference
762
763
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
764
          }
765
766
767
768
769
770
771
772
773
          description
            "The virtual CPU pinning configuration for the
             virtualised compute resource.";
          reference
            "GS NFV IFA011: Section 7.1.9.2.3,
             VirtualCpuData information element.";
        }
      }
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
774

775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
    list virtual-storage-desc {
      key "id";
      description
        "Storage requirements for a Virtual Storage instance
         attached to the VNFC created from this VDU";
      leaf id {
        type string;
        description
          "Unique identifier of this VirtualStorageDesc in the
           VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

      leaf type-of-storage {
        // Needed to be able to onboard images
        default root-storage;
        type identityref {
          base storage-type;
795
        }
796
797
798
799
800
801
        description
          "Type of virtualised storage resource (e.g. volume,
           object).";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
802
      }
803

804
805
806
807
      leaf size-of-storage {
        type uint64;
        units "GB";
        default 0;
808
        description
809
810
811
812
813
814
815
816
817
818
819
          "Size of virtualised storage resource (e.g. size of
           volume, in GB)";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

      list vdu-storage-requirements {
        key "key";

        leaf key {
820
821
822
          type string;
        }

823
824
        leaf value {
          type string;
825
        }
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
        description
          "Array of key-value pairs that articulate the storage
           deployment requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.4.2, VirtualStorageDesc
           information element.";
      }

      leaf rdma-enabled {
        type boolean;
        description
          "Indicate if the storage support RDMA.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

      leaf sw-image-desc {
        type leafref {
          path "../../sw-image-desc/id";
846
        }
847
848
        must "../size-of-storage >=" +
          "../../sw-image-desc[id=current()]/min-disk" {
849
        }
850
851
852
853
854
855
        description
          "Software image to be loaded on the VirtualStorage
           resource created based on this VirtualStorageDesc.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
856
      }
857
    }
858

859
860
861
862
863
864
865
866
867
868
    list sw-image-desc {
      key "id";
      description
        "Defines descriptors of software images to be used by the
         VNF.";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD Information element.";

      leaf id {
        type string;
869
        description
870
          "The identifier of this software image.";
871
        reference
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc information
           element";
      }

      leaf name {
        mandatory true;
        type string;
        description
          "The name of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

      leaf version {
        mandatory true;
        type string;
        description
          "The version of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

896
897
898
899
900
901
902
903
904
905
906
      leaf provider {
        type string;
        description
          "The provider of this software image. If not present the
           provider of the software image is assumed to be same as
           the VNF provider.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

907
908
909
      container checksum {

        leaf algorithm {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
910
          mandatory true;
911
912
913
          type identityref {
            base checksum-algorithm;
          }
914
          description
915
916
            "Species the algorithm used to obtain the checksum
             value.";
917
          reference
918
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
919
920
             information element.";
        }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
921

922
923
        leaf hash {
          mandatory true;
924
925
          type string;
          description
926
927
928
            "Contains the result of applying the algorithm
             indicated by the algorithm attribute to the data to
             which this ChecksumData refers.";
929
          reference
930
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
931
932
             information element.";
        }
933
934
935
936
937
938
        description
          "The checksum of the software image file.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
939

940
941
942
943
      leaf container-format {
        default "bare";
        type enumeration {
          enum "aki" {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
944
            description
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
              "An Amazon kernel image.";
          }
          enum "ami" {
            description
              "An Amazon machine image.";
          }
          enum "ari" {
            description
              "An Amazon ramdisk image.";
          }
          enum "bare" {
            description
              "The image does not have a container or metadata
               envelope.";
          }
          enum "docker" {
            description
              "A docker container format.";
          }
          enum "ova" {
            description
              "An OVF package in a tarfile.";
          }
          enum "ovf" {
            description
              "The OVF container format.";
971
972
          }
        }
973
974
975
976
977
978
979
        description
          "The container format describes the container file
           format in which software image is provided.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
980

981
982
983
984
985
986
987
988
989
990
991
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
1029
1030
1031
1032
      leaf disk-format {
        default "qcow2";
        type enumeration {
          enum "aki" {
            description
              "An Amazon kernel image.";
          }
          enum "ami" {
            description
              "An Amazon machine image.";
          }
          enum "ari" {
            description
              "An Amazon ramdisk image.";
          }
          enum "iso" {
            description
              "An archive format for the data contents of an
               disk, such as CD-ROM.";
          }
          enum "qcow2" {
            description
              "Supported by the QEMU emulator that can expand
               dynamically and supports Copy on Write.";
          }
          enum "raw" {
            description
              "An unstructured disk image format; if you have a
               file without an extension it is possibly a raw
               format.";
          }
          enum "vdi" {
            description
              "Supported by VirtualBox virtual machine monitor
               and the QEMU emulator.";
          }
          enum "vhd" {
            description
              "The VHD disk format, a common disk format used by
               virtual machine monitors from VMware, Xen,
               Microsoft, VirtualBox, and others.";
          }
          enum "vhdx" {
            description
              "The VHDX disk format, an enhanced version of the
               VHD format, which supports larger disk sizes among
               other features.";
          }
          enum "vmdk" {
            description
              "Common disk format supported by many common virtual
               machine monitors.";
1033
1034
          }
        }
1035
1036
1037
1038
        description
          "The disk format of a software image is the format of
           the underlying disk image.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1039

1040
1041
        leaf min-disk {
          type uint64;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1042
          units "GB";
1043
          mandatory true;
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
          description
            "The minimal disk size requirement for this software
             image. The value of the 'size of storage' attribute
             of the VirtualStorageDesc referencing this
             SwImageDesc shall not be smaller than the value of
             minDisk.";
          reference
            "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
             information element.";
        }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1054

1055
1056
1057
1058
      leaf min-ram {
        type decimal64 {
          fraction-digits 1;
          range "0..max";
1059
        }
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
        units "GB";
        default 0;
        description
          "The minimal RAM requirement for this software image.
           The value of the 'size' attribute of
           VirtualMemoryData of the Vdu referencing this
           SwImageDesc shall not be smaller than the value of
           minRam.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1072

1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
      leaf size {
        mandatory true;
        type uint64;
        units "GB";
        description
          "The size of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1083

1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
      leaf image {
        default ".";
        type inet:uri;
        description
          "This is a reference to the actual software image.
           The reference can be relative to the root of the VNF
           Package or can be a URL";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1095

1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
      leaf operating-system {
        type string;
        description
          "Identifies the operating system used in the software
           image. This attribute may also identify if a 32 bit
           or 64 bit software image is used.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1106

1107
1108
1109
1110
1111
1112
1113
1114
1115
      leaf-list supported-virtualization-environment {
        type string;
        description
          "Identifies the virtualisation environments
           (e.g. hypervisor) compatible with this software
           image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
1116
      }
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
    }

    list int-virtual-link-desc {
      key "id";
      description
        "Represents the type of network connectivity mandated by the
         VNF provider between two or more CPs which includes at
         least one internal CP.";
      reference
        "GS NFV IFA011: Section 7.1.2, Vnfd information element.";
1127

1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
      leaf id {
        type string;
        description
          "Unique identifier of this internal VLD in VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           Information elements.";
      }

      list flavour {
1138
1139
        key "id";
        description
1140
1141
          "Describes a specific flavour of the VL with specific
             bitrate requirements.";
1142
        reference
1143
1144
1145
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           Information elements.";

1146
1147
1148
        leaf id {
          type string;
          description
1149
            "Identifies a flavour within a VnfVirtualLinkDesc.";
1150
          reference
1151
1152
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
1153
1154
        }

1155
1156
        container qos {
          presence "VL QoS parameters";
1157
          description
1158
            "QoS of the VL.";
1159
          reference
1160
1161
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
1162

1163
1164
1165
1166
          leaf latency {
            type uint32;
            units "ms";
            mandatory true;
1167
            description
1168
              "Specifies the maximum latency in ms.";
1169
            reference
1170
1171
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1172
          }
1173
1174
1175
1176
1177

          leaf packet-delay-variation {
            type uint32;
            units "ms";
            mandatory true;
1178
            description
1179
              "Specifies the maximum jitter in ms.";
1180
            reference
1181
1182
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1183
          }
1184

1185
1186
1187
1188
1189
          leaf packet-loss-ratio {
            type decimal64 {
              fraction-digits "2";
              range "0..1.00";
            }
1190
            description
1191
1192
1193
1194
              "Specifies the maximum packet loss ratio.";
            reference
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1195
1196
1197
          }
        }
      }
1198

1199
      uses connectivity-type;
1200

1201
1202
      leaf-list test-access {
        type string;
1203
        description
1204
1205
1206
          "Specifies test access facilities expected on the VL
           (e.g. none, passive monitoring, or active (intrusive)
           loopbacks at endpoints.";
1207
        reference
1208
1209
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
1210
1211
      }

1212
1213
      leaf description {
        type string;
1214
        description
1215
1216
          "Provides human-readable information on the purpose of
           the VL (e.g. control plane traffic).";
1217
        reference
1218
1219
1220
1221
1222
1223
1224
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
      }

      list monitoring-parameters {
        key "id";

1225
1226
1227
        leaf id {
          type string;
          description
1228
            "Unique identifier of the monitoring parameter.";
1229
          reference
1230
1231
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
1232
        }
1233
1234
1235
        uses monitoring-parameter;
      }
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1236

1237
    uses security-group-rule;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1238

1239
1240
1241
    list ext-cpd {
      key "id";
      min-elements 1;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1242

1243
1244
1245
1246
1247
      description
        "Describes an external interface exposed by this VNF enabling
         connection with a Virual Link";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD information element.";
1248

1249
1250
1251
1252
1253
1254
1255
1256
      choice cp-connection {
        leaf int-virtual-link-desc {
          description
            "Reference to the internal Virtual Link Descriptor (VLD)
             to which CPs instantiated from this external CP
             Descriptor (CPD) connect. Either intVirtualLinkDesc or
             intCpd shall be present.";
          type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1257
            path "/nfv:nfv/nfv:vnfd/nfv:int-virtual-link-desc/nfv:id";
1258
          }
1259
        }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1260

1261
1262
        container int-cpd {
          leaf vdu-id {
1263
            type leafref {
1264
              path "../../../vdu/id";
1265
1266
            }
          }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1267

1268
1269
1270
          leaf cpd {
            type leafref {
              path "deref(../vdu-id)/../int-cpd/id";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1271
1272
            }
          }
1273
        }
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288

        leaf vip-cpd {
          type leafref {
            path "../../vip-cpd/id";
          }
          description
            "Reference to the VIP CPD which is used to instantiate CPs
             to hold virtual IP addresses. These CPs are, in turn,
             exposed as external CPs defined by this external CPD.
             One and only one of the following attributes shall be
             present: intVirtualLinkDesc or intCpd or vipCpd .";
          reference
            "GS NFV-IFA011: Section 7.1.3.2, VnfExtCpd information
             element";
        }
1289
      }
1290

1291
      uses virtual-network-interface-requirements;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1292

1293
1294
      leaf nicio-requirements {
        type leafref {
Mahesh Jethanandani's avatar