4 * Copyright 2016 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 "urn:ietf:params:xml:ns:yang:nfvo:vnfd";
34 import ietf-yang-types {
38 import ietf-inet-types {
44 "Initial revision. This YANG file defines
45 the Virtual Network Function (VNF)";
47 "Derived from earlier versions of base YANG files";
50 grouping common-connection-point {
52 description "Name of the connection point";
57 description "Identifier for the internal connection points";
62 description "Short name of the connection point";
67 description "Type of the connection point.";
68 type manotypes:connection-point-type;
70 leaf port-security-enabled {
71 description "Enables the port security for the port";
77 grouping virtual-interface {
78 container virtual-interface {
80 "Container for the virtual interface properties";
84 "Specifies the type of virtual interface
86 VIRTIO : Use the traditional VIRTIO interface.
87 PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface.
88 SR-IOV : Use SR-IOV interface.
89 E1000 : Emulate E1000 interface.
90 RTL8139 : Emulate RTL8139 interface.
91 PCNET : Emulate PCNET interface.
92 OM-MGMT : Used to specify openmano mgmt external-connection type";
108 "Specifies the virtual PCI address. Expressed in
109 the following format dddd:dd:dd.d. For example
110 0000:00:12.0. This information can be used to
111 pass as metadata during the VM creation.";
117 "Aggregate bandwidth of the NIC.";
123 grouping vnfd-descriptor {
125 description "Identifier for the VNFD.";
130 description "VNFD name.";
136 description "VNFD short name.";
141 description "Vendor of the VNFD.";
147 "Vendor logo for the Virtual Network Function";
152 description "Description of the VNFD.";
157 description "Version of the VNFD";
161 uses manotypes:vnf-configuration;
163 container mgmt-interface {
165 "Interface over which the VNF is managed.";
167 choice endpoint-type {
169 "Indicates the type of management endpoint.";
173 "Specifies the static IP address for managing the VNF.";
175 type inet:ip-address;
181 "Use the default management interface on this VDU.";
184 path "/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:id";
191 "Use the ip address associated with this connection point.";
194 path "/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:connection-point/vnfd:name";
202 "Port for the management interface.";
203 type inet:port-number;
206 container dashboard-params {
207 description "Parameters for the VNF dashboard";
210 description "The HTTP path for the dashboard";
215 description "Pick HTTPS instead of HTTP , Default is false";
220 description "The HTTP port for the dashboard";
221 type inet:port-number;
229 "List of Internal Virtual Link Descriptors (VLD).
230 The internal VLD describes the basic topology of
231 the connectivity (e.g. E-LAN, E-Line, E-Tree)
232 between internal VNF components of the system.";
235 description "Identifier for the VLD";
240 description "Name of the internal VLD";
245 description "Short name of the internal VLD";
254 type manotypes:virtual-link-type;
257 leaf root-bandwidth {
259 "For ELAN this is the aggregate bandwidth.";
263 leaf leaf-bandwidth {
265 "For ELAN this is the bandwidth of branches.";
270 list internal-connection-point {
272 description "List of internal connection points in this VLD";
274 description "reference to the internal connection point id";
276 path "../../../vdu/internal-connection-point/id";
280 uses manotypes:provider-network;
282 description "Extra parameters for VLD instantiation";
284 case vim-network-ref {
285 leaf vim-network-name {
287 "Name of network in VIM account. This is used to indicate
288 pre-provisioned network name in cloud account.";
293 case vim-network-profile {
294 leaf ip-profile-ref {
295 description "Named reference to IP-profile object";
303 uses manotypes:ip-profile-list;
305 list connection-point {
308 "List for external connection points. Each VNF has one
309 or more external connection points. As the name
310 implies that external connection points are used for
311 connecting the VNF to other VNFs or to external networks.
312 Each VNF exposes these connection points to the
313 orchestrator. The orchestrator can construct network
314 services by connecting the connection points between
315 different VNFs. The NFVO will use VLDs and VNFFGs at
316 the network service level to construct network services.";
318 uses common-connection-point;
322 description "List of Virtual Deployment Units";
326 description "Unique id for the VDU";
331 description "Unique name for the VDU";
336 description "Description of the VDU.";
341 description "Number of instances of VDU";
347 "Specifies the virtual PCI address. Expressed in
348 the following format dddd:dd:dd.d. For example
349 0000:00:12.0. This information can be used to
350 pass as metadata during the VM creation.";
354 uses manotypes:vm-flavor;
355 uses manotypes:guest-epa;
356 uses manotypes:vswitch-epa;
357 uses manotypes:hypervisor-epa;
358 uses manotypes:host-epa;
363 uses manotypes:alarm;
366 uses manotypes:image-properties;
368 choice cloud-init-input {
370 "Indicates how the contents of cloud-init script are provided.
371 There are 2 choices - inline or in a file";
376 "Contents of cloud-init script, provided inline, in cloud-config format";
382 leaf cloud-init-file {
384 "Name of file with contents of cloud-init script in cloud-config format";
390 uses manotypes:supplemental-boot-data;
392 list internal-connection-point {
395 "List for internal connection points. Each VNFC
396 has zero or more internal connection points.
397 Internal connection points are used for connecting
398 the VNF components internal to the VNF. If a VNF
399 has only one VNFC, it may not have any internal
402 uses common-connection-point;
404 leaf internal-vld-ref {
406 path "../../../internal-vld/id";
411 list internal-interface {
413 "List of internal interfaces for the VNF";
418 "Name of internal interface. Note that this
419 name has only local significance to the VDU.";
423 leaf vdu-internal-connection-point-ref {
425 path "../../internal-connection-point/id";
428 uses virtual-interface;
431 list external-interface {
433 "List of external interfaces for the VNF.
434 The external interfaces enable sending
435 traffic to and from VNF.";
440 "Name of the external interface. Note that
441 this name has only local significance.";
445 leaf vnfd-connection-point-ref {
447 "Name of the external connection point.";
449 path "../../../connection-point/name";
452 uses virtual-interface;
459 description "Name of the disk-volumes, e.g. vda, vdb etc";
463 uses manotypes:volume-info;
467 list vdu-dependency {
469 "List of VDU dependencies.";
472 leaf vdu-source-ref {
478 leaf vdu-depends-on-ref {
480 "Reference to the VDU that
481 source VDU depends.";
488 leaf service-function-chain {
489 description "Type of node in Service Function Chaining Architecture";
500 leaf service-function-type {
502 "Type of Service Function.
503 NOTE: This needs to map with Service Function Type in ODL to
504 support VNFFG. Service Function Type is manadatory param in ODL
505 SFC. This is temporarily set to string for ease of use";
509 uses manotypes:monitoring-param;
511 list placement-groups {
512 description "List of placement groups at VNF level";
515 uses manotypes:placement-group-info;
520 "List of VDUs that are part of this placement group";
521 key "member-vdu-ref";
523 leaf member-vdu-ref {
525 path "../../../vdu/id";
532 container vnfd-catalog {
534 "Virtual Network Function Descriptor (VNFD).";
539 uses vnfd-descriptor;