DHCPD-POOLS

NAME
SYNOPSIS
DESCRIPTION
OUTPUT FIELDS
OPTIONS
EXAMPLES
FILES
AUTHORS
REPORTING BUGS
SEE ALSO

NAME

dhcpd-pools − ISC dhcpd pools usage analysis

SYNOPSIS

dhcpd-pools [options]

DESCRIPTION

The program analyses ISC dhcpd shared network and pool usage and outputs the results in a format selected by user.

OUTPUT FIELDS

shared net name

Name of the shared-network for the range.

first ip

First IP in lease pool range.

last ip

Last IP in lease pool range.

max

Number of IPs which exist in a pool, shared network or all together.

cur

Number of leases currently in use.

percent

Percent of IPs currently in use compared to max.

touch

Number of IP’s which appear in the lease file, but who’s leases have expired. A touched IP is either expired or abandoned. The touched IP count is somewhat misleading when you try to determine if an IP pool is big enough; it is a better indicator of whether a pool is too large.

t+c

The sum of Touched and Currently in-use leases.

t+c perc

Percent of IPs either touched or currently in use, compared to max.

bu

Failover pair can allocate these addresses. The count appears only if there is failover configuration.

bu perc

Percent of addresses that failover pair can allocate. The percent appears only if there is failover configuration.

OPTIONS

−c, −−config=FILE

Path to the dhcpd.conf file.

−l, −−leases=FILE

Path to the dhcpd.leases file.

−s, −−sort=[nimcptTe]

Sort ranges by chosen fields as a sorting keys. Maximum of five sort keys can be defined. Keys weight from left to right, i.e., if more weighting keys are equal next one is used. The IP field is default sort key.

−r, −−reverse

Sort results in reverse order.

−f, −−format=[thHcxXjJ]

Output format. Text (t). Standard html (h) outputs only the HTML tables, and is useful for embedding more complex web pages. Full-html (H) provides complete HTML headers, etc., including in-line CSS. The (c) stands for comma-separated values. Output format xml (x) is similar to the dhcpstatus Perl module output. The extended xml (X) format will print ethernet address details. The (j) will output in json format, which can be extended with (J) to include ethernet address.

The default format is text.

−o, −−output=FILE

File where output is written. Default is stdout.

−L, −−limit=NR

The NR will limit what will be printed. Syntax is similar to chmod(1) permission string. The NR limit string uses two digits which vary between to 7. The first digit determines which headers to display, and the second digit determines which numeric analysis tables to include in the output. The following values are "OR’d" together to create the desired output. The default is 77.

01

Print ranges

02

Print shared networks

04

Print total summary

10

Print range header

20

Print shared network header

40

Print total summary header

−−warning=percent

Turn on alarm output format, and specify percentage number which will cause an alarm. If either a range or shared network will exceed warning level return value of the command is 1. If only range monitoring is needed one can use limit option for scoping, for example −L10. To monitor shared network only the limit would be −L20. If warning percentage is not specified it defaults to 80. The percent argument allows fractions, e.g., 88.8, to be used.

−−critical=percent

The option is similar to warning, with exception of return value which is 2. If critical percentage is not specified it defaults to 90.

−v, −−version

Print version information to standard output and exit successfully.

−h, −−help

Print help to standard output and exit successfully.

EXAMPLES

Print ranges header, and analysis.

$ dhcpd-pools −L 11 −c dhcpd.conf −l dhcpd.leases
Ranges:
shared net name [...]

Print shared networks and totals, both headers and results

$ dhcpd-pools −L 66 −c dhcpd.conf −l dhcpd.leases shared net name
[...]

Alarming

$ dhcpd-pools −c dhcpd.conf −l dhcpd.leases −−critical 80.1 −−warning 75
CRITICAL: dhcpd-pools: Ranges; crit: 14 warn: 22 ok: 220 Shared nets; crit: 1 warn: 0 ok: 4

FILES

/etc/dhcpd.conf

ISC dhcpd configuration file.

/var/lib/dhcp/dhcpd.leases

ISC dhcpd lease file.

AUTHORS

Original design by Sami Kerola.
XML support by Dominic Germain, Sogetel inc.
IPv6 support by Cheer Xiao.

The software has FreeBSD License.

REPORTING BUGS

Report bugs to Sami Kerola
Home page

SEE ALSO

dhcpd.leases(5), dhcpd.conf(5), chmod(1)