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;
72 grouping virtual-interface {
73 container virtual-interface {
75 "Container for the virtual interface properties";
79 "Specifies the type of virtual interface
81 VIRTIO : Use the traditional VIRTIO interface.
82 PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface.
83 SR-IOV : Use SR-IOV interface.
84 E1000 : Emulate E1000 interface.
85 RTL8139 : Emulate RTL8139 interface.
86 PCNET : Emulate PCNET interface.
87 OM-MGMT : Used to specify openmano mgmt external-connection type";
103 "Specifies the virtual PCI address. Expressed in
104 the following format dddd:dd:dd.d. For example
105 0000:00:12.0. This information can be used to
106 pass as metadata during the VM creation.";
112 "Aggregate bandwidth of the NIC.";
118 container vnfd-catalog {
121 "Virtual Network Function Descriptor (VNFD).";
127 description "Identifier for the VNFD.";
132 description "VNFD name.";
138 description "VNFD short name.";
143 description "Vendor of the VNFD.";
149 "Vendor logo for the Virtual Network Function";
154 description "Description of the VNFD.";
159 description "Version of the VNFD";
163 uses manotypes:vnf-configuration;
165 container mgmt-interface {
167 "Interface over which the VNF is managed.";
169 choice endpoint-type {
171 "Indicates the type of management endpoint.";
175 "Specifies the static IP address for managing the VNF.";
177 type inet:ip-address;
183 "Use the default management interface on this VDU.";
186 path "/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:id";
193 "Use the ip address associated with this connection point.";
196 path "/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:connection-point/vnfd:name";
204 "Port for the management interface.";
205 type inet:port-number;
208 container dashboard-params {
209 description "Parameters for the VNF dashboard";
212 description "The HTTP path for the dashboard";
217 description "Pick HTTPS instead of HTTP , Default is false";
222 description "The HTTP port for the dashboard";
223 type inet:port-number;
231 "List of Internal Virtual Link Descriptors (VLD).
232 The internal VLD describes the basic topology of
233 the connectivity (e.g. E-LAN, E-Line, E-Tree)
234 between internal VNF components of the system.";
237 description "Identifier for the VLD";
242 description "Name of the internal VLD";
247 description "Short name of the internal VLD";
256 type manotypes:virtual-link-type;
259 leaf root-bandwidth {
261 "For ELAN this is the aggregate bandwidth.";
265 leaf leaf-bandwidth {
267 "For ELAN this is the bandwidth of branches.";
271 list internal-connection-point {
273 description "List of internal connection points in this VLD";
275 description "reference to the internal connection point id";
277 path "../../../vdu/internal-connection-point/id";
281 uses manotypes:provider-network;
284 list connection-point {
287 "List for external connection points. Each VNF has one
288 or more external connection points. As the name
289 implies that external connection points are used for
290 connecting the VNF to other VNFs or to external networks.
291 Each VNF exposes these connection points to the
292 orchestrator. The orchestrator can construct network
293 services by connecting the connection points between
294 different VNFs. The NFVO will use VLDs and VNFFGs at
295 the network service level to construct network services.";
297 uses common-connection-point;
301 description "List of Virtual Deployment Units";
305 description "Unique id for the VDU";
310 description "Unique name for the VDU";
315 description "Description of the VDU.";
320 description "Number of instances of VDU";
326 "Specifies the virtual PCI address. Expressed in
327 the following format dddd:dd:dd.d. For example
328 0000:00:12.0. This information can be used to
329 pass as metadata during the VM creation.";
333 uses manotypes:vm-flavor;
334 uses manotypes:guest-epa;
335 uses manotypes:vswitch-epa;
336 uses manotypes:hypervisor-epa;
337 uses manotypes:host-epa;
342 uses manotypes:alarm;
345 uses manotypes:image-properties;
347 choice cloud-init-input {
349 "Indicates how the contents of cloud-init script are provided.
350 There are 2 choices - inline or in a file";
355 "Contents of cloud-init script, provided inline, in cloud-config format";
361 leaf cloud-init-file {
363 "Name of file with contents of cloud-init script in cloud-config format";
369 list internal-connection-point {
372 "List for internal connection points. Each VNFC
373 has zero or more internal connection points.
374 Internal connection points are used for connecting
375 the VNF components internal to the VNF. If a VNF
376 has only one VNFC, it may not have any internal
379 uses common-connection-point;
381 leaf internal-vld-ref {
383 path "../../../internal-vld/id";
388 list internal-interface {
390 "List of internal interfaces for the VNF";
395 "Name of internal interface. Note that this
396 name has only local significance to the VDU.";
400 leaf vdu-internal-connection-point-ref {
402 path "../../internal-connection-point/id";
405 uses virtual-interface;
408 list external-interface {
410 "List of external interfaces for the VNF.
411 The external interfaces enable sending
412 traffic to and from VNF.";
417 "Name of the external interface. Note that
418 this name has only local significance.";
422 leaf vnfd-connection-point-ref {
424 "Name of the external connection point.";
426 path "../../../connection-point/name";
429 uses virtual-interface;
436 description "Name of the disk-volumes, e.g. vda, vdb etc";
440 uses manotypes:volume-info;
444 list vdu-dependency {
446 "List of VDU dependencies.";
449 leaf vdu-source-ref {
455 leaf vdu-depends-on-ref {
457 "Reference to the VDU that
458 source VDU depends.";
465 leaf service-function-chain {
466 description "Type of node in Service Function Chaining Architecture";
477 leaf service-function-type {
479 "Type of Service Function.
480 NOTE: This needs to map with Service Function Type in ODL to
481 support VNFFG. Service Function Type is manadatory param in ODL
482 SFC. This is temporarily set to string for ease of use";
486 uses manotypes:monitoring-param;
488 list placement-groups {
489 description "List of placement groups at VNF level";
492 uses manotypes:placement-group-info;
497 "List of VDUs that are part of this placement group";
498 key "member-vdu-ref";
500 leaf member-vdu-ref {
502 path "../../../vdu/id";