Page History

...

• NetconfController.java, implemented by NetconfControllerImpl.java: tracks all the NETCONF devices, serves as a one stop for connecting and obtaining a device and (un)register listeners on device events.

• NetconfDevice.java implemented by NetconfDeviceImpl.java: represents a NETCONF capable device connected to the ONOS core with his own NetconfSession and his informations saved in an instance of NetconfDeviceInfo
• NetconfSession.java: interface that every type of transport connection to a NETCONF device must implement, represents the single access point for any operation on the device. An example is NetconfSessionImpl: uses an SSH2 Connection and Session to exchange information and perform operations like get/set-config with the physical NETCONF device.
• NetconfSessionDelegate.java delegate interface implemented by NetconfSessionDelegateImpl in NetconfSessionImpl. Serves the purpose of completing the future returned by the thread so the session can return the correct reply for the specifi request to the caller, effectively making the request call blocking on the Future.
• NetconfDeviceProvider.java: manages any NETCONF device role and all the interactions with the ONOS core.
• NetconfDeviceListener.java implemented by InnerNetconfDeviceListener.java in NetconfDeviceProvider: informs the provider in the ONOS core that a NETCONF device is connected/disconnected.
• NetconfDeviceOutputEvent.java represent an output event from a device session's stream, it can be a reply, notification, unregistration from the network, error.
• NetconfDeviceOutputEventListener.java implemented by NetconfDeviceOutputEventListenerImpl.java: interface and implementation of a listener that receives notifications from the device stream: replies, notifications, disconnections and errors. NetconfSession has method to set them to the underling stream handler class, such as NetconfStreamThread.
• NetconfDeviceInfo.java: contains ip,port,protocol,username,password and DeviceId of a NETCONF device; it's used to exchange information about a device without having to pass the device instance itself.
• NetconfException.java represents an exception happened in the NETCONF protocol implementation.
• XMLConfigParser.java: parser for reading and producing XML files to and from the NETCONF device. For now has only configuration reader and edit controllers configuration producer.

Though implementing the NetconfDeviceOutputEventListener.java and adding the listener to the session anybody who needs to obtain device notifications can listen on device generated messages that are picked up by the listeners implementations that is in the set of to be notified listeners in the StreamHandler implementation, right now NetconfStreamThread.java.

Connect your own device to ONOS

...

• start ONOS

• activate the netconf app :

  Code Block
  onos> app activate org.onosproject.netconf

• give ONOS the information to connect to the device and which driver to use for you device in a json file. You need to specify username, password, ip and port. If you wrote a specific driver that has also to be changed form the standard "netconf" one.

  Code Block
  { "devices":{ "netconf:<username>@<ip>:<port>":{ "basic":{ "driver":"ovs-netconf" } } }, "apps":{ "org.onosproject.netconf":{ "devices":[{ "name":<username>, "password":<password>, "ip":<ip>, "port":<port> }] } } }

  A working example is in $ONOS_ROOT/tools/test/configs/netconf-cfg.json. Change the IP both in the DeviceId at the top and in the devices array. The port number by default on NETCONF is 830, so unless you made any changes to that leave it as is.
  You can also add other information, more than the driver, to the basic device configuration information: "type": "<device-type>", "manufacturer": "<device-manufacturer>","hwVersion": "<hw-version>","swVersion": "<sw-version>".

   

• upload the configuration you just wrote to the instance of ONOS you are running, in our case localhost:

  Code Block
  <your_machine>~$ curl -X POST -H "content-type:application/json" http://localhost:8181/onos/v1/network/configuration -d @<path_to_your_json_configuration_file> --user onos:rocks

  or 

  Code Block
  <your_machine>~$ onos-netcfg localhost <path_to_your_json_configuration_file>

• Check if the device is present in ONOS:

  Code Block
  onos> devices

  should return, among other devices also something like:

  Code Block
  onos> id=netconf:mininet@10.1.9.24:1830, available=true, role=MASTER, type=SWITCH, mfr=unknown, hw=unknown, sw=unknown, serial=unknown, ipaddress=10.1.9.24, driver=ovs-netconf, name=netconf:mininet@10.1.9.24:1830

  If the device is not present the could have been and error and you have to check the logs.

  • for localhost logs

    Code Block
    <your_machine>~$ tl

    or for remote logs

    Code Block
    <your_machine>~$ ol

  • verify that the logs don't contain NETCONF related exceptions and this warning does not appear:

    Code Block
    | WARNINFO | event-dispatch-0 | NetconfDeviceProvider | 186 - org.onosproject.onos-netconf-provider-device - 1.4.0.SNAPSHOT | Can't connect to NETCONF device on <ip>:<port>

    In case the log is preset it means that the device was not able to reply on the given IP and Port. Verify Ip and Port in the Json file you posted and retry. If any other exception is present, such as no device name, please read the log and react to it accordingly.

• Once the device is present in ONOS you can interact with it.

...