Package org.onosproject.net

Interface Host

All Superinterfaces:

Annotated, Element, Projectable, Provided

All Known Subinterfaces:

HostProbe

All Known Implementing Classes:

DefaultHost

public interface Host
extends Element

Abstraction of an end-station host on the network, essentially a NIC.

Method Summary

Modifier and Type	Method	Description
Set<HostLocation>	auxLocations()	Returns host auxiliary locations, which could be useful for app operations in addition to the attach points.
default boolean	configured()	Returns true if configured by NetworkConfiguration.
HostId	id()	Host identification.
default VlanId	innerVlan()	Returns the inner VLAN ID tied to this host.
Set<IpAddress>	ipAddresses()	Returns set of IP addresses currently bound to the host MAC address.
HostLocation	location()	Returns the most recent host location where the host attaches to the network edge.
Set<HostLocation>	locations()	Returns host locations where the host attaches to the network edge.
MacAddress	mac()	Returns the host MAC address.
boolean	suspended()	Returns the state of host whether it is in suspended state(offending host due to frequent movement.).
default EthType	tpid()	Returns the TPID of the outermost VLAN associated with this host.
VlanId	vlan()	Returns the VLAN ID tied to this host.

Methods inherited from interface org.onosproject.net.Annotated

annotations

Methods inherited from interface org.onosproject.net.driver.Projectable

as, is, project

Methods inherited from interface org.onosproject.net.Provided

providerId

Method Detail

id

HostId id()

Host identification.

Specified by:

id in interface Element

Returns:

host id

mac

MacAddress mac()

Returns the host MAC address.

Returns:

mac address

vlan

VlanId vlan()

Returns the VLAN ID tied to this host.

Returns:

VLAN ID value

ipAddresses

Set<IpAddress> ipAddresses()

Returns set of IP addresses currently bound to the host MAC address.

Returns:

set of IP addresses; empty if no IP address is bound

location

HostLocation location()

Returns the most recent host location where the host attaches to the network edge.

Returns:

the most recent host location

locations

Set<HostLocation> locations()

Returns host locations where the host attaches to the network edge.

Returns:

host locations

auxLocations

Set<HostLocation> auxLocations()

Returns host auxiliary locations, which could be useful for app operations in addition to the attach points.

Returns:

auxiliary locations, or null if unspecified

configured

default boolean configured()

Returns true if configured by NetworkConfiguration.

Returns:

configured/learnt dynamically

innerVlan

default VlanId innerVlan()

Returns the inner VLAN ID tied to this host.

Returns:

VLAN ID value; VlanId.NONE if only one VLAN ID is tied to this host

tpid

default EthType tpid()

Returns the TPID of the outermost VLAN associated with this host.

Returns:

TPID of the outermost VLAN header

suspended

boolean suspended()

Returns the state of host whether it is in suspended state(offending host due to frequent movement.).

Returns:

state true if suspended else false.