org.onosproject.netconf

Interface NetconfController

public interface NetconfController

Abstraction of an NETCONF controller. Serves as a one stop shop for obtaining NetconfDevice and (un)register listeners on NETCONF device events.

Method Summary

Modifier and Type	Method and Description
void	addDeviceListener(NetconfDeviceListener listener) Adds Device Event Listener.
NetconfDevice	connectDevice(org.onosproject.net.DeviceId deviceId) Tries to connect to a specific NETCONF device, if the connection is succesful it creates and adds the device to the ONOS core as a NetconfDevice.
void	disconnectDevice(org.onosproject.net.DeviceId deviceId, boolean remove) Disconnects a Netconf device and removes it from the core.
Map<org.onosproject.net.DeviceId,NetconfDevice>	getDevicesMap() Gets all the nodes information.
NetconfDevice	getNetconfDevice(org.onosproject.net.DeviceId deviceInfo) Gets a Netconf Device by node identifier.
NetconfDevice	getNetconfDevice(org.onlab.packet.IpAddress ip, int port) Gets a Netconf Device by node identifier.
Set<org.onosproject.net.DeviceId>	getNetconfDevices() Gets all Netconf Devices.
void	removeDevice(org.onosproject.net.DeviceId deviceId) Removes a Netconf device from the core.
void	removeDeviceListener(NetconfDeviceListener listener) Removes Device Listener.

Method Detail

addDeviceListener

void addDeviceListener(NetconfDeviceListener listener)

Adds Device Event Listener.

Parameters:

listener - node listener

removeDeviceListener

void removeDeviceListener(NetconfDeviceListener listener)

Removes Device Listener.

Parameters:

listener - node listener

connectDevice

NetconfDevice connectDevice(org.onosproject.net.DeviceId deviceId)
                     throws NetconfException

Tries to connect to a specific NETCONF device, if the connection is succesful it creates and adds the device to the ONOS core as a NetconfDevice.

Parameters:

deviceId - deviceId of the device to connect

Returns:

NetconfDevice Netconf device

Throws:

NetconfException - when device is not available

disconnectDevice

void disconnectDevice(org.onosproject.net.DeviceId deviceId,
                      boolean remove)

Disconnects a Netconf device and removes it from the core.

Parameters:

deviceId - id of the device to remove

remove - true if device is to be removed from core

removeDevice

void removeDevice(org.onosproject.net.DeviceId deviceId)

Removes a Netconf device from the core.

Parameters:

deviceId - id of the device to remove

getDevicesMap

Map<org.onosproject.net.DeviceId,NetconfDevice> getDevicesMap()

Gets all the nodes information.

Returns:

map of devices

getNetconfDevices

Set<org.onosproject.net.DeviceId> getNetconfDevices()

Gets all Netconf Devices.

Returns:

List of all the NetconfDevices Ids

getNetconfDevice

NetconfDevice getNetconfDevice(org.onosproject.net.DeviceId deviceInfo)

Gets a Netconf Device by node identifier.

Parameters:

deviceInfo - node identifier

Returns:

NetconfDevice Netconf device

getNetconfDevice

NetconfDevice getNetconfDevice(org.onlab.packet.IpAddress ip,
                               int port)

Gets a Netconf Device by node identifier.

Parameters:

ip - device ip

port - device port

Returns:

NetconfDevice Netconf device