Package org.netxms.client.dhcp

Class DhcpLease

java.lang.Object
org.netxms.client.dhcp.DhcpLease
public class DhcpLease extends Object
DHCP lease (or reservation) on DHCP server

  • Constructor Details

    • DhcpLease

      public DhcpLease(NXCPMessage msg, long baseId)
      Create lease object from NXCP message.
      Parameters:
      msg - NXCP message
      baseId - base field ID

  • Method Details

    • getIpAddress

      public InetAddressEx getIpAddress()
      Get leased IP address. For IPv6 prefix delegation mask is set to delegated prefix length.
      Returns:
      leased IP address

    • isPrefixDelegation

      public boolean isPrefixDelegation()
      Check if this lease is IPv6 prefix delegation.
      Returns:
      true if this lease is IPv6 prefix delegation

    • getScopeId

      public String getScopeId()
      Get ID of scope this lease belongs to.
      Returns:
      scope ID (empty string if unknown)

    • getMacAddress

      public MacAddress getMacAddress()
      Get client MAC address.
      Returns:
      client MAC address (may be null or empty)

    • getClientId

      public String getClientId()
      Get DHCPv4 client identifier or DHCPv6 DUID.
      Returns:
      client identifier

    • getHostname

      public String getHostname()
      Get client host name.
      Returns:
      client host name

    • getType

      public DhcpLeaseType getType()
      Get lease type.
      Returns:
      lease type

    • getState

      public DhcpLeaseState getState()
      Get lease state.
      Returns:
      lease state

    • getLastTransaction

      public Date getLastTransaction()
      Get time of last transaction with client.
      Returns:
      time of last transaction or null if unknown

    • getExpiration

      public Date getExpiration()
      Get lease expiration time.
      Returns:
      lease expiration time or null if lease does not expire or expiration time is unknown

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: