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 java.util.Set<HostLocation>auxLocations()Returns host auxiliary locations, which could be useful for app operations in addition to the attach points.default booleanconfigured()Returns true if configured by NetworkConfiguration.org.onlab.packet.MacAddresshwAddress()Returns the MAC address associated with this host (NIC).default org.onlab.packet.VlanIdinnerVlan()Returns the inner VLAN associated with this host.java.util.Set<org.onlab.packet.IpAddress>ipAddress()Returns the IP address associated with this host's MAC.HostLocationlocation()Returns the most recent location of the host on the network edge.java.util.Set<HostLocation>locations()Returns all locations of the host on the network edge.default org.onlab.packet.EthTypetpid()Returns the TPID of the outermost VLAN associated with this host.org.onlab.packet.VlanIdvlan()Returns the VLAN associated with this host.-
Methods inherited from interface org.onosproject.net.Description
annotations
-
-
-
-
Method Detail
-
hwAddress
org.onlab.packet.MacAddress hwAddress()
Returns the MAC address associated with this host (NIC).- Returns:
- the MAC address of this host
-
vlan
org.onlab.packet.VlanId vlan()
Returns the VLAN associated with this host.- Returns:
- the VLAN ID value
-
innerVlan
default org.onlab.packet.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 org.onlab.packet.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
java.util.Set<HostLocation> locations()
Returns all locations of the host on the network edge.- Returns:
- all host locations
-
auxLocations
java.util.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
java.util.Set<org.onlab.packet.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
-
-