Package org.onosproject.net

Interface Host

    • 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.
      HostId id()
      Host identification.
      default org.onlab.packet.VlanId innerVlan()
      Returns the inner VLAN ID tied to this host.
      Set<org.onlab.packet.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.
      org.onlab.packet.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 org.onlab.packet.EthType tpid()
      Returns the TPID of the outermost VLAN associated with this host.
      org.onlab.packet.VlanId vlan()
      Returns the VLAN ID tied to this host.

    • Method Detail

      • id

        HostId id()
        Host identification.
        Specified by:
        id in interface Element
        Returns:
        host id

      • mac

        org.onlab.packet.MacAddress mac()
        Returns the host MAC address.
        Returns:
        mac address

      • vlan

        org.onlab.packet.VlanId vlan()
        Returns the VLAN ID tied to this host.
        Returns:
        VLAN ID value

      • ipAddresses

        Set<org.onlab.packet.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 org.onlab.packet.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 org.onlab.packet.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.