mirror of
git://git.code.sf.net/p/dhcpd-pools/code
synced 2025-12-16 07:47:00 +00:00
235825b084
This patch adds consistant underlining to arguments, and unifies spacing. Also the wording for -L is made much better, it's been common to hear the manual was unclear about that option. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
162 lines
3.7 KiB
Groff
162 lines
3.7 KiB
Groff
.\" Sami Kerola
|
|
.\" http://www.iki.fi/kerolasa/
|
|
.\" kerolasa@iki.fi
|
|
.\"
|
|
.\" Add'l ontributions by:
|
|
.\" Dan Thorson
|
|
.\"
|
|
.TH DHCPD-POOLS "1" "September 2011" "dhcpd-pools" "User Commands"
|
|
.SH NAME
|
|
dhcpd-pools \- ISC dhcpd pools usage analysis
|
|
.SH SYNOPSIS
|
|
.B dhcpd-pools
|
|
[options]
|
|
[\fIOPTIONS\fR]
|
|
.SH DESCRIPTION
|
|
The program analyses ISC dhcpd shared network and pool usage and outputs the
|
|
results in a format selected by user.
|
|
.SH FIELDS
|
|
.TP
|
|
.I "shared net name"
|
|
Name of the shared-network for the range.
|
|
.TP
|
|
.I "first ip"
|
|
First IP in lease pool range.
|
|
.TP
|
|
.I "last ip"
|
|
Last IP in lease pool range.
|
|
.TP
|
|
.I "max"
|
|
Number of IPs which exist in a pool, shared network or all together.
|
|
.TP
|
|
.I "cur"
|
|
Number of leases currently in use.
|
|
.TP
|
|
.I "percent"
|
|
Percent of IPs currently in use compared to max.
|
|
.TP
|
|
.I "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.
|
|
.TP
|
|
.I "t+c"
|
|
The sum of Touched and Currently in-use leases.
|
|
.TP
|
|
.I "t+c perc"
|
|
Percent of IPs either touched or currently in use, compared to max.
|
|
.TP
|
|
.I "bu"
|
|
Failover pair can allocate these addresses. The count appears only if there
|
|
is failover configuration.
|
|
.TP
|
|
.I "bu perc"
|
|
Percent of addresses that failover pair can allocate. The percent appears
|
|
only if there is failover configuration.
|
|
.SH ARGUMENTS
|
|
.TP
|
|
\fB\-c\fR, \fB\-\-config\fR=\fIFILE\fR
|
|
Path to the dhcpd.conf file.
|
|
.TP
|
|
\fB\-l\fR, \fB\-\-leases\fR=\fIFILE\fR
|
|
Path to the dhcpd.leases file.
|
|
.TP
|
|
\fB\-s\fR, \fB\-\-sort\fR=\fI[nimcptTe]\fR
|
|
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.
|
|
.TP
|
|
\fB\-r\fR, \fB\-\-reverse\fR
|
|
Sort results in reverse order.
|
|
.TP
|
|
\fB\-f\fR, \fB\-\-format\fR=\fI[thHcxX]\fR
|
|
Output format. The default is
|
|
text
|
|
.RI ( t ).
|
|
Standard html
|
|
.RI ( h )
|
|
outputs only the HTML tables, and is useful for embeding more complex web
|
|
pages. Full-html
|
|
.RI ( H )
|
|
provides complete HTML headers, etc., including in-line CSS. The
|
|
.RI ( c )
|
|
stands for comma-separated values. Output format xml
|
|
.RI ( x )
|
|
is similar to the dhcpstatus Perl module output. The extended xml
|
|
.RI ( X )
|
|
format will print ethernet address details.
|
|
.TP
|
|
\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
|
|
.I File
|
|
where output is written. Default is stdout.
|
|
.TP
|
|
\fB\-L\fR, \fB\-\-limit\fR=\fINR\fR
|
|
The
|
|
.I NR
|
|
will limit what will be printed. Syntax is similar to
|
|
.IR chmod (1)
|
|
permission string. The
|
|
.I NR
|
|
limit string uses two digits which vary between
|
|
.IR 0 \ 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
|
|
.IR 77 .
|
|
.PP
|
|
.RS
|
|
.PD 0
|
|
.TP
|
|
.B 01
|
|
Print ranges
|
|
.TP
|
|
.B 02
|
|
Print shared networks
|
|
.TP
|
|
.B 04
|
|
Print total summary
|
|
.TP
|
|
.B 10
|
|
Print range header
|
|
.TP
|
|
.B 20
|
|
Print shared network header
|
|
.TP
|
|
.B 40
|
|
Print total summary header
|
|
.PD
|
|
.RE
|
|
.TP
|
|
\fB\-v\fR, \fB\-\-version\fR
|
|
Print version information to standard output and exit successfully.
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
Print help to standard output and exit successfully.
|
|
.SH FILES
|
|
.TP
|
|
/etc/dhcpd.conf
|
|
ISC dhcpd configuration file.
|
|
.TP
|
|
/var/lib/dhcp/dhcpd.leases
|
|
ISC dhcpd lease file.
|
|
.SH AUTHOR
|
|
Written by Sami Kerola.
|
|
.br
|
|
XML support by Dominic Germain, Sogetel inc.
|
|
.PP
|
|
The software has FreeBSD License.
|
|
.SH "REPORTING BUGS"
|
|
Report bugs to
|
|
.MT kerolasa@iki.fi
|
|
Sami Kerola
|
|
.ME
|
|
.br
|
|
.UR http://dhcpd-pools.sourceforge.net/
|
|
Home page
|
|
.UE
|
|
.SH "SEE ALSO"
|
|
.BR dhcpd.leases (5),
|
|
.BR dhcpd.conf (5),
|
|
.BR chmod (1)
|