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";
70 typedef interface-type {
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.";
132 description "VNFD name.";
138 description "Short name to appear as label in the UI";
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.";
193 "Use the ip address associated with this connection point.";
196 path "../../connection-point/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 such as 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 to appear as label in the UI";
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";
282 uses manotypes:provider-network;
284 description "Extra parameters for VLD instantiation";
286 case vim-network-ref {
287 leaf vim-network-name {
289 "Name of network in VIM account. This is used to indicate
290 pre-provisioned network name in cloud account.";
295 case vim-network-profile {
296 leaf ip-profile-ref {
297 description "Named reference to IP-profile object";
305 uses manotypes:ip-profile-list;
307 list connection-point {
310 "List for external connection points. Each VNF has one
311 or more external connection points that connect the VNF
312 to other VNFs or to external networks. Each VNF exposes
313 connection points to the orchestrator, which can construct
314 network services by connecting the connection points
315 between different VNFs. The NFVO will use VLDs and VNFFGs
316 at 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;
359 uses manotypes:image-properties;
361 choice cloud-init-input {
363 "Indicates how the contents of cloud-init script are provided.
364 There are 2 choices - inline or in a file";
369 "Contents of cloud-init script, provided inline, in cloud-config format";
375 leaf cloud-init-file {
377 "Name of file with contents of cloud-init script in cloud-config format";
383 uses manotypes:supplemental-boot-data;
385 list internal-connection-point {
388 "List for internal connection points. Each VNFC
389 has zero or more internal connection points.
390 Internal connection points are used for connecting
391 the VNF with components internal to the VNF. If a VNF
392 has only one VNFC, it may not have any internal
395 uses common-connection-point;
397 leaf internal-vld-ref {
399 path "../../../internal-vld/id";
406 "List of Interfaces (external and internal) for the VNF";
411 "Name of the interface. Note that this
412 name has only local significance to the VDU.";
418 "Explicit Position of the interface within the list";
424 "Type of the Interface";
430 choice connection-point-type {
432 leaf internal-connection-point-ref {
434 "Leaf Ref to the particular internal connection point";
436 path "../../internal-connection-point/id";
441 leaf external-connection-point-ref {
443 "Leaf Ref to the particular external connection point";
445 path "../../../connection-point/name";
451 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 on which
481 the 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 mandatory 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";