The Opendaylight-0.12.2 user guide can be found here:

Before installing OpenDaylight, install required JAVA modules. OpenDaylight Magnesium requires a Java 11 environment. Any version other than Magnesium can work under Java 8 environment.

OpenDaylight can be downloaded from the link below.

Unzip the tar.gz file with this command:

To start OpenDaylight, navigate to the OpenDaylight folder and run following command.

Below mentioned features are needed to be installed in the karaf shell of OpenDaylight.

To establish a connection between OpenDaylight and an OcNOS VM, below attached file will be used. Make sure to update host IP address and credentials in ocnos_connect.xml file depending on the NETCONF device.

Node-id for the connection can be of the user choice.

Use the following command to make connection. Make sure about the update of data in the ocnos_connect.xml file. “ocnos-3” in URL is node-id.

After execution of the above command, check the connection status with the following command.

The URL from the command can be used in a browser to access as well. ("username:password" = "admin:admin" if asked for sign-in when accessing URL.)

Results of above command:

If the status shows 'connecting', it indicates capability exchange is still ongoing and it will soon move to 'connected'.

There are 2 different endpoints related to RestConf protocols:

Make sure to install all necessary features. If the odl-restconf feature is already installed, it provides both end points together.

RFC 8040 can be installed independently:

In the case of RFC 8040, resources for configuration and operational datastores start /rests/data/.

For example:

Also in the case of RFC 8040, if a data node in the path expression is a YANG leaf-list or list node, the path segment has to be constructed by having leaf-list or list node name, followed by an “=” character, then followed by the leaf-list or list value. Any reserved characters must be percent-encoded.

For example:

Retrieves data from configuration datastore for topology-netconf value of topology list is equivalent to the deprecated request.

A patch request can be used to modify an existing configuration. Currently, only yang-patch (RFC 8072) is supported. The URL would be the same as the above PUT examples.

Using JSON for the body, the headers needed for the request would be:

(Change the header-type for XML accordingly.)

JSON payload:

XML payload:

This example shows a patch operation to edit ip-address for interface using ODL:

JSON payload:

XML payload:

Header for the action:

Postman app can be found under applications->Development->postman

For more details for downloading and installing POSTMAN desktop version:

https://gist.github.com/invinciblycool/ecc1c6e32b581b68932ac7452f4c911c

The POSTMAN desktop version should be running in the system while the web version is accessed at this link:

In the configuration of OpenDaylight in the POSTMAN tool, authentication should be set to basic authentication with username and password as 'admin' (as shown in the snippet above).

All the RESTCONF operations can be performed using POSTMAN tool.

Configuration using POSTMAN is shown later in the section "edit-config".

Under the mounted resources of API-DOCS, all the APIs show the possible RESTCON operations which can be performed on the node. In the snippet below, different RESTCONF operations are displayed under ipi-interface API.

The interface_config.xml file contents are:

Similar to edit-config in NetConf, RESTCONF PUT method is sent by the client to create or replace the target data resource. RESTCONF PUT operation is shown in below attached snippet. Authentication should be selected as 'basic authentication' as shown before.

In the snippet above, the URL of interface eth1 of node-is = ocnos-3 is set to receive configuration file.

The body of the request contains the configuration data. POSTMAN supports different formats for data configuration as well.

As shown in the snippet above, after sending this request for the configuration, it returns a "201 created" http response. This means that target datastore has created the data resource as per the request.

ODL API-Doc requires additional patch to enable mounted resources. This is a known issue in ODL. To apply the patch/solution for ODL,

Replace yang-model-util-4.0.13.jar residing at:

with the provided JAR file.

OpenDaylight shows certain parsing issues with IP Infusion Inc. generated yang modules. This in turn affects OpenDaylight functions. It can be avoided by changing certain .JAR files in ODL system.

If you have revised JAR file, these revised .JAR files will replace OpenDaylight source JAR files.

To enable the change of the PATCH, OpenDaylight features are needed to be installed again. That can be achieved by:

After connecting with netconf device, it advertises all its yang capabilities in its hello message with ODL.

If OpenDaylight shows unavailable capabilities, please try to delete all yang files residing at:

and attempt to re-connect with netconf-device.

If the JAVA_HOME not set error appears when executing the $./bin/karaf command, it can be solved by setting JAVA_HOME to the directory of the local JDK.

To perform that operation, you need to provide local directory address to JAVA_HOME.

To check where the Java binary resides:

There is only one alternative in link group java (providing /usr/bin/java):

Nothing to configure.

In our case, the binary for Java 8 resides at:

With the path known, apply this command to update BASHRC file:

(Make sure that JAVA_HOME ends with /jre.)

OcNOS devices with different product versions (such as SP, DC, or RON) cannot be connected simultaneously with the same ODL host machine.

To connect a device with a different OcNOS product version (when it was previously connected with another version), you need to clean the ODL schema cache.

OcNOS devices with different release versions of the same product can connect simultaneously to the same ODL host machine.