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;
71 leaf static-ip-address {
72 description "Static IP address for the connection point";
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.";
269 list internal-connection-point {
271 description "List of internal connection points in this VLD";
273 description "reference to the internal connection point id";
275 path "../../../vdu/internal-connection-point/id";
280 uses manotypes:provider-network;
283 list connection-point {
286 "List for external connection points. Each VNF has one
287 or more external connection points. As the name
288 implies that external connection points are used for
289 connecting the VNF to other VNFs or to external networks.
290 Each VNF exposes these connection points to the
291 orchestrator. The orchestrator can construct network
292 services by connecting the connection points between
293 different VNFs. The NFVO will use VLDs and VNFFGs at
294 the network service level to construct network services.";
296 uses common-connection-point;
300 description "List of Virtual Deployment Units";
304 description "Unique id for the VDU";
309 description "Unique name for the VDU";
314 description "Description of the VDU.";
319 description "Number of instances of VDU";
325 "Specifies the virtual PCI address. Expressed in
326 the following format dddd:dd:dd.d. For example
327 0000:00:12.0. This information can be used to
328 pass as metadata during the VM creation.";
332 uses manotypes:vm-flavor;
333 uses manotypes:guest-epa;
334 uses manotypes:vswitch-epa;
335 uses manotypes:hypervisor-epa;
336 uses manotypes:host-epa;
341 uses manotypes:alarm;
344 uses manotypes:image-properties;
346 choice cloud-init-input {
348 "Indicates how the contents of cloud-init script are provided.
349 There are 2 choices - inline or in a file";
354 "Contents of cloud-init script, provided inline, in cloud-config format";
360 leaf cloud-init-file {
362 "Name of file with contents of cloud-init script in cloud-config format";
368 list internal-connection-point {
371 "List for internal connection points. Each VNFC
372 has zero or more internal connection points.
373 Internal connection points are used for connecting
374 the VNF components internal to the VNF. If a VNF
375 has only one VNFC, it may not have any internal
378 uses common-connection-point;
380 leaf internal-vld-ref {
382 path "../../../internal-vld/id";
387 list internal-interface {
389 "List of internal interfaces for the VNF";
394 "Name of internal interface. Note that this
395 name has only local significance to the VDU.";
399 leaf vdu-internal-connection-point-ref {
401 path "../../internal-connection-point/id";
404 uses virtual-interface;
407 list external-interface {
409 "List of external interfaces for the VNF.
410 The external interfaces enable sending
411 traffic to and from VNF.";
416 "Name of the external interface. Note that
417 this name has only local significance.";
421 leaf vnfd-connection-point-ref {
423 "Name of the external connection point.";
425 path "../../../connection-point/name";
428 uses virtual-interface;
435 description "Name of the disk-volumes, e.g. vda, vdb etc";
439 uses manotypes:volume-info;
443 list vdu-dependency {
445 "List of VDU dependencies.";
448 leaf vdu-source-ref {
454 leaf vdu-depends-on-ref {
456 "Reference to the VDU that
457 source VDU depends.";
464 leaf service-function-chain {
465 description "Type of node in Service Function Chaining Architecture";
476 leaf service-function-type {
478 "Type of Service Function.
479 NOTE: This needs to map with Service Function Type in ODL to
480 support VNFFG. Service Function Type is manadatory param in ODL
481 SFC. This is temporarily set to string for ease of use";
485 uses manotypes:monitoring-param;
487 list placement-groups {
488 description "List of placement groups at VNF level";
491 uses manotypes:placement-group-info;
496 "List of VDUs that are part of this placement group";
497 key "member-vdu-ref";
499 leaf member-vdu-ref {
501 path "../../../vdu/id";
508 container vnfd-catalog {
510 "Virtual Network Function Descriptor (VNFD).";
515 uses vnfd-descriptor;