man/dhcpd-pools.1

   1 .\"     Sami Kerola
   2 .\"     http://www.iki.fi/kerolasa/
   3 .\"     kerolasa@iki.fi
   4 .\"
   5 .\"     Add'l ontributions by:
   6 .\"             Dan Thorson
   7 .\"
   8 .TH DHCPD-POOLS 1 "Jan 21 2011" "SourceForge" "ISC dhcpd analysis"
   9 .SH NAME
  10 dhcpd-pools \- ISC dhcpd pools usage analysis
  11 .SH SYNOPSIS
  12 .B dhcpd-pools
  13 [-c file] [-l file] [-f thcxX] [-s nimcptTe] [-r] [-o file] [-L nr] [-v] [-h]
  14 .SH DESCRIPTION
  15 The program analyses ISC dhcpd shared network and pool usage and outputs the
  16 results in a user selectable format.
  17 .SH FIELDS
  18 .TP
  19 .I "shared net name"
  20 Name of the shared-network for the range.
  21 .TP
  22 .I "first ip"
  23 First IP in lease pool range.
  24 .TP
  25 .I "last ip"
  26 Last IP in lease pool range.
  27 .TP
  28 .I "max"
  29 Number of IPs which exist in a pool, shared network or all together.
  30 .TP
  31 .I "cur"
  32 Number of leases currently in use.
  33 .TP
  34 .I "percent"
  35 Percent of IPs currently in use compared to max.
  36 .TP
  37 .I "touch"
  38 Number of IP's which appear in the lease file, but who's leases have
  39 expired. A touched IP is either expired or abandoned.  The touched IP count
  40 is somewhat misleading when you try to determine if an IP pool is big
  41 enough; it is a better indicator of whether a pool is too large.
  42 .TP
  43 .I "t+c"
  44 The sum of Touched and Currently in-use leases.
  45 .TP
  46 .I "t+c perc"
  47 Percent of IPs either touched or currently in use, compared to max.
  48 .TP
  49 .I "bu"
  50 Failover pair can allocate these addresses. The count appears only if there
  51 is failover configuration.
  52 .TP
  53 .I "bu perc"
  54 Percent of addresses that failover pair can allocate. The percent appears
  55 only if there is failover configuration.
  56 .SH ARGUMENTS
  57 .TP
  58 .I "\-c, \-\-config"
  59 Path to the dhcpd.conf file.
  60 .TP
  61 .I "\-l, \-\-leases"
  62 Path to the dhcpd.leases file.
  63 .TP
  64 .I "\-s, \-\-sort"
  65 Sort ranges by chosen fields as a sorting keys.  Maximum of five sort keys
  66 can be defined.  Keys weight from left to right IE if more weighting keys
  67 are equal next one is used. The IP field is default sort key.
  68 .TP
  69 .I "\-r, \-\-reverse"
  70 Sort results in reverse order.
  71 .TP
  72 .I "\-f, \-\-format"
  73 Output format. Currently there is text, html, full-html and csv
  74 (comma-separated values). Default is text. Standard html (h) outputs only
  75 the HTML tables, and is useful for embeding more complex web pages.
  76 Full-html (H) provides complete HTML headers, etc., including in-line CSS.
  77 Output format xml (x) is similar to the dhcpstatus Perl module output. The
  78 extended xml (X) format will print ethernet address details.
  79 .TP
  80 .I "\-o, \-\-output"
  81 File where output is written. Default is stdout.
  82 .TP
  83 .I "\-L, \-\-limit"
  84 Limit what will be printed. Syntax is similar to chmod permission string.
  85 The limit string uses two digits which vary between 0 to 7.  The first digit
  86 determines which headers to display, and the second digit determines which
  87 numeric analysis tables to include in the output. The following values are
  88 "OR'd" together to create the desired output. The default is 77.
  89
  90 .RS
  91 .PD 0
  92 .TP
  93 .B 01
  94 Print x
  95 .TP
  96 .B 02
  97 Print y
  98 .TP
  99 .B 04
 100 Print z
 101 .TP
 102 .B 10
 103 Print headers for x
 104 .TP
 105 .B 20
 106 Print headers for y
 107 .TP
 108 .B 40
 109 Print headers for z
 110 .PD
 111 .RE
 112 .TP
 113 .I "\-v, \-\-version"
 114 Print version information to standard output and exit successfully.
 115 .TP
 116 .I "\-h, \-\-help"
 117 Print help to standard output and exit successfully.
 118 .SH FILES
 119 .if n .ta 2.8i
 120 .if t .ta 2.1i
 121 /etc/dhcpd.conf
 122 .br
 123     ISC dhcpd configuration file.
 124 .br
 125 .br
 126 /var/lib/dhcp/dhcpd.leases
 127 .br
 128     ISC dhcpd lease file.
 129 .SH AUTHOR
 130 Sami Kerola <kerolasa@iki.fi>
 131 .br
 132 http://dhcpd-pools.sourceforge.net/
 133 .SH "SEE ALSO"
 134 .BR dhcpd.leases (5),
 135 .BR dhcpd.conf (5),
 136 .BR chmod (1)