org.onosproject.ovsdb.controller

Interface OvsdbClientService

All Superinterfaces:

OvsdbRpc

All Known Implementing Classes:

DefaultOvsdbClient

public interface OvsdbClientService
extends OvsdbRpc

Represents to provider facing side of a node.

Method Summary

Modifier and Type	Method and Description
boolean	createBridge(OvsdbBridge ovsdbBridge) Creates a bridge with a given bridge description.
void	createBridge(String bridgeName) Deprecated. version 1.7.0 - Hummingbird
boolean	createBridge(String bridgeName, String dpid, List<org.onosproject.net.behaviour.ControllerInfo> controllers) Deprecated. version 1.7.0 - Hummingbird
void	createBridge(String bridgeName, String dpid, String exPortName) Deprecated. version 1.7.0 - Hummingbird
boolean	createInterface(String bridgeName, OvsdbInterface ovsdbIface) Creates an interface with a given OVSDB interface description.
boolean	createMirror(String bridgeName, OvsdbMirror mirror) Creates a mirror port.
void	createPort(String bridgeName, String portName) Creates a port.
boolean	createTunnel(String bridgeName, String portName, String tunnelType, Map<String,String> options) Deprecated. version 1.7.0 - Hummingbird
void	disconnect() Disconnects the OVSDB server.
void	dropBridge(String bridgeName) Drops a bridge.
boolean	dropInterface(String ifaceName) Removes an interface with the supplied interface name.
void	dropMirror(org.onosproject.net.behaviour.MirroringName mirroringName) Drops the configuration for mirror.
void	dropPort(String bridgeName, String portName) Drops a port.
void	dropTunnel(org.onlab.packet.IpAddress srcIp, org.onlab.packet.IpAddress dstIp) Deprecated. version 1.7.0 - Hummingbird
Set<OvsdbBridge>	getBridges() Gets bridges of node.
String	getBridgeUuid(String bridgeName) Gets the Bridge uuid.
Set<org.onosproject.net.behaviour.ControllerInfo>	getControllers(org.onosproject.net.DeviceId openflowDeviceId) Gets controllers of node.
DatabaseSchema	getDatabaseSchema(String dbName) Gets the OVSDB database schema from local.
Set<OvsdbPort>	getLocalPorts(Iterable<String> ifaceids) Gets OVSDB local ports.
Set<org.onosproject.net.behaviour.MirroringStatistics>	getMirroringStatistics(org.onosproject.net.DeviceId deviceId) Gets mirroring statistics of the device.
String	getMirrorUuid(String mirrorName) Gets the Mirror uuid.
com.google.common.util.concurrent.ListenableFuture<DatabaseSchema>	getOvsdbSchema(String dbName) Gets the OVSDB database schema.
Set<OvsdbPort>	getPorts() Gets ports of bridge.
String	getPortUuid(String portName, String bridgeUuid) Gets the Port uuid.
Row	getRow(String dbName, String tableName, String uuid) Gets the OVSDB row from local OVSDB store.
boolean	isConnected() Checks if the node is still connected.
org.onosproject.net.behaviour.ControllerInfo	localController() Returns local controller information.
com.google.common.util.concurrent.ListenableFuture<TableUpdates>	monitorTables(String dbName, String id) Gets the OVSDB table updates.
OvsdbNodeId	nodeId() Gets the node identifier.
void	removeRow(String dbName, String tableName, String uuid) Removes the OVSDB row from local OVSDB store.
void	setControllersWithDeviceId(org.onosproject.net.DeviceId deviceId, List<org.onosproject.net.behaviour.ControllerInfo> controllers) Sets the Controllers for the specified device.
void	updateOvsdbStore(String dbName, String tableName, String uuid, Row row) Updates the local OVSDB store.

Methods inherited from interface org.onosproject.ovsdb.rfc.jsonrpc.OvsdbRpc

echo, getSchema, listDbs, monitor, transact

Method Detail

nodeId

OvsdbNodeId nodeId()

Gets the node identifier.

Returns:

node identifier

createMirror

boolean createMirror(String bridgeName,
                     OvsdbMirror mirror)

Creates a mirror port. Mirrors the traffic that goes to selectDstPort or comes from selectSrcPort or packets containing selectVlan to mirrorPort or to all ports that trunk mirrorVlan.

Parameters:

bridgeName - the name of the bridge

mirror - the OVSDB mirror description

Returns:

true if mirror creation is successful, false otherwise

getMirrorUuid

String getMirrorUuid(String mirrorName)

Gets the Mirror uuid.

Parameters:

mirrorName - mirror name

Returns:

mirror uuid, empty if no uuid is found

getMirroringStatistics

Set<org.onosproject.net.behaviour.MirroringStatistics> getMirroringStatistics(org.onosproject.net.DeviceId deviceId)

Gets mirroring statistics of the device.

Parameters:

deviceId - target device id

Returns:

set of mirroring statistics; empty if no mirror is found

dropMirror

void dropMirror(org.onosproject.net.behaviour.MirroringName mirroringName)

Drops the configuration for mirror.

Parameters:

mirroringName - name of mirror to drop

createTunnel

@Deprecated
boolean createTunnel(String bridgeName,
                                 String portName,
                                 String tunnelType,
                                 Map<String,String> options)

Deprecated. version 1.7.0 - Hummingbird

Creates a tunnel port with given options.

Parameters:

bridgeName - bridge name

portName - port name

tunnelType - tunnel type

options - tunnel options

Returns:

true if tunnel creation is successful, false otherwise

dropTunnel

@Deprecated
void dropTunnel(org.onlab.packet.IpAddress srcIp,
                            org.onlab.packet.IpAddress dstIp)

Deprecated. version 1.7.0 - Hummingbird

Drops the configuration for tunnel.

Parameters:

srcIp - source IP address

dstIp - destination IP address

createInterface

boolean createInterface(String bridgeName,
                        OvsdbInterface ovsdbIface)

Creates an interface with a given OVSDB interface description.

Parameters:

bridgeName - bridge name

ovsdbIface - ovsdb interface description

Returns:

true if interface creation is successful, false otherwise

dropInterface

boolean dropInterface(String ifaceName)

Removes an interface with the supplied interface name.

Parameters:

ifaceName - interface name

Returns:

true if interface creation is successful, false otherwise

createBridge

@Deprecated
void createBridge(String bridgeName)

Deprecated. version 1.7.0 - Hummingbird

Creates a bridge.

Parameters:

bridgeName - bridge name

createBridge

@Deprecated
void createBridge(String bridgeName,
                              String dpid,
                              String exPortName)

Deprecated. version 1.7.0 - Hummingbird

Creates a bridge.

Parameters:

bridgeName - bridge name

dpid - data path id

exPortName - external port name

createBridge

@Deprecated
boolean createBridge(String bridgeName,
                                 String dpid,
                                 List<org.onosproject.net.behaviour.ControllerInfo> controllers)

Deprecated. version 1.7.0 - Hummingbird

Creates a bridge with given name and dpid. Sets the bridge's controller with given controllers.

Parameters:

bridgeName - bridge name

dpid - data path id

controllers - controllers

Returns:

true if bridge creation is successful, false otherwise

createBridge

boolean createBridge(OvsdbBridge ovsdbBridge)

Creates a bridge with a given bridge description.

Parameters:

ovsdbBridge - ovsdb bridge description

Returns:

true if bridge creation is successful, otherwise false

dropBridge

void dropBridge(String bridgeName)

Drops a bridge.

Parameters:

bridgeName - bridge name

getBridges

Set<OvsdbBridge> getBridges()

Gets bridges of node.

Returns:

set of bridges; empty if no bridge is find

getControllers

Set<org.onosproject.net.behaviour.ControllerInfo> getControllers(org.onosproject.net.DeviceId openflowDeviceId)

Gets controllers of node.

Parameters:

openflowDeviceId - target device id

Returns:

set of controllers; empty if no controller is find

localController

org.onosproject.net.behaviour.ControllerInfo localController()

Returns local controller information. The connection is a TCP connection to the local ONOS instance's IP and the default OpenFlow port.

Returns:

local controller

setControllersWithDeviceId

void setControllersWithDeviceId(org.onosproject.net.DeviceId deviceId,
                                List<org.onosproject.net.behaviour.ControllerInfo> controllers)

Sets the Controllers for the specified device.

This method will replace the existing controller list with the new controller list.

Parameters:

deviceId - device id (likely Openflow device)

controllers - list of controllers

createPort

void createPort(String bridgeName,
                String portName)

Creates a port.

Parameters:

bridgeName - bridge name

portName - port name

dropPort

void dropPort(String bridgeName,
              String portName)

Drops a port.

Parameters:

bridgeName - bridge name

portName - port name

getPorts

Set<OvsdbPort> getPorts()

Gets ports of bridge.

Returns:

set of ports; empty if no ports is find

isConnected

boolean isConnected()

Checks if the node is still connected.

Returns:

true if the node is still connected

getBridgeUuid

String getBridgeUuid(String bridgeName)

Gets the Bridge uuid.

Parameters:

bridgeName - bridge name

Returns:

bridge uuid, empty if no uuid is find

getPortUuid

String getPortUuid(String portName,
                   String bridgeUuid)

Gets the Port uuid.

Parameters:

portName - port name

bridgeUuid - bridge uuid

Returns:

port uuid, empty if no uuid is find

getOvsdbSchema

com.google.common.util.concurrent.ListenableFuture<DatabaseSchema> getOvsdbSchema(String dbName)

Gets the OVSDB database schema.

Parameters:

dbName - database name

Returns:

database schema

monitorTables

com.google.common.util.concurrent.ListenableFuture<TableUpdates> monitorTables(String dbName,
                                                                               String id)

Gets the OVSDB table updates.

Parameters:

dbName - database name

id - random uuid

Returns:

table updates

getDatabaseSchema

DatabaseSchema getDatabaseSchema(String dbName)

Gets the OVSDB database schema from local.

Parameters:

dbName - database name

Returns:

database schema

getRow

Row getRow(String dbName,
           String tableName,
           String uuid)

Gets the OVSDB row from local OVSDB store.

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

Returns:

row OVSDB row

removeRow

void removeRow(String dbName,
               String tableName,
               String uuid)

Removes the OVSDB row from local OVSDB store.

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

updateOvsdbStore

void updateOvsdbStore(String dbName,
                      String tableName,
                      String uuid,
                      Row row)

Updates the local OVSDB store.

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

row - OVSDB row

getLocalPorts

Set<OvsdbPort> getLocalPorts(Iterable<String> ifaceids)

Gets OVSDB local ports.

Parameters:

ifaceids - the ifaceid that needed

Returns:

OVSDB ports

disconnect

void disconnect()

Disconnects the OVSDB server.