This is the documentation for the development version. There are no official binaries for it; build it from the source code in git. Download links on these pages work only after the release. For the current release, see version 7.0.

DHCPLease

Represents a DHCP lease or reservation on a DHCP server. Objects of this class are read-only and are returned by the getDHCPLeases() method of the Node class.

Instance attributes

clientId: String

DHCPv4 client identifier or DHCPv6 DUID.

expiration: int64

UNIX timestamp of lease expiration, or 0 if the lease does not expire or its expiration time is unknown.

hostname: String

Client host name.

ipAddress ⇒ InetAddress

Leased IP address. For IPv6 prefix delegation, mask bits are set to the delegated prefix length.

lastTransaction: int64

UNIX timestamp of the last transaction with the client, or 0 if unknown.

macAddress ⇒ MacAddress

Client MAC address, or null if not known.

scopeId: String

ID of the scope this lease belongs to (matches the id attribute of DHCPScope).

state: int

Lease state, one of the DHCPLeaseState constants.

type: int

Lease type, one of the DHCPLeaseType constants.