Page History

...

SnmpController.java, implemented by DefaultSnmpControllerImpl.java: tracks all the SNMP devices in this instance of ONOS, serves as a one stop for connecting and obtaining a device and it's session.
SnmpDevice.java implemented by DefaultSnmpDevice.java: represents a REST SNMP capable device known to the ONOS core with all the information needed such as Ip, porthost, nameusername, password,protocolcommunity, deviceId.
RestDeviceSnmpDeviceProvider.java: manages any REST SNMP device role and all the interactions with the ONOS core, such as provisioning the ports and the initial device setup. Has his own internalConfigListener from which it gets notified when a configuration is pushed to ONOS via restAPI. When a configuration is pushed and it's relevant to the Snmp device provider, this automatically triggers the connection with the specified devices. The device is added to ONOS if replies on the ip and port that the configuration provides.

Notify ONOS of your

...

SNMP device

This section specifies how to notify the ONOS core of a device that support REST operations for configuration.

Once you have your device Running on some IP address and some port, in order to make ONOS see it you should follow these steps.

start ONOS

activate the REST SNMP southbound app :

Code Block
onos> app activate org.onosproject.restsbsnmp

activate the REST SNMP drivers for your device (i.e. ciena lumentum drivers) :
Code Block
onos> app activate org.onosproject.drivers.cienalumentum
Pay attention: if your drivers already depend upon the snmp app only the second step is needed.

give ONOS the information regarding the device and which driver to use for you your 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 "rest" one.

Code Block

{
  "devices": {
    "restsnmp:<username>@<ip><ip>:<port>": {
      "basicsnmp": {
        "driverip":"rest"
      } <ip>,
    }
  },
  "appsport":{ <port>,
    "org.onosproject.restsb":{
      "devicesusername":[{ <username>,
        "namepassword":<username>, <password>
        "password":<password>},
        "ipbasic":<ip>, {
        "portdriver":<port> <driver-name>
      }]
    }
  }
}

A working example is in $ONOS_ROOT/tools/test/configs/restSB-cfg.json. Change the IP both in the DeviceId at the top and in the devices array. This example expects that your are running a REST server locally (127.0.0.1) on port 8080.
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=restsnmp:127.0.0.1:80801, available=true, role=MASTER, type=SWITCH, mfr=unknown, hw=unknown, sw=unknown, serial=unknown, ipaddress=127.0.0.1, driver=restCienalumentum, name=rest:127.0.0.1:80801

If the device is not present the could have been and error one or multiple errors 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 REST related exceptions and this error does not appear:

Code Block

2016-01-19 15:19:28,102 | ERROR | event-dispatch-0 | RestDeviceProvider | 192 - org.onosproject.onos-restsb-provider-device - 1.5.0.SNAPSHOT | Device <device> not reachable, error creating HTTP connection
java.net.ConnectException: Connection refused

In case the log is preset it means SNMP related exceptions. In case error are present in the logs it could mean 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.

If your driver specifies a PortDiscovery implementation, such as PortDiscoveryCienaWaveserverImpl LumentumRoadmDeviceDescription.java the Rest Snmp southbound provider also queries the description you provide and the ports that are available on that device and updates the information in the ONOS core.

So if your run in ONOS the command:

Code Block
onos> ports

should return, among other devices also something like:

Code Block

onos> id=restsnmp:127.0.0.1:80801, available=true, role=MASTER, type=SWITCH, mfr=unknown, hw=unknown, sw=unknown, serial=unknown, ipaddress=127.0.0.1, driver=restCienalumentum, name=restsnmp:127.0.0.1:80801
  port=4, state=enabled, type=och, signalType=ODU4, isTunable=yes , name=1.1
  port=5, state=enabled, type=och, signalType=ODU4, isTunable=yes , name=1.2
  port=20, state=enabled, type=oduclt, signalType=CLT_100GBE , name=5
  port=24, state=enabled, type=oduclt, signalType=CLT_100GBE , name=6
  port=28, state=enabled, type=oduclt, signalType=CLT_100GBE , name=7
  port=32, state=enabled, type=oduclt, signalType=CLT_100GBE , name=8
  port=48, state=enabled, type=och, signalType=ODU4, isTunable=yes , name=12.1
  port=49, state=enabled, type=och, signalType=ODU4, isTunable=yes , name=12.2

Once the device is present in ONOS you can interact with it via the driver/provider subsystem.

Future Work

...

.

Page tree

Versions Compared

Old Version 6

New Version Current

Key

Notify ONOS of your

SNMP device

Future Work