Merge tag 'release_3_0_12' into branch moonshot-fr-3.0.12-upgrade.
[freeradius.git] / man / man1 / dhcpclient.1
1 .TH DHCPCLIENT 1 "19 September 2016" "" "FreeRADIUS Daemon"
2 .SH NAME
3 dhcpclient - Send a DHCP request with provided RADIUS attributes and get the output response.
4 .SH SYNOPSIS
5 .B dhcpclient
6 .RB [ \-d
7 .IR raddb_directory ]
8 .RB [ \-D
9 .IR dictionary_directory ]
10 .RB [ \-f
11 .IR file ]
12 .RB [ \-h ]
13 .RB [ \-i
14 .IR interface ]
15 .RB [ \-t
16 .IR timeout ]
17 .RB [ \-v ]
18 .RB [ \-x ]
19 \fIserver[:port] {discover|request|decline|release|inform|auto}\fP
20 .SH DESCRIPTION
21 \fBdhcpclient\fP is a DHCP test client program. It can send arbitrary DHCP
22 packets to the FreeRADIUS server running as DHCP server, then shows the reply.
23 It can be used to test changes you made in the configuration of the radius server,
24 or it can be used to monitor if a radius server is up.
25 .PP
26 \fBdhcpclient\fP reads radius attribute/value pairs from its standard
27 input, or from a file specified on the command line. It then encodes
28 these attribute/value pairs using the dictionary, and sends them
29 to the local/remote server.
30 .PP
31
32 .SH OPTIONS
33
34 .IP \-d\ \fIraddb_directory\fP
35 The directory that contains the user dictionary file. Defaults to
36 \fI/etc/raddb\fP.
37 .IP \-D\ \fIdictionary_directory\fP
38 The directory that contains the main dictionary file. Defaults to
39 \fI/usr/share/freeradius\fP.
40 .IP \-f\ \fIfile[:file]\fP
41 File to read the attribute/value pairs from. If this is not specified,
42 they are read from stdin.  This option can be specified multiple
43 times, in which case packets are sent in order by file, and within
44 each file, by first packet to last packet.  A blank line separates
45 logical packets within a file.
46 .IP \-h
47 Print usage help information.
48 .IP \-i\ \fIinterface\fP
49 Select which interface to send/receive at packet level on a raw socket.
50 .IP \-t\ \fItimeout\fP
51 Wait \fItimeout\fP seconds before deciding that the NAS has not
52 responded to a request, and re-sending the packet. This may be a floating
53 point number, e.g. 2.2.
54 .IP \-v
55 Print out program version information.
56 .IP \-x
57 Print out debugging information.
58 .IP server[:port]
59 The hostname or IP address of the remote server. Optionally a UDP port
60 can be specified. If no UDP port is specified, it is looked up in
61 \fI/etc/services\fP. The service name looked for is \fBradacct\fP for
62 accounting packets, and \fBradius\fP for all other requests. If a
63 service is not found in \fI/etc/services\fP, 1813 and 1812 are used
64 respectively.
65 .IP discover\ |\ request\ |\ decline\ |\ release\ |\ inform\ |\ auto
66 DHCP options - use the type relevant for testing
67
68 .SH SEE ALSO
69 radiusd(8)
70 .SH AUTHORS
71 Alan DeKok <aland@freeradius.org>