org.opendaylight.controller.hosttracker

Interface IfIptoHost

public interface IfIptoHost

This interface defines the methods to retrieve information about learned Hosts. Also provides methods to statically add/remove Hosts from the local database.

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.controller.sal.utils.Status	addStaticHost(String networkAddress, String dataLayerAddress, org.opendaylight.controller.sal.core.NodeConnector nc, String vlan) Hosts can be learned dynamically or added statically.
Future<HostNodeConnector>	discoverHost(InetAddress networkAddress) Initiates an immediate discovery of the Host for a given IP address.
Set<HostNodeConnector>	getActiveStaticHosts() Returns all the "Active Hosts" learned "Statically" via Northbound APIs.
Set<HostNodeConnector>	getAllHosts() Returns all the the Hosts either learned dynamically or added statically via Northbound APIs.
List<List<String>>	getHostNetworkHierarchy(InetAddress hostAddress) Returns the Network Hierarchy for a given Host.
Set<HostNodeConnector>	getInactiveStaticHosts() Returns all the "Inactive Hosts" learned "Statically" via Northbound APIs.
HostNodeConnector	hostFind(InetAddress networkAddress) Applications call this interface methods to determine IP address to MAC binding and its connectivity to an OpenFlow switch in term of Node, Port, and VLAN.
HostNodeConnector	hostQuery(InetAddress networkAddress) Checks the local Host Database to see if a Host has been learned for a given IP address.
org.opendaylight.controller.sal.utils.Status	removeStaticHost(String networkAddress) Allows the deletion of statically learned Host

Method Detail

hostFind

HostNodeConnector hostFind(InetAddress networkAddress)

Applications call this interface methods to determine IP address to MAC binding and its connectivity to an OpenFlow switch in term of Node, Port, and VLAN. These bindings are learned dynamically as well as can be added statically through Northbound APIs. If a binding is unknown, then an ARP request is initiated immediately to discover the host.

Parameters:

networkAddress - IP Address of the Host encapsulated in class InetAddress

Returns:

HostNodeConnector Class that contains the Host info such as its MAC address, Switch ID, port, VLAN. If Host is not found, returns NULL

hostQuery

HostNodeConnector hostQuery(InetAddress networkAddress)

Checks the local Host Database to see if a Host has been learned for a given IP address.

Parameters:

networkAddress - IP Address of the Host encapsulated in class InetAddress

Returns:

HostNodeConnector Class that contains the Host info such as its MAC address, Switch ID, port, VLAN. If Host is not found, returns NULL

discoverHost

Future<HostNodeConnector> discoverHost(InetAddress networkAddress)

Initiates an immediate discovery of the Host for a given IP address. This provides for the calling applications to block on the host discovery.

Parameters:

networkAddress - IP address encapsulated in InetAddress class

Returns:

Future org.opendaylight.controller.hosttracker.HostTrackerCallable

getHostNetworkHierarchy

List<List<String>> getHostNetworkHierarchy(InetAddress hostAddress)

Returns the Network Hierarchy for a given Host. This API is typically used by applications like Hadoop for Rack Awareness functionality.

Parameters:

IP - address of the Host encapsulated in InetAddress class

Returns:

List of String ArrayList containing the Hierarchies.

getAllHosts

Set<HostNodeConnector> getAllHosts()

Returns all the the Hosts either learned dynamically or added statically via Northbound APIs.

Returns:

Set of HostNodeConnector . Class that contains the Host info such as its MAC address, Switch ID, port, VLAN.

getActiveStaticHosts

Set<HostNodeConnector> getActiveStaticHosts()

Returns all the "Active Hosts" learned "Statically" via Northbound APIs. These Hosts are categorized as "Active" because the Switch and Port they are connected to, are in up state.

Returns:

Set of HostNodeConnector . Class that contains the Host info such as MAC address, Switch ID, port, VLAN. If Host is not found, returns NULL

getInactiveStaticHosts

Set<HostNodeConnector> getInactiveStaticHosts()

Returns all the "Inactive Hosts" learned "Statically" via Northbound APIs. These Hosts are categorized as "Inactive" because either the Switch or the Port they are connected to, is in down state.

Returns:

Set of HostNodeConnector HostNodeConnector . HostNodeConnector is Class that contains the Host info such as its MAC address, OpenFlowNode ID, port, VLAN.

addStaticHost

org.opendaylight.controller.sal.utils.Status addStaticHost(String networkAddress,
                                                         String dataLayerAddress,
                                                         org.opendaylight.controller.sal.core.NodeConnector nc,
                                                         String vlan)

Hosts can be learned dynamically or added statically. This method allows the addition of a Host to the local database statically.

Parameters:

networkAddress - IP Address of the Host

dataLayerAddress - MAC Address of the Host

nc - NodeConnector to which the host is attached

vlan - VLAN the host belongs to

Returns:

The status object as described in Status indicating the result of this action.

removeStaticHost

org.opendaylight.controller.sal.utils.Status removeStaticHost(String networkAddress)

Allows the deletion of statically learned Host

Parameters:

networkAddress -

Returns:

The status object as described in Status indicating the result of this action.