Package org.onosproject.net.host
Interface HostDescription
-
- All Superinterfaces:
Annotated
,Description
- All Known Implementing Classes:
DefaultHostDescription
public interface HostDescription extends Description
Information describing host and its location.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods 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.MacAddress
hwAddress()
Returns the MAC address associated with this host (NIC).default VlanId
innerVlan()
Returns the inner VLAN associated with this host.Set<IpAddress>
ipAddress()
Returns the IP address associated with this host's MAC.HostLocation
location()
Returns the most recent location of the host on the network edge.Set<HostLocation>
locations()
Returns all locations of the host on the network edge.default EthType
tpid()
Returns the TPID of the outermost VLAN associated with this host.VlanId
vlan()
Returns the VLAN associated with this host.-
Methods inherited from interface org.onosproject.net.Description
annotations
-
-
-
-
Method Detail
-
hwAddress
MacAddress hwAddress()
Returns the MAC address associated with this host (NIC).- Returns:
- the MAC address of this host
-
vlan
VlanId vlan()
Returns the VLAN associated with this host.- Returns:
- the VLAN ID value
-
innerVlan
default VlanId innerVlan()
Returns the inner VLAN associated with this host.- Returns:
- VLAN ID value; VlanId.NONE if only one VLAN ID is associated with this host
-
tpid
default EthType tpid()
Returns the TPID of the outermost VLAN associated with this host.- Returns:
- TPID of the outermost VLAN header
-
location
HostLocation location()
Returns the most recent location of the host on the network edge.- Returns:
- the most recent host location
-
locations
Set<HostLocation> locations()
Returns all locations of the host on the network edge.- Returns:
- all 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
-
ipAddress
Set<IpAddress> ipAddress()
Returns the IP address associated with this host's MAC.- Returns:
- host IP address
-
configured
default boolean configured()
Returns true if configured by NetworkConfiguration.- Returns:
- configured/learnt dynamically
-
-