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.

DHCPScope

Represents a DHCP scope (address pool) of a DHCP server. Objects of this class are read-only and are returned by the getDHCPScopes() method of the Node class.

Instance attributes

declinedAddresses: uint64

Number of declined addresses in the scope, or null if the DHCP server does not report declined addresses.

freeAddresses: uint64

Number of free addresses in the scope.

id: String

Scope ID. Use it as the scopeId argument of getDHCPLeases() and to match the scopeId attribute of DHCPLease objects.

isEnabled: bool

TRUE if the scope is enabled on the DHCP server.

name: String

Scope name.

network ⇒ InetAddress

Network address of the scope, with mask bits set to the network prefix length. null if not known.

ranges: String

Address ranges of the scope in human-readable form.

totalAddresses: uint64

Total number of addresses in the scope.

usedAddresses: uint64

Number of used (leased) addresses in the scope.

utilization: float

Scope utilization in percent (used addresses relative to total addresses). 0 if the total number of addresses is 0.