4 * Copyright 2017 RIFT.IO Inc
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
23 namespace "http://riftio.com/ns/riftware-1.0/vnfd-base";
30 import ietf-inet-types {
36 "Initial revision. This YANG file defines
37 the common types for Virtual Network Function
40 "Derived from earlier versions of base YANG files";
43 grouping common-connection-point {
45 description "Name of the connection point";
50 description "Identifier for the internal connection points";
55 description "Short name to appear as label in the UI";
60 description "Type of the connection point.";
61 type manotypes:connection-point-type;
64 leaf port-security-enabled {
65 description "Enables the port security for the port";
71 typedef interface-type {
78 typedef vnf-operational-status {
89 grouping virtual-interface {
90 container virtual-interface {
92 "Container for the virtual interface properties";
96 "Specifies the type of virtual interface
98 VIRTIO : Use the traditional VIRTIO interface.
99 PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface.
100 SR-IOV : Use SR-IOV interface.
101 E1000 : Emulate E1000 interface.
102 RTL8139 : Emulate RTL8139 interface.
103 PCNET : Emulate PCNET interface.
104 OM-MGMT : Deprecated! Use VIRTIO instead and set the VNF management interface at vnfd:mgmt-interface:cp";
108 enum PCI-PASSTHROUGH;
120 "Specifies the virtual PCI address. Expressed in
121 the following format dddd:dd:dd.d. For example
122 0000:00:12.0. This information can be used to
123 pass as metadata during the VM creation.";
129 "Aggregate bandwidth of the NIC.";
135 grouping vnfd-descriptor {
137 description "Identifier for the VNFD.";
144 description "VNFD name.";
150 description "Short name to appear as label in the UI";
155 description "Vendor of the VNFD.";
161 "Vendor logo for the Virtual Network Function";
166 description "Description of the VNFD.";
171 description "Version of the VNFD";
175 container vnf-configuration {
176 uses manotypes:vca-configuration;
179 leaf operational-status {
181 "The operational status of the VNF
182 init : The VNF has just started.
183 running : The VNF is active in VM
184 upgrading : The VNF is being upgraded (EXPERIMENTAL)
185 terminate : The VNF is being terminated
186 terminated : The VNF is in the terminated state.
187 failed : The VNF instantiation failed.
189 type vnf-operational-status;
192 container mgmt-interface {
194 "Interface over which the VNF is managed.";
196 choice endpoint-type {
198 "Indicates the type of management endpoint.";
202 "Specifies the static IP address for managing the VNF.";
204 type inet:ip-address;
210 "Use the default management interface on this VDU.";
220 "Use the ip address associated with this connection point. This cp is then considered as management.";
223 path "../../connection-point/name";
231 "Port for the management interface.";
232 type inet:port-number;
235 container dashboard-params {
236 description "Parameters for the VNF dashboard";
239 description "The HTTP path for the dashboard";
244 description "Pick HTTPS instead of HTTP , Default is false";
249 description "The HTTP port for the dashboard";
250 type inet:port-number;
258 "List of Internal Virtual Link Descriptors (VLD).
259 The internal VLD describes the basic topology of
260 the connectivity such as E-LAN, E-Line, E-Tree.
261 between internal VNF components of the system.";
264 description "Identifier for the VLD";
269 description "Name of the internal VLD";
274 description "Short name to appear as label in the UI";
283 type manotypes:virtual-link-type;
286 leaf root-bandwidth {
288 "For ELAN this is the aggregate bandwidth.";
292 leaf leaf-bandwidth {
294 "For ELAN this is the bandwidth of branches.";
298 list internal-connection-point {
300 description "List of internal connection points in this VLD";
302 description "reference to the internal connection point id";
304 path "../../../vdu/internal-connection-point/id";
308 description "IP address of the internal connection point";
309 type inet:ip-address;
313 uses manotypes:provider-network;
315 description "Extra parameters for VLD instantiation";
317 case vim-network-ref {
318 leaf vim-network-name {
320 "Name of network in VIM account. This is used to indicate
321 pre-provisioned network name in cloud account.";
326 case vim-network-profile {
327 leaf ip-profile-ref {
328 description "Named reference to IP-profile object";
336 uses manotypes:ip-profile-list;
338 list connection-point {
341 "List for external connection points. Each VNF has one
342 or more external connection points that connect the VNF
343 to other VNFs or to external networks. Each VNF exposes
344 connection points to the orchestrator, which can construct
345 network services by connecting the connection points
346 between different VNFs. The NFVO will use VLDs and VNFFGs
347 at the network service level to construct network services.";
349 uses common-connection-point;
351 leaf internal-vld-ref {
353 "Reference to an internal VLD of the VNF. This field is
354 optional. It allows exposing an internal VLD through a
355 connection point. When building a NS, this VNF CP might be
356 connected to a NS VLD, then both VLDs (the i-VLD of the VNF and the
357 VLD of the NS) will become the same network and the IP profile will
358 be the one configured at NS level.";
360 path "../../internal-vld/id";
366 description "List of Virtual Deployment Units";
370 description "Unique id for the VDU";
375 description "Unique name for the VDU";
380 description "Description of the VDU.";
385 description "Number of instances of VDU";
391 "Specifies the virtual PCI address. Expressed in
392 the following format dddd:dd:dd.d. For example
393 0000:00:12.0. This information can be used to
394 pass as metadata during the VM creation.";
398 uses manotypes:vm-flavor;
399 uses manotypes:guest-epa;
400 uses manotypes:vswitch-epa;
401 uses manotypes:hypervisor-epa;
402 uses manotypes:host-epa;
407 uses manotypes:alarm;
410 uses manotypes:image-properties;
412 list alternative-images {
415 "List of alternative images per VIM type.
416 Different images can be used for specific types of VIMs instead
417 of the default image. This allows deployments in sites where the
418 image identifier in the VIM is given by the VIM provider and
420 If an alternative image is specified for a VIM type, it will prevail
421 over the default image";
424 description "VIM type: openvim, openstack, vmware, aws, etc.";
428 uses manotypes:image-properties;
431 container vdu-configuration {
432 uses manotypes:vca-configuration;
435 choice cloud-init-input {
437 "Indicates how the contents of cloud-init script are provided.
438 There are 2 choices - inline or in a file";
443 "Contents of cloud-init script, provided inline, in cloud-config format";
449 leaf cloud-init-file {
451 "Name of file with contents of cloud-init script in cloud-config format";
457 uses manotypes:supplemental-boot-data;
459 list internal-connection-point {
462 "List for internal connection points. Each VNFC
463 has zero or more internal connection points.
464 Internal connection points are used for connecting
465 the VNF with components internal to the VNF. If a VNF
466 has only one VNFC, it may not have any internal
469 uses common-connection-point;
471 leaf internal-vld-ref {
473 path "../../../internal-vld/id";
480 "List of Interfaces (external and internal) for the VNF";
485 "Name of the interface. Note that this
486 name has only local significance to the VDU.";
492 "Explicit Position of the interface within the list";
498 "Type of the Interface";
506 "MAC address of the interface.
507 Some VNFs require a specific MAC address to be configured
508 in the interface. While this is not recommended at all in
509 NFV environments, this parameter exists to allow those
511 This parameter will be likely deprecated in the future.";
515 choice connection-point-type {
517 leaf internal-connection-point-ref {
519 "Leaf Ref to the particular internal connection point";
521 path "../../internal-connection-point/id";
526 leaf external-connection-point-ref {
528 "Leaf Ref to the particular external connection point";
530 path "../../../connection-point/name";
536 uses virtual-interface;
544 description "Name of the disk-volumes, e.g. vda, vdb etc";
548 uses manotypes:volume-info;
552 list vdu-dependency {
554 "List of VDU dependencies.";
557 leaf vdu-source-ref {
563 leaf vdu-depends-on-ref {
565 "Reference to the VDU on which
566 the source VDU depends.";
573 leaf service-function-chain {
574 description "Type of node in Service Function Chaining Architecture";
585 leaf service-function-type {
587 "Type of Service Function.
588 NOTE: This needs to map with Service Function Type in ODL to
589 support VNFFG. Service Function Type is mandatory param in ODL
590 SFC. This is temporarily set to string for ease of use";
594 uses manotypes:monitoring-param;
596 list placement-groups {
597 description "List of placement groups at VNF level";
600 uses manotypes:placement-group-info;
605 "List of VDUs that are part of this placement group";
606 key "member-vdu-ref";
608 leaf member-vdu-ref {
610 path "../../../vdu/id";