etsi-nfv-vnf.yang 71.6 KB
Newer Older
1
submodule etsi-nfv-vnf {
2
  yang-version 1.1;
3 4 5 6
  belongs-to etsi-nfv {
    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 2018-06-19 {
20 21 22 23
    description
      "Initial revision.

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

    reference
27
      "ETSI GS NFV-IFA 011 Ed251v243";
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 80 81 82
  }

  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";
      }
      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";
      }
      leaf support-mandatory {
        mandatory true;
        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";
      }
      list network-interface-requirements {
        key "key";
        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";
      }
83

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
84
      leaf nicio-requirements {
85 86 87
        type leafref {
          path "/nfv/vnfd/virtual-compute-descriptor/id";
        }
88
        description
89 90 91 92
          "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
93 94 95 96 97 98 99 100 101 102 103 104 105 106
           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";
      }
    }
  }

  grouping vnfd {
    list vnfd {
      key "id";
      description
        "A VNF Descriptor (VNFD) is a deployment template which
107
         describes a VNF in terms of deployment and operational
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
         behaviour requirements. It also contains connectivity,
         interface and virtualised resource requirements";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
      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;
        description
          "Information about the language of the VNF.";
        reference
          "GS NFV-IFA011: Section 7.1.2, VNFD information element";
      }
      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";
      }
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 232 233 234 235 236 237 238 239 240 241
      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";
        leaf id {
          type string;
          description
            "Unique identifier of this VDU in VNFD.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
        }
        leaf name {
          type string;
          mandatory true;
          description
            "Human readable name of the VDU.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
        }
        leaf description {
          type string;
          description
            "Human readable description of the VDU.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
        }
        list int-cpd {
          key "id";
          min-elements 1;
          description
            "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.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
242

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

255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
          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-list order {
            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.";
          }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
284
          uses cpd;
285 286 287 288 289 290
        }
        leaf virtual-compute-desc {
          type leafref {
            path "../../nfv:virtual-compute-descriptor/" +
                 "nfv:id";
          }
291 292 293 294 295
          must "../../nfv:virtual-compute-descriptor[id=current()]/" +
               "nfv:virtual-memory/size >=" +
               "../../nfv:sw-image-desc[id=current()/" +
               "../sw-image-desc]/min-ram" {
          }
296 297 298 299 300 301 302 303
          description
            "Describes CPU, Memory and acceleration requirements of
             the Virtualisation Container realizing this VDU.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, VDU information
             element, and Section 7.1.9.2.2, VirtualComputeDesc
             information element.";
        }
304

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
        leaf-list virtual-storage-desc {
          type leafref {
            path "../../nfv:virtual-storage-descriptor/" +
                 "nfv:id";
          }
          description
            "Describes storage requirements for a VirtualStorage
             instance attached to the virtualisation container
             created from virtualComputeDesc defined for this VDU.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, VDU information
             element, and Section 7.1.9.4, Information elements
             related to Virtual Storage.";
        }
        list boot-order {
          ordered-by user;
321 322 323 324 325
          key "key";
          leaf key {
            type uint32;
          }
          leaf value {
326 327 328 329
            type leafref {
              path "../../nfv:virtual-storage-desc";
            }
          }
330 331 332 333 334 335 336 337 338 339 340 341
          description
            "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.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, Vdu information
             element.";
342
        }
343 344 345 346
        leaf sw-image-desc {
          type leafref {
            path "../../sw-image-desc/id";
          }
347 348 349 350
          description
            "Describes the software image which is directly loaded on
             the virtualisation container realising this Vdu.";
          reference
351 352
            "GS NFV IFA011: Section 7.1.6.2, Vdu information
             element.";
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
        }
        leaf-list nfvi-constraint {
          type string;
          description
            "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.";
          reference
            "GS NFV IFA011: Section 7.1.6.2, VDU Information
             element.";
        }
        list monitoring-parameter {
          key "id";
          leaf id {
            type string;
            description
              "Unique identifier of the monitoring parameter.";
            reference
              "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
               information element.";
          }
375
          uses monitoring-parameter;
376
        }
377 378 379 380 381 382 383 384
        list configurable-properties {
          key "key";
          leaf key {
            type string;
          }
          leaf value {
            type string;
          }
385
          description
386 387
            "It provides VNFC configurable properties that can be
             modified using the ModifyVnfInfo operation.";
388
          reference
389 390 391 392 393 394 395
            "GS NFV IFA011: Section 7.1.6.7,
             VnfcConfigurableProperties Information element.";
        }
        list boot-data {
          key "key";
          leaf key {
            type string;
396
          }
397
          leaf value {
398 399
            type string;
          }
400 401 402 403 404 405 406 407 408
          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.";
409 410
        }
      }
411

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
      list virtual-compute-descriptor {
        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 {
428 429 430
          key "id";

          leaf id {
431
            type string;
432 433 434 435 436
            description
              "Identifies this set of logical node requirements.";
            reference
              "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
               Information elements.";
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

          list requirement-detail {
            key "key";

            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            description
              "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.";
            reference
              "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
               information element.";
462 463
          }
          description
464
            "The logical node requirements.";
465
          reference
466
            "GS NFV IFA011: Section 7.1.9.2, VirtualComputeDesc
467 468 469 470 471 472 473 474 475 476 477 478
             information element.";
        }

        list request-additional-capability {
          key "name";
          leaf name {
            type string;
            description
              "Identifies a requested additional capability for the
               VDU. ETSI GS NFV-IFA 002 [i.1] describes acceleration
               capabilities.";
            reference
479
              "GS NFV IFA011: Section 7.1.9.5,
480 481 482 483 484 485 486 487 488
               RequestedAdditionalCapabilityData Information
               element.";
          }
          leaf support-mandatory {
            type boolean;
            description
              "Indicates whether the requested additional capability
               is mandatory for successful operation.";
            reference
489
              "GS NFV IFA011: Section 7.1.9.5,
490 491 492 493 494 495 496
               RequestedAdditionalCapabilityData Information
               element.";
          }

          leaf min-version {
            type string;
            description
497
              "Identifies the minimum version of the requested
498 499
               additional capability.";
            reference
500
              "GS NFV IFA011: Section 7.1.9.5,
501 502 503 504 505 506 507 508 509 510
               RequestedAdditionalCapabilityData Information
               element.";
          }

          leaf preferred-version {
            type string;
            description
              "Identifies the preferred version of the requested
               additional capability.";
            reference
511
              "GS NFV IFA011: Section 7.1.9.5,
512 513 514 515 516 517 518 519 520 521 522 523
               RequestedAdditionalCapabilityData Information
               element.";
          }
          list target-performance-parameters {
            key "key";
            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            description
524
              "Identifies specific attributes, dependent on the
525 526
               requested additional capability type.";
            reference
527
              "GS NFV IFA011: Section 7.1.9.5,
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
               RequestedAdditionalCapabilityData Information
               element.";
          }
        }

        leaf compute-requirements {
          type string;
          description
            "Specifies compute requirements.";
          reference
            "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
             Information element.";
        }

        container virtual-memory {
          leaf size {
            type decimal64 {
              fraction-digits 1;
              range "0..max";
            }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
548 549
            units "GB";
            default 1;
550
            description
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
551
              "Amount of virtual memory in GB.";
552 553 554 555 556 557 558
            reference
              "GS NFV IFA011: Section 7.1.9.3, Information elements
               related to Virtual Memory.";
          }
          leaf over-subscription-policy {
            type string;
            description
559
              "The memory core oversubscription policy in terms of
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 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 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 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 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
               virtual memory to physical memory on the platform.
               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.";
          }
          list vdu-mem-requirements {
            key "key";
            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            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.";
          }

          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 {
            type string;
            description
              "CPU architecture type. Examples are x86, ARM. The
               cardinality can be 0 during the allocation request,
               if no particular CPU architecture type is requested.";
            reference
              "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
               information elements.";
          }
          leaf num-virtual-cpu {
            type uint16 {
              range "1..max";
            }
            mandatory true;
            description
              "Number of virtual CPUs.";
            reference
              "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
               information elements.";
          }
          leaf clock {
            type uint32;
            units "MHz";
            description
              "Minimum virtual CPU clock rate (e.g. in MHz). The
               cardinality can be 0 during the allocation request,
               if no particular value is requested.";
            reference
              "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
               information elements.";
          }
          leaf oversubscription-policy {
            type string;
            description
              "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.";
            reference
              "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
               information elements.";
          }
          list vdu-cpu-requirements {
            key "key";
            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            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 virtual-cpu-pinning {
            presence "Set to specify CPU pinning.";
            leaf cpu-pinning-policy {
              mandatory true;
              type enumeration {
                enum "static";
                enum "dynamic";
              }
              description
                "Indicates the policy for CPU pinning. The policy can
                 take values of 'static' or 'dynamic'. The cardinality
                 can be 0 during the allocation request, if no
                 particular value is requested.";
            }
            container cpu-pinning-map {
              when "../nfv:cpu-pinning-policy = 'static'";
            }
            description
              "If cpuPinningPolicy is defined as 'static', the
               cpuPinningMap provides the map of pinning virtual
               CPU cores to physical CPU cores/threads. Cardinality
               is 0 if cpuPinningPolicy has a different value than
               'static'.";
          }
        }
      }
691

692 693 694 695 696 697 698 699 700 701 702
      list virtual-storage-descriptor {
        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
703
            "GS NFV IFA011: Section 7.1.9.4, Information elements
704 705 706 707 708 709 710 711 712 713 714 715
             related to Virtual Storage.";
        }

        leaf type-of-storage {
          // Needed to be able to onboard images
          type enumeration {
            enum "root";
            enum "swap";
            enum "ephemeral";
          }
          mandatory true;
          description
716
            "Type of virtualised storage resource (e.g. volume,
717 718
             object).";
          reference
719
            "GS NFV IFA011: Section 7.1.9.4, Information elements
720 721 722 723
             related to Virtual Storage.";
        }
        leaf size-of-storage {
          type uint64;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
724 725
          units "GB";
          default 0;
726 727
          description
            "Size of virtualised storage resource (e.g. size of
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
728
             volume, in GB)";
729
          reference
730
            "GS NFV IFA011: Section 7.1.9.4, Information elements
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
             related to Virtual Storage.";
        }
        list vdu-storage-requirements {
          key "key";
          leaf key {
            type string;
          }
          leaf value {
            type string;
          }
          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
753
            "GS NFV IFA011: Section 7.1.9.4, Information elements
754 755 756 757
             related to Virtual Storage.";
        }
        leaf sw-image-desc {
          type leafref {
758
            path "../../sw-image-desc/id";
759
          }
760 761 762
          must "../nfv:size-of-storage >=" +
            "../../nfv:sw-image-desc[id=current()]/min-disk" {
          }
763 764 765 766 767 768 769 770
          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.";
        }
      }
771

772 773
      list sw-image-desc {
        key "id";
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 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 906 907 908 909 910
        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;
          description
            "The identifier of this software image.";
          reference
            "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
             information element";
        }
        leaf name {
          type string;
          description
            "The name of this software image.";
          reference
            "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
             information element.";
        }
        leaf version {
          type string;
          description
            "The version of this software image.";
          reference
            "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
             information element.";
        }
        leaf checksum {
          type string;
          description
            "The checksum of the software image file.";
          reference
            "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
             information element.";
        }
        leaf container-format {
          mandatory true;
          type enumeration {
            enum "aki" {
              description
                "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.";
            }
          }
          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.";
        }
        leaf disk-format {
          mandatory true;
          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.";
            }
          }
          description
            "The disk format of a software image is the format of
             the underlying disk image.";
        }
        leaf min-disk {
          type uint64;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
911
          units "GB";
912
          default 0;
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
          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.";
        }
        leaf min-ram {
          type decimal64 {
            fraction-digits 1;
            range "0..max";
          }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
928
          units "GB";
929
          default 0;
930 931 932 933 934 935 936 937 938 939 940 941
          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.";
        }
        leaf size {
          type uint64;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
942
          units "GB";
943 944 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 971 972 973 974 975 976 977 978 979 980 981
          description
            "The size of this software image.";
          reference
            "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
             information element.";
        }
        leaf image {
          mandatory true;
          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.";
        }
        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.";
        }
        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.";
        }
      }

982 983 984 985 986 987 988 989 990 991 992 993 994
      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.";
        leaf id {
          type string;
          description
            "Unique identifier of this internal VLD in VNFD.";
          reference
995 996
            "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
             Information elements.";
997 998 999 1000 1001 1002 1003 1004
        }

        list desc-flavor {
          key "id";
          description
            "Describes a specific flavour of the VL with specific
             bitrate requirements.";
          reference
1005 1006
            "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
             Information elements.";
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

          leaf id {
            type string;
            description
              "Identifies a flavour within a VnfVirtualLinkDesc.";
            reference
              "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavor
               information element.";
          }
          container qos {
            description
              "QoS of the VL.";
            reference
              "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavor
               information element.";

            leaf latency {
              type uint32;
              units "ms";
              mandatory true;
              description
                "Specifies the maximum latency in ms.";
              reference
                "GS NFV IFA011: Section 7.1.8.10, QoS information
                 element.";
            }

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

            leaf packet-loss-ratio {
              type decimal64 {
                fraction-digits "2";
                range "0..1.00";
              }
              description
                "Specifies the maximum packet loss ratio.";
              reference
                "GS NFV IFA011: Section 7.1.8.10, QoS information
                 element.";
            }
          }
        }
1058

1059
        uses connectivity-type;
1060

1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
        leaf-list test-access {
          type string;
          description
            "Specifies test access facilities expected on the VL
             (e.g. none, passive monitoring, or active (intrusive)
             loopbacks at endpoints.";
          reference
            "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
             information element.";
        }
        leaf description {
          type string;
          description
            "Provides human-readable information on the purpose of
             the VL (e.g. control plane traffic).";
          reference
            "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
             information element.";
        }
1080
        list monitoring-parameters {
1081 1082 1083 1084 1085 1086 1087 1088 1089
          key "id";
          leaf id {
            type string;
            description
              "Unique identifier of the monitoring parameter.";
          reference
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
          }
1090
          uses monitoring-parameter;
1091 1092
        }
      }
1093

1094
      uses security-group-rule;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1095

1096 1097 1098 1099 1100 1101 1102 1103 1104
      list ext-cpd {
        key "id";
        min-elements 1;

        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.";
1105

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
	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 {
              path "../../nfv:int-virtual-link-desc/nfv:id";
            }
          }
          container int-cpd {
            leaf vdu-id {
              type leafref {
                path "../../../vdu/id";
              }
            }
            leaf cpd {
              path "deref(../vdu-id)/../int-cpd/id";
            }
1126 1127 1128
          }
        }
        uses virtual-network-interface-requirements;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1129
        uses cpd;
1130 1131
      }

1132
      list df {
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
        must "nfv:default-instantiation-level or " +
             "count(nfv:instantiation-level) = 1";
        key "id";
        min-elements 1;
        description
          "Describes a specific Deployment Flavour (DF) of a VNF with
           specific requirements for capacity and performance.";
        reference
          "GS NFV IFA011: Section 7.1.2, VNFD information element.";
        leaf id {
          type string;
          description
            "Identifier of this DF within the VNFD.";
          reference
            "GS NFV IFA011: Section 7.1.8, Information elements
             to the DeploymentFlavor.";
        }
        leaf description {
          type string;
          description
            "Human readable description of the deployment flavor";
          reference
            "GS NFV IFA011: Section 7.1.8, Information elements
             to the DeploymentFlavor.";
        }
        list vdu-profile {
          key "id";
          min-elements 1;
          description
            "The Vduprofile describes additional instantiation data for
             a given VDU used in a deployment flavour.";
          reference
            "GS NFV IFA011: Section 7.1.8, Information elements
             to the DeploymentFlavor.";
          leaf id {
            type leafref {
              path "../../../nfv:vdu/nfv:id";
            }
            reference
              "GS NFV IFA011: Section 7.1.8.3, VduProfile information
               element.";
          }
          leaf min-number-of-instances {
            type uint16;
            mandatory true;
            description
              "Minimum number of instances of the VNFC based on this
               VDU that is permitted to exist for this flavour.";
            reference
              "GS NFV IFA011: Section 7.1.8.3, VduProfile information
               element.";
          }
          leaf max-number-of-instances {
            type uint16;
            mandatory true;
            must ". >= ../nfv:min-number-of-instances";
            reference
              "GS NFV IFA011: Section 7.1.8.3, VduProfile information
               element.";
          }
1193
          uses local-affinity-or-anti-affinity-rule;
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
          list affinity-or-anti-affinity-group {
            key "id";
            description
              "Identifier(s) of the affinity or anti-affinity
               group(s) the VDU belongs to.";
            reference
              "GS NFV IFA011: Section 7.1.8.3, VduProfile information
               element.";
            leaf id {
              type leafref {
                path "../../../" +
                     "nfv:affinity-or-anti-affinity-group/" +
                     "nfv:id";
              }
              description
                "Identifies an affinity or anti-affinity group to
                  which the affinity or anti-affinity rule applies.";
              reference
                "GS NFV IFA011: Section 7.1.8.12, AffinityOrAntiAffinity
                 information element.";
            }
            leaf type {
              type enumeration {
                enum affinity;
                enum anti-affinity;
              }
              description
                "Specifies whether the rule is an affinity rule or an
                 anti-affinity rule.";
              reference
                "GS NFV IFA011: Section 7.1.8.12, AffinityOrAntiAffinity
                 information element.";
            }
            leaf scope {
1228
              type affinity-scope;
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
              description
                "Specifies the scope of the rule, possible values are
                 'NFVI-PoP', 'Zone', 'ZoneGroup', 'NFVI-node'";
              reference
                "GS NFV IFA011: Section 7.1.8.12, AffinityOrAntiAffinity
                 information element.";
            }
          }
        }
        list virtual-link-profile {
          key "id flavor";
          description
            "Defines the internal VLD along with additional data which
             is used in this DF.";
          reference
            "GS NFV IFA011: Section 7.1.8.2, VnfDf information
             element.";

          leaf id {
            type leafref {
1249
              path "../../../nfv:int-virtual-link-desc/nfv:id";
1250 1251 1252 1253 1254 1255 1256 1257 1258
            }
            description
              "Uniquely identifies a Vnf VLD.";
            reference
              "GS NFV IFA011: Section 7.1.8.4, VirtualLinkProfile
               information element.";
          }
          leaf flavor {
            type leafref {
1259 1260
              path "deref(../../../ext-cpd/int-virtual-link-desc)" +
                   "/../desc-flavor/id";
1261 1262 1263 1264 1265 1266 1267
            }
            description
              "Identifies a flavour within the VnfVirtualLinkDesc.";
            reference
              "GS NFV IFA011: Section 7.1.8.4, VirtualLinkProfile
               information element.";
          }
1268
          uses local-affinity-or-anti-affinity-rule;
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
          list affinity-or-anti-affinity-group {
            key "id";
            leaf id {
              type leafref {
                path "../../../" +
                     "nfv:affinity-or-anti-affinity-group/" +
                     "nfv:id";
              }
            }
            description
              "Identifier(s) of the affinity or anti-affinity
               group(s) the VnfVirtualLinkDesc belongs to.";
            reference
              "GS NFV IFA011: Section 7.1.8.4, VirtualLinkProfile
               information element.";
          }
        }
        list instantiation-level {
          key "id";
          min-elements 1;
          description
            "Describes the various levels of resources that can be
             used to instantiate the VNF using this flavour.
             Examples: Small, Medium, Large. If there is only one
             'instantiationLevel' entry, it shall be treated as the
             default instantiation level for this DF.

             The InstantiationLevel information element describes a
             given level of resources to be instantiated within a
             deployment flavour in term of the number of VNFC instances
             to be created from each VDU.
             All the VDUs referenced in the level shall be part of the
             corresponding deployment flavour and their number shall
             be within the range (min/max) for this deployment flavour.";
          reference
            "GS NFV IFA011: Section 7.1.8.2 VnfDf information element";
          leaf id {
            type string;
            description
              "Uniquely identifies a level with the DF.";
            reference
              "GS NFV IFA011: Section 7.1.8.7 InstantiationLevel
               information element";
          }
          leaf description {
            type string;
            description
              "Human readable description of the instantiation level";
            reference
              "GS NFV IFA011: Section 7.1.8.7 InstantiationLevel
               information element";
          }
          list vdu-level {
            key "id";
            min-elements 1;
            description
              "Sets the number of instances for the VDU in this
               instantiation level.";
            reference
              "GS NFV IFA011: Section 7.1.8.7 InstantiationLevel
               information element";
            leaf id {
              type leafref {
                path "../../../../nfv:vdu/nfv:id";
              }
              description
                "Uniquely identifies a VDU.";
              reference
                "GS NFV IFA011: Section 7.1.8.9 VduLevel information
                 element";
            }
            leaf number-of-instances {
              type uint16;
1342 1343
              must ". <= ../../../../nfv:df/" +
                   "nfv:vdu-profile[id=current()/../nfv:id]/" +
1344
                   "nfv:max-number-of-instances";
1345 1346
              must ". >= ../../../../nfv:df/" +
                   "nfv:vdu-profile[id=current()/../nfv:id]/" +
1347
                   "nfv:min-number-of-instances";
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
              mandatory true;
              description
                "Number of instances of VNFC based on this VDU to
                 deploy for this level.";
              reference
                "GS NFV IFA011: Section 7.1.8.9 VduLevel information
                 element";
            }
          }
          list scaling-info {
            key "id";
            description
              "The InstantiationLevel information element describes a
               given level of resources to be instantiated within a
1362
               DF in term of the number of VNFC instances to be
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
               created from each VDU.";
            reference
              "GS NFV IFA011: Section 7.1.8.7 InstantiationLevel
               information element";
            leaf id {
              type leafref {
                path "../../../nfv:scaling-aspect/nfv:id";
              }
              description
                "Identifier of the scaling aspect.";
              reference
                "GS NFV IFA011: Section 7.1.8.8 ScaleInfo information
                 element";
            }
            leaf scale-level {
              type uint32;
              description
                "The scale level, greater than or equal to 0.";
              reference
                "GS NFV IFA011: Section 7.1.8.8 ScaleInfo information
                 element";
            }
          }
        }
        leaf default-instantiation-level {
          type leafref {
            path "../nfv:instantiation-level/nfv:id";
          }
          description
            "This attribute references the 'instantiationLevel'
             entry which defines the default instantiation level for
             this DF. It shall be present if there are multiple
             'instantiationLevel' entries.";
          reference
            "GS NFV IFA011: Section 7.1.8.2 VnfDf information
                 element";
        }
        leaf-list supported-operation {
          type identityref {
1402
            base supported-operation;
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
          }
          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";
        }
        container lcm-operations-configuration {
          description
            "This information element is a container for all
             attributes that affect the invocation of the VNF
             Lifecycle Management operations, structured by
             operation.";
          reference
            "GS NFV IFA011: Section 7.1.8.2 VnfDf information
             element";
1422

1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
          leaf instantiate-vnf-op-config {
            type string;
            description
              "Configuration parameters for the InstantiateVnf
               operation.";
            reference
              "GS NFV IFA011: Section 7.1.5.2
               VnfLcmOperationsConfiguration information element";
          }
          container scale-vnf-op-config {
            description
              "Configuration parameters for the ScaleVnf operation.";
            reference
              "GS NFV IFA011: Section 7.1.5.2
               VnfLcmOperationsConfiguration information element";

            list parameter {
              key "key";
              leaf key {
                type string;
              }
              leaf value {
                type string;
              }
              description
                "VNF-specific parameter to be passed when invoking
                 the ScaleVnf operation.";
              reference
                "GS NFV IFA011: Section 7.1.5.4 ScaleVnfOpConfig
                 information element";
            }
            leaf scaling-by-more-than-one-step-supported {
              type boolean;
              default false;
              description
                "Signals whether passing a value larger than one in
                 the numScalingSteps parameter of the ScaleVnf
                 operation is supported by this VNF.
                 Default is FALSE, i.e. 'not supported'.";
              reference
                "GS NFV IFA011: Section 7.1.5.4
                 ScaleVnfOpConfig information element";
            }
          }
          container scale-vnf-to-level-op-config {
            description
1469
              "This information element defines attributes that
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
               affect the invocation of the ScaleVnfToLevel
               operation.";
            reference
              "GS NFV IFA011: Section 7.1.5.2
               VnfLcmOperationsConfiguration information element";

            list parameter {
              key "key";
              leaf key {
                type string;
              }
              leaf value {
                type string;
              }
              description
                "VNF-specific parameter to be passed when invoking
                 the ScaleVnfToLevel operation.";
              reference
                "GS NFV IFA011: Section 7.1.5.5
                 ScaleVnfToLevelOpConfig information element";
            }
            leaf arbitrary-target-levels-supported {
              type boolean;
              description
                "Signals whether scaling according to the parameter
                 'scaleInfo' is supported by this VNF.";
              reference
                "GS NFV IFA011: Section 7.1.5.5
                 ScaleVnfToLevelOpConfig information element";
            }
          }
          container heal-vnf-op-config {
            description
              "This information element defines attributes that
               affect the invocation of the HealVnf operation.";
            reference
              "GS NFV IFA011: Section 7.1.5.2
               VnfLcmOperationsConfiguration information element";

            leaf parameter {
              type string;
              description
                "VNF-specific parameter to be passed when invoking
                 the HealVnf operation.";
              reference
                "GS NFV IFA011: Section 7.1.5.6 HealVnfOpConfig
                 information element";
            }
            leaf cause {
              type string;
              description
                "Supported 'cause' parameter values.";
              reference
                "GS NFV IFA011: Section 7.1.5.6 HealVnfOpConfig
                 information element";
            }
          }
          container terminate-vnf-op-config {
            description
1529
              "This information element defines attributes that
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
               affect the invocation of the TerminateVnf operation.";
            reference
              "GS NFV IFA011: Section 7.1.5.2
               VnfLcmOperationsConfiguration information element";
            leaf min-graceful-termination {
              type yang:timeticks;
              description
                "Minimum timeout value for graceful termination of
                 a VNF instance.";
              reference
                "GS NFV IFA011: Section 7.1.5.7
                 TerminateVnfOpConfig information element";
            }
            leaf max-recommended-graceful-termination {
              type yang:timeticks;
              description
                "Maximum recommended timeout value that can be needed
                 to gracefully terminate a VNF instance of a
                 particular type under certain conditions, such as
                 maximum load condition. This is provided by VNF
                 provider as information for the operator
                 facilitating the selection of optimal timeout value.
                 This value is not used as constraint.";
              reference
                "GS NFV IFA011: Section 7.1.5.7
                 TerminateVnfOpConfig information element";
            }
          }
          container operate-vnf-op-config {
            description
1560
              "This information element defines attributes that
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
               affect the invocation of the OperateVnf operation.";
            reference
              "GS NFV IFA011: Section 7.1.5.2
               VnfLcmOperationsConfiguration information element";

            leaf min-graceful-stop-timeout {
              type yang:timeticks;
              description
                "Minimum timeout value for graceful stop of a VNF
                 instance.";
              reference
                "GS NFV IFA011: Section 7.1.5.8
                 OperateVnfOpConfig information element";
            }
            leaf max-recommended-graceful-stop-timeout {
              type yang:timeticks;
              description
1578
                "Maximum recommended timeout value that can be
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
                 needed to gracefully stop a VNF instance of a
                 particular type under certain conditions, such as
                 maximum load condition. This is provided by VNF
                 provider as information for the operator facilitating
                 the selection of optimal timeout value. This value
                 is not used as constraint.";
              reference
                "GS NFV IFA011: Section 7.1.5.8
                 OperateVnfOpConfig information element";
            }
          }
        }
        list affinity-or-anti-affinity-group {
          key "id";
          description
            "The AffinityOrAntiAffinityGroup describes the affinity
             or anti-affinity relationship applicable between the
             virtualization containers to be created based on
             different VDUs, or between internal VLs to be created
             based on different VnfVirtualLinkDesc(s).

             Per VNF, the affinity/anti-affinity rules defined using
             this information element, using the
             LocalAffinityOrAntiAffinityRule information element, and
             using the placement constraints in the
             GrantLifecycleOperation as defined in ETSI GS NFV-IFA
             007 [i.3] should be conflict-free. In case of conflicts,
             the placement constraints in the
             GrantLifecycleOperation shall take precedence.";

          reference
            "GS NFV IFA011: Section 7.1.8.2 VnfDf information
             element";

          leaf id {
            type string;
            description
              "Identifies an affinity or anti-affinity group to which
               the affinity or anti-affinity rule applies.";
            reference
              "GS NFV IFA011: Section 7.1.8.12
               AffinityOrAntiAffinityGroup information element";
          }

          leaf type {
            mandatory true;
1625
            type affinity-type;
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
            description
              "Specifies whether the rule is an affinity rule or an
               anti-affinity rule.";
            reference
              "GS NFV IFA011: Section 7.1.8.12
               AffinityOrAntiAffinityGroup information element";
          }

          leaf scope {
            mandatory true;
1636
            type affinity-scope;
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
            description
              "Specifies the scope of the rule, possible values are
               'NFVI-PoP', 'Zone', 'ZoneGroup', 'NFVI-node'.";
            reference
              "GS NFV IFA011: Section 7.1.8.12
               AffinityOrAntiAffinityGroup information element";
          }
        }
        list monitoring-parameter {
          key "id";

          description
            "Defines the virtualised resources monitoring parameters
             on VNF level.";
          reference
            "GS NFV IFA011: Section 7.1.8.2 VnfDf information
             element";

          leaf id {
            type string;
            description
              "Unique identifier of the monitoring parameter.";
            reference
              "GS NFV IFA011: Section 7.1.11.3 MonitoringParameter
               information element";
          }
1663
          uses monitoring-parameter;
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
        }

        list scaling-aspect {
          key "id";

          description
            "The scaling aspects supported by this DF of the VNF.
             scalingAspect shall be present if the VNF supports
             scaling.";
          reference
            "GS NFV IFA011: Section 7.1.8.2 VnfDf information
             element";

          leaf id {
            type string;
            description
              "Unique identifier of this aspect in the VNFD.";
            reference
              "GS NFV IFA011: Section 7.1.10.2 ScalingAspect
               information element";
          }
          leaf name {
            type string;
            description
              "Human readable name of the aspect.";
            reference
              "GS NFV IFA011: Section 7.1.10.2 ScalingAspect
               information element";
          }
          leaf description {
            type string;
            description
              "Human readable description of the aspect.";
            reference
              "GS NFV IFA011: Section 7.1.10.2 ScalingAspect
               information element";
          }
1701 1702 1703
          leaf max-scale-level {
            type uint32 {
              range "1..max";
1704 1705
            }
            description
1706 1707 1708 1709 1710 1711
              "The maximum scaleLevel for total number of scaling
               steps that can be applied w.r.t. this aspect. The
               value of this attribute corresponds to the number of
               scaling steps can be applied to this aspect when
               scaling it from the minimum scale level (i.e. 0) to the
               maximum scale level defined by this attribute.";
1712 1713 1714 1715
            reference
              "GS NFV IFA011: Section 7.1.10.2 ScalingAspect
               information element";
          }
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842

          container aspect-delta-details {
            list deltas {
              key "id";
              min-elements 1;

              leaf id {
                type string;
                description
                  "Identifier of this scaling delta.";
                reference
                  "GS NFV IFA011: Section 7.1.10.4 ScalingDelta
                   information element";
              }

              list vdu-delta {
                key "id";

                leaf id {
                  type leafref {
                    path "/nfv/vnfd/vdu/id";
                  }
                  description
                    "Uniquely identifies a VDU.";
                  reference
                    "GS NFV IFA011: Section 7.1.8.9 VduLevel
                     information element";
                }

                leaf number-of-instances {
                  type uint32 {
                    range "0..max";
                  }
                  description
                    "Number of instances of VNFC based on this VDU to
                     deploy for an instantiation level or for a
                     scaling delta. Shall be zero or greater.";
                  reference
                    "GS NFV IFA011: Section 7.1.8.9 VduLevel
                     information element";
                }
                description
                  "The number of VNFC instances based on particular
                   VDUs to be created or removed.";
                reference
                  "GS NFV IFA011: Section 7.1.10.4 ScalingDelta
                   information element";
              }

              list virtual-link-bit-rate-delta {
                key "id";

                leaf id {
                  type string;
                  description
                    "Uniquely identifies a VnfVirtualLinkDesc.";
                  reference
                    "GS NFV IFA011: Section 7.1.10.5
                     VirtualLinkBitRateLevel information element";
                }

                container bit-rate-requirements {
                  leaf root {
                    type uint32;
                    units bits/sec;
                    mandatory true;
                    description
                      "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 uint32;
                    units bits/sec;
                    description
                      "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";
                  }
                  description
                    "Bitrate requirements for an instantiation level
                     or bitrate delta for a scaling step.";
                  reference
                    "GS NFV IFA011: Section 7.1.10.5
                     VirtualLinkBitRateLevel information element";
                }
                description
                  "The bitrate to be added or removed to virtual links
                   created from particular virtual link descriptors.";
                reference
                  "GS NFV IFA011: Section 7.1.10.4 ScalingDelta
                   information element";
              }
              description
                "Declares different scaling deltas, each of which is
                 applied for one or more scaling steps of this
                 aspect.";
              reference
                "GS NFV IFA011: Section 7.1.10.3 AspectDeltaDetails
                 information element";
            }

            leaf step-deltas {
              type leafref {
                path "../deltas/id";
              }
              description
                "Identifiers of the individual scaling deltas to be
                 applied for the subsequent scaling steps of this
                 aspect. The first entry in the array shall correspond
                 to the first scaling step (between scale levels 0 to
                 1) and the last entry in the array shall correspond
                 to the last scaling step (between maxScaleLevel-1
                 and maxScaleLevel).

                 Each referenced scaling delta shall be declared in
                 the 'deltas' attribute.";
              reference
                "GS NFV IFA011: Section 7.1.10.3 AspectDeltaDetails
                 information element";
1843 1844
            }
            description
1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
              "A specification of the deltas in terms of number of
               instances of VNFCs and virtual link bit rates that
               correspond to the scaling steps of this aspect. A
               cardinality of zero indicates that this mapping has to
               be specified in a lifecycle management script or be
               otherwise known to the VNFM. The information in this
               attribute, if provided, shall be consistent with the
               information provided in the 'InstantiationLevel'
               information element. If this attribute is provided, it
               shall be provided for all scaling aspects.";
1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
            reference
              "GS NFV IFA011: Section 7.1.10.2 ScalingAspect
               information element";
          }
        }
      }

      container configurable-properties {
        description
          "Describes the configurable properties of the VNF
           (e.g. related to auto scaling and auto healing).";
        reference
          "GS NFV IFA011: Section 7.1.2 VNFD information element";

        leaf auto-scalable {
          type boolean;
          description
            "It permits to enable (TRUE) / disable (FALSE) the
             auto-scaling functionality.";
          reference
            "GS NFV IFA011: Section 7.1.12 VnfConfigurableProperties
             information element";
        }
        leaf auto-healable {
          type boolean;
          description
            "It permits to enable (TRUE) / disable (FALSE) the
             auto-healing functionality.";
          reference
            "GS NFV IFA011: Section 7.1.12 VnfConfigurableProperties
             information element";
        }
1887 1888 1889 1890 1891 1892 1893 1894
        list additional-configurable-property {
          key "key";
          leaf key {
            type string;
          }
          leaf value {
            type string;
          }
1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
          description
            "It provides VNF specific configurable properties that can
             be modified using the ModifyVnfConfiguration operation.";
          reference
            "GS NFV IFA011: Section 7.1.12 VnfConfigurableProperties
             information element";
        }
      }

      container modifiable-attributes {
        description
          "Describes the modifiable attributes of the VNF.";
        reference
          "GS NFV IFA011: Section 7.1.2 VNFD information element";

        leaf-list extension {
          type string;
          description
            "'Extension' attributes of VnfInfo that are writeable.";
          reference
            "GS NFV IFA011: Section 7.1.14 VnfInfoModifiableAttributes
             information element";
        }
        leaf-list metadata {
          type string;
          description
            "'Metadata' attributes of VnfInfo that are writeable.";
          reference
            "GS NFV IFA011: Section 7.1.14 VnfInfoModifiableAttributes
             information element";
        }
      }

      list lifecycle-management-script {
        key "event";
        description
          "Includes a list of events and corresponding management
           scripts performed for the VNF.";
        reference
          "GS NFV IFA011: Section 7.1.2 VNFD information element";

        leaf event {
1937
          type internal-lifecycle-management-script-event;
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
          description
            "Describes VNF lifecycle event(s) or an external stimulus
             detected on a VNFM reference point.";
          reference
            "GS NFV IFA011: Section 7.1.13 LifeCycleManagementScript
             information element";
        }
        leaf lcm-transition-event {
          type string;
          description
            "Describes the transition VNF lifecycle event(s) that
             cannot be mapped to any of the enumerated values
             defined for the event attribute.";
          reference
            "GS NFV IFA011: Section 7.1.13 LifeCycleManagementScript
             information element";
        }
        leaf script {
          type string;
          description
            "Includes a VNF LCM script (e.g. written in a DSL as
             specified in requirement VNF_PACK.LCM.001) triggered to
             react to one of the events listed in the event
             attribute.";
          reference
            "GS NFV IFA011: Section 7.1.13 LifeCycleManagementScript
             information element";
        }
        leaf script-dsl {
          type string;
          description
            "Defines the domain specific language (i.e. the type) of
             script that is provided. Types of scripts could include
             bash, python, etc.";
          reference
            "GS NFV IFA011: Section 7.1.13 LifeCycleManagementScript
             information element";
        }
        list script-input {
          key "key";
          leaf key {
            type string;
          }
          leaf value {
            type string;
          }
          description
            "Array of KVP requirements with the key as the parameter
             name and the value as the parameter that need to be
             passed as an input to the script.";
          reference
            "GS NFV IFA011: Section 7.1.13 LifeCycleManagementScript
             information element";
        }
      }

      list element-group {
        key "id";
        description
          "Describes the associated elements of a VNFD for a certain
           purpose during VNF lifecycle management.";
        reference
          "GS NFV IFA011: Section 7.1.2 VNFD information element";

        leaf id {
          type string;
          description
            "Unique identifier of this group in the VNFD.";
          reference
            "GS NFV IFA011: Section 7.1.4 VnfdElementGroup
             information element";
        }
        leaf description {
          type string;
          description
            "Human readable description of the group.";
          reference
            "GS NFV IFA011: Section 7.1.4 VnfdElementGroup
             information element";
        }
        leaf-list vdu {
          type leafref {
            path "../../nfv:vdu/nfv:id";
          }
          description
            "References to Vdus that are part of this group.";
          reference
            "GS NFV IFA011: Section 7.1.4 VnfdElementGroup
             information element";
        }
        leaf-list virtual-link-desc {
          type leafref {
2030
            path "../../nfv:int-virtual-link-desc/nfv:id";
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
          }
          description
            "References to VnfVirtualLinkDesc that are part of this
             group.";
          reference
            "GS NFV IFA011: Section 7.1.4 VnfdElementGroup
             information element";
        }
      }

      list indicator {
        key "id";
        description
          "Declares the VNF indicators that are supported by this
           VNF.";
        reference
          "GS NFV IFA011: Section 7.1.2 VNFD information element";

        leaf id {
          type string;
          description
            "Unique identifier";
          reference
            "GS NFV IFA011: Section 7.1.11.2 VnfdIndicator
             information element";
        }
        leaf name {
          type string;
          description
            "The human readable name of the VnfIndicator.";
          reference
            "GS NFV IFA011: Section 7.1.11.2 VnfdIndicator
             information element";
        }
        leaf-list indicator-value {
          type string;
          description
            "Defines the allowed values or value ranges of this
             indicator.";
          reference
            "GS NFV IFA011: Section 7.1.11.2 VnfdIndicator
             information element";
        }
        leaf source {
          type enumeration {
            enum "vnf";
            enum "em";
            enum "both";
          }
          description
            "Describe the source of the indicator. The possible values
             are:
             • VNF.
             • EM.
             • Both.
             This tells the consumer where to send the subscription
             request.";
          reference
            "GS NFV IFA011: Section 7.1.11.2 VnfdIndicator
             information element";
        }
      }

      leaf-list auto-scale {
        type string;
        description
          "Rule that determines when a scaling action needs to be
           triggered on a VNF instance e.g. based on certain VNF
           indicator values or VNF indicator value changes or a
           combination of VNF indicator value(s) and monitoring
           parameter(s).";
        reference
          "GS NFV IFA011: Section 7.1.2 VNFD information element";
      }
    }
  }
}