Create Vim Driver

This tutorial will give This project plugin-sdk contains modules that are needed to implement a plugin for OpenBaton system.

How does this work?

OpenBaton use the Remote Procedure Call (RPC) mechanism for implementing the Plugins. It offers an implementation of an interface that is used by the NFVO.


Before you can start with developing your own Vim Driver you need to prepare your programming environment by installing/configuring the following requirements:

Create a new project

Once you have started the IDE, click on File -> New -> Project...

In this dialog click on Gradle on the left and select java in the main properties window in the middle.


Then click on next to go to the next window.

In the next dialog you need to define the GroupId, ArtifactId and the Version. More information on the specific meaning can be found here.


Continue with the next dialog.

In this dialog you need to specify which gradle you want to use. It is recommend to use the default gradle wrapper. Additionally you can enable the auto-import.


Continue with the next dialog by clicking on Next.

In the last dialog, you need to define the project name and the project location.


Once this is done you can click on Finish and continue with creating the Main Class.

Create the Main Class

Afterwards, you need to create the Main Class of the VIM driver which will be started in the end. For doing so, right click on the root folder my-vim, then click on New -> Directory and insert what is show below.


Click on OK to continue.

Additionally you need to create a new package. This is done by a right-click on the previously created directory java. Click on New -> Package. Here you can define the package name.


Finally you can create your MyVim Class by clicking (right click) on the previously created package and click on New -> Java Class.


Once you did all these steps, the initial project structure is created. What we miss right now is the configuration of the gradle files to define and fetch dependencies we need for implementing the Vim driver. This is described in later sections.

In order to create a VIM driver for OpenBaton system you need to add to your build.gradle file:

group 'org.myplugin.example'
version '1.0-SNAPSHOT'

buildscript {
    repositories {
    dependencies {

repositories {
     * Only needed for openbaton snapshots dependencies
    maven {
        url ''

apply plugin: 'java'
apply plugin: 'maven'
apply plugin: 'spring-boot'

mainClassName = 'org.myplugin.example.Starter'

dependencies {
    compile 'org.openbaton:plugin-sdk:3.2.0'

Write your Vim driver

The Vim driver is a simple class extending one abstract class and using a Starter utility

Type of Vim Instance

OpenBaton provides a specific class for handling the openstack type or the test type thus these two types are supported. For all the other types a generic class will handle the communication between the NFVO and your plugin.

Implement VimDriver

The VimDriver is an abastract class that contains tha basic functionalities that a Vim Instance has to provide.

NOTE: If you want to implement a Monitoring plugin, then you need to implement the Abstract Class MonitoringPlugin

Your MyVim class will implement the methods inherited from VimDriver that manages your Vim Instance:

Function Description
List\<NFVImage> listImages Returns the list of Images
List\<Server> listServer Returns the list of Servers
List\<Network> listNetworks Returns the list of Network
List\<DeploymentFlavour> listFlavors Returns the list of DeploymentFlavour
Server launchInstanceAndWait Creates a new Server
void deleteServerByIdAndWait Removes the Server with id
Network createNetwork Creates a new Network
Network getNetworkById Returns the Network with id
Network updateNetwork Updates a new Network
boolean deleteNetwork Deletes the Network
Subnet createSubnet Creates a new Subnet
Subnet updateSubnet Updates the Subnet
boolean deleteSubnet Deletes the Subnet
List\<String> getSubnetsExtIds Returns the list of SubnetsExtId
DeploymentFlavour addFlavor Adds a new DeploymentFlavour
DeploymentFlavour updateFlavor Updates the DeploymentFlavour
boolean deleteFlavor Deletes the DeploymentFlavour
NFVImage addImage Adds a new NFVImage
NFVImage updateImage Updates the NFVImage
NFVImage copyImage Copies the NFVImage
boolean deleteImage Deletes the NFVImage
Quota getQuota Returns the Quota
String getType Returns the type

An example of the class:

package org.myplugin.example;

import org.openbaton.catalogue.mano.common.DeploymentFlavour;
import org.openbaton.catalogue.nfvo.*;
import org.openbaton.exceptions.VimDriverException;
import org.openbaton.vim.drivers.interfaces.VimDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Scope;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;

public class MyVim extends VimDriver{

    private Logger log = LoggerFactory.getLogger(this.getClass());

    public Server launchInstance(VimInstance vimInstance, String name, String image, String flavor, String keypair, Set<String> network, Set<String> secGroup, String userData) throws RemoteException {
        // ...

    public String getType(VimInstance vimInstance) {
        // ...

    public List<NFVImage> listImages(VimInstance vimInstance) {
        // ...

    public static void main(String[] args) {
        PluginStarter.registerPlugin(MyVim.class, "my-type", "broker-ip", 5672, 10);

As you can notice, there is the need of a main method to start multiple instances of the plugin (in this example are 10, the last parameter).

Run your Vim driver in OpenBaton environment

Under the folder of your project src/main/resources you should create a file and write the variable type = the-vim-type.

The structure of your project should be like:

Vim driver structure

Now you can run ./gradlew build and Gradle will create the jar that you can find in the folder build/libs/myPlugin-1.0-SNAPSHOT.jar.

Once all these steps are done, you can copy and paste the myPlugin-1.0-SNAPSHOT.jar under the folder specified in the (under /etc/openbaton folder) plugin-installation-dir property, as default path_to_NFVO/plugins. The plugin sends the log messages to NFVO, the NFVO writes them into a log file. The path to this file can be set with nfvo.plugin.log.path properties in the /etc/openbaton/ Congratulations you have your version of the interface for your Vim Instance that will be used by NFVO

Use my plugin

Once you copied the jar file into the right folder, either you need to (re)start the NFVO or you type installPlugin in the NFVO console passing the needed arguments. In case you restart the NFVO, the plugin will automatically register and you can see that there will be a log file in the NFVO folder called plugin-myPlugin.log containing the logs of the plugin. The myPlugin now acts as a normal plugin so for using it check out the Vim instance documentation in order to point out to the new plugin.

NOTE: you can also launch your plugin from your command line just typing

$ java -jar myPlugin-1.0-SNAPSHOT.jar