Jump to: navigation, search

Release/Helium/VTN/Installation Guide

This was last updated for the Helium release and needs to be updated. Please bear that in mind when reading the content and feel free to help update it.


This guide explains how to install VTN Coordinator and VTN Manager to use VTN API.

VTN Manager is a set of OSGi bundles running in OpenDaylight controller, and VTN Coordinator is an application running outside the controller.

It is recommended to install VTN Coordinator and OpenDaylight controller on different machines, since their supported platforms and prerequisites are different.

Supported Platforms

Software Supported Platforms
VTN Manager All Java Platform
VTN Coordinator

(64-bit version of below Linux variants)
Fedora 20
CentOS 6
CentOS 7

Downloading Helium

Observation: If you are using Ubuntu (or Debian like OS) go to installation from source: https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):Installation:VTN_Coordinator

1. Go to the download page of opendaylight.org.
2. Download the Pre-Built Zip File or Pre-Built Tar File of the latest Helium.
3. Extract files from the downloaded file.
unzip distribution-karaf-0.2.1-Helium-SR1.zip
tar zxvf distribution-karaf-0.2.1-Helium-SR1.tar.gz

Setting up VTN Coordinator

Arrange a physical/virtual server with any one of the supported 64-bit OS environment.

  • Fedora 19/20
  • RHEL 6 / 7
  • CentOS 6 / 7

Installing the Java

  • For RHEL/CentOS 6.1 (x86_64)
Download Oracle JDK 7 and install it.
  • For RHEL/CentOS 6.4 (x86_64)
Install OpenJDK 7.
yum install java-1.7.0-openjdk-devel
  • For Fedora 19/20
Install OpenJDK 7.
yum install java-1.7.0-openjdk-devel

Installing prerequisites

  • For RHEL 6
yum install perl-Digest-SHA uuid libxslt libcurl unixODBC
wget http://dl.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm
rpm -Uvh epel-release-6-8.noarch.rpm
yum install json-c

  • For CentOS6 and Fedora 20
yum install perl-Digest-SHA uuid libxslt libcurl unixODBC json-c

Installing PostgreSQL Database

1. Configure Yum repository to download the latest rpms for PostgreSQL 9.1
rpm -ivh http://yum.postgresql.org/9.1/redhat/rhel-6-x86_64/pgdg-redhat91-9.1-5.noarch.rpm
2. Install the required PostgreSQL packages
yum install postgresql91-libs postgresql91 postgresql91-server postgresql91-contrib postgresql91-odbc


1. Configure Yum repository to download the latest rpms for PostgreSQL 9.3
rpm -ivh http://yum.postgresql.org/9.3/redhat/rhel-6-x86_64/pgdg-redhat93-9.3-1.noarch.rpm
2. Install the required PostgreSQL packages
yum install postgresql93-libs postgresql93 postgresql93-server postgresql93-contrib postgresql93-odbc
  • If you are facing any problems while installing postgreSQL rpm, Please refer to openssl_problems query in troubleshooting FAQ.
  • The above procedures indicate the rpms for RHEL 6 only, please visit the http://yum.postgresql.org/ for the rpm for the other linux distros
  • VTN Coordinator support PostgreSQL version greater than 9.1 only and currently tested with 9.1 and 9.3. Please ensure the PostgreSQL version>=9.1 is installed.

Installing the VTN Coordinator

1. Enter into the externalapps directory in the top directory of Helium.
cd distribution-karaf-0.2.1-Helium-SR1/externalapps
2. Run the below command to extract VTN Coordinator from the tar.bz2 file in the externalapps directory.
tar –C/ -jxvf distribution.vtn-coordinator-
This will install VTN Coordinator to /usr/local/vtn directory.
The name of the tar.bz2 file name varies depending on the version. Please give the same tar.bz2 file name which is there in your directory.

Installing HTTPS in VTN Coordinator

1. Please go through the below link,

VTN Coordinator runs on port 8083 (TCP) for REST API by default. If you want to run it on different port other than the default, change the port number in the below file:

Configuring database for VTN Coordinator

Execute the below command.


If you received "*** ERROR: DB error occurred during DB setting.", go to https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):Installation:Troubleshooting#After_executing_db_setup.2C_you_have_encountered_the_error_.22Failed_to_setup_database.22.3F

Setting up VTN Manager

VTN Manager runs in OpenDaylight controller. In order to run VTN Manager, run the controller and install VTN Manager features.

1. Ensure Java Runtime Environment 7 is installed, else install it.
yum install java-1.7.0-openjdk
yum list *openjdk*
(then install the version available in the distro)
2. Enter into the top directory of Helium.
cd distribution-karaf-0.2.1-Helium-SR1
3. Run the below command to run the controller.
4. Once the console is up, type as below to install VTN Manager and other necessary features.
feature:install odl-vtn-manager-all odl-openflowplugin-all odl-adsal-compatibility-all
5. For logs, please look into the below file

Basic usage of VTN

Launching the VTN Coordinator



  • Get the version of VTN REST API using the below command, and make sure the setup is working.
curl --user admin:adminpass -H 'content-type: application/json' -X GET http://<VTN_COORDINATOR_IP_ADDRESS>:8083/vtn-webapi/api_version.json
The response should be like this:
  • Create and use VTN
Please refer to User Guide and Web API reference.

Terminating VTN Coordinator