]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/dhcpd
tmdate(2): correct example in manpage
[plan9front.git] / sys / man / 8 / dhcpd
1 .TH DHCPD 8
2 .SH NAME
3 dhcpd, dhcp6d, dhcpleases, rarpd, tftpd \- Internet booting
4 .SH SYNOPSIS
5 .PP
6 .B ip/dhcpd
7 .RB [ -dmnprsSZ ]
8 .RB [ -h
9 .IR homedir ]
10 .RB [ -f
11 .IR ndbfile ]
12 .RB [ -M
13 .IR secs ]
14 .RB [ -x
15 .IR netmtpt ]
16 .RB [ -Z
17 .IR secs ]
18 [
19 .I address
20 .I n
21 ] ...
22 .PP
23 .B ip/dhcpleases
24 .PP
25 .B ip/dhcp6d
26 .RB [ -d ]
27 .RB [ -f
28 .IR ndbfile ]
29 .RB [ -x
30 .IR netmtpt ]
31 .PP
32 .B ip/rarpd
33 .RB [ -d ]
34 .RB [ -e
35 .IR etherdev ]
36 .RB [ -x
37 .IR netmtpt ]
38 .PP
39 .B ip/tftpd
40 .RB [ -dr ]
41 .RB [ -h
42 .IR homedir ]
43 .RB [ -x
44 .IR netmtpt ]
45 .SH DESCRIPTION
46 These programs support booting over the Internet.
47 They should all be run on the same server to
48 allow other systems to be booted.
49 .IR Dhcpd ,
50 .I dhcp6d
51 and
52 .I tftpd
53 are used to boot everything;
54 .I rarpd
55 is an extra piece just for Suns.
56 .PP
57 .I Dhcpd
58 runs the
59 .SM BOOTP
60 and
61 .SM DHCP
62 protocols.
63 Clients use these protocols to obtain configuration information.
64 This information comes from attribute/value pairs in the network database
65 (see
66 .IR ndb (6)
67 and
68 .IR ndb (8)).
69 DHCP requests are honored both for static addresses found in
70 the NDB and for dynamic addresses listed in the command line.
71 DHCP requests are honored if either:
72 .br
73 \- there exists an NDB entry
74 containing both the ethernet address of the requester and
75 an IP address on the originating network or subnetwork.
76 .br
77 \- a free dynamic address exists on the originating network or subnetwork.
78 .PP
79 A BOOTP request is honored if all of the following are true:
80 .br
81 \- there exists an NDB entry
82 containing both the ethernet address of the requester and
83 an IP address on the originating network or subnetwork.
84 .br
85 \- the entry contains a
86 .B bootf=
87 attribute
88 .br
89 \- the file in the
90 .B bootf=
91 attribute is readable.
92 .PP
93 Dynamic addresses are specified on the command line as a list
94 of addresses and number pairs.
95 For example,
96 .EX
97         ip/dhcpd 10.1.1.12 10 10.2.1.70 12
98 .EE
99 directs
100 .I dhcpd
101 to return dynamic addresses 10.1.1.12 through 10.1.1.21 inclusive
102 and 10.2.1.70 through 10.2.1.81 inclusive.
103 .PP
104 .I Dhcpd
105 maintains a record of all dynamic addresses in the directory
106 .BR /lib/ndb/dhcp ,
107 one file per address.
108 If multiple servers have access to this common directory,
109 they will correctly coordinate their actions.
110 .PP
111 Attributes come from either the NDB entry for the system, the entry for its
112 subnet, or the entry for its network.  The system entry has precedence,
113 then the subnet, then the network.
114 The NDB attributes used are:
115 .TF rootserver
116 .TP
117 .B ip
118 the IP address
119 .TP
120 .B ipmask
121 the IP mask
122 .TP
123 .B ipgw
124 the default IP gateway
125 .TP
126 .B dom
127 the domain name of the system
128 .TP
129 .B fs
130 the default Plan 9 file server
131 .TP
132 .B auth
133 the default Plan 9 authentication server
134 .TP
135 .B dns
136 a domain name server
137 .TP
138 .B ntp
139 a network time protocol server
140 .TP
141 .B time
142 a time server
143 .TP
144 .B wins
145 a
146 .SM NETBIOS
147 name server
148 .TP
149 .B www
150 a World Wide Web proxy
151 .TP
152 .B pop3
153 a POP3 mail server
154 .TP
155 .B smtp
156 an SMTP mail server
157 .TP
158 .B bootf
159 the default boot file;
160 see
161 .IR ndb (6)
162 .TP
163 .B tftp
164 the TFTP server to fetch
165 .I bootf
166 from
167 .TP
168 .B rootpath
169 the NFS root for unix machines
170 .TP
171 .B rootserver
172 the NFS server used with
173 .I rootpath
174 .TP
175 .B vendor
176 Specific vendor attribute for dhcp and bootp
177 .PD
178 .PP
179 .I Dhcpd
180 will answer
181 .SM BOOTP
182 requests only if it has been specifically targeted or if it
183 has read access to the boot file for the requester.  That means that the requester
184 must specify a boot file in the request or one has to exist in NDB for
185 .I dhcpd
186 to answer.
187 .I Dhcpd
188 will answer all
189 .SM DHCP
190 requests for which it can associate an IP address with the
191 requester.
192 The options are:
193 .TP
194 .B d
195 Print debugging to standard output.
196 .TP
197 .B h
198 Change directory to
199 .IR homedir .
200 The default is
201 .BR / .
202 This should match the
203 .I homedir
204 setting of
205 .I tftpd
206 so that the existence check of non-rooted file names
207 is consistent.
208 .TP
209 .B f
210 Specify a file other than
211 .B /lib/ndb/local
212 as the network database.
213 .TP
214 .B m
215 Mute: don't reply to requests, just log them and what
216 .I dhcpd
217 would have done.
218 .TP
219 .B M
220 Use
221 .I secs
222 as the minimum lease time for dynamic addresses.
223 .TP
224 .B n
225 Don't answer
226 .SM BOOTP
227 requests.
228 .TP
229 .B p
230 Answer
231 .SM DHCP
232 requests from
233 .SM PPTP
234 clients only.
235 .TP
236 .B r
237 Mute static addresses: don't reply to requests for static addresses,
238 just log them and what
239 .I dhcpd
240 would have done.
241 .TP
242 .B s
243 Sleep 2 seconds before answering requests for static addresses.
244 This is used to make a server be a backup only.
245 .TP
246 .B S
247 Sleep 2 seconds before answering requests for dynamic addresses.
248 .TP
249 .B x
250 The IP stack to use is mounted at 
251 .IR netmtpt .
252 The default is
253 .BR /net .
254 .TP
255 .B Z
256 Use
257 .I secs
258 as the minimum lease time for static addresses.
259 .PD
260 .PP
261 .I Dhcp6d
262 provides DHCPv6 service for IPv6 clients. Only network boot and
263 DNS parameters are supported.
264 .PP
265 .I Dhcpleases
266 prints out the currently valid DHCP leases found in the
267 .B /lib/ndb/dhcp
268 directory.
269 .PP
270 .I Rarpd
271 performs the Reverse Address Resolution Protocol, translating
272 Ethernet addresses into IP addresses.
273 The options are:
274 .TP
275 .B d
276 Print debugging to standard output.
277 .TP
278 .B e
279 Use the Ethernet mounted at
280 .BI /net/ etherdev\f1.
281 .TP
282 .B x
283 The IP stack to use is mounted at 
284 .IR netmtpt .
285 The default is
286 .BR /net .
287 .PD
288 .PP
289 .I Tftpd
290 transfers files to systems that are booting.
291 It runs as user
292 .B none
293 and can only access files with global read permission.
294 The options are:
295 .TP
296 .B d
297 Print debugging to standard output.
298 .TP
299 .B x
300 The IP stack to use is mounted at 
301 .IR netmtpt .
302 The default is
303 .BR /net .
304 .TP
305 .B h
306 Change directory to
307 .IR homedir .
308 The default is
309 .BR / .
310 All requests for files with non-rooted file names are served starting at this
311 directory. This needs to be consistent with the
312 .I homedir
313 setting of
314 .IR dhcpd .
315 .I Tftpd
316 supports only octet mode.
317 .TP
318 .B r
319 Restricts access to only those files rooted in the
320 .IR homedir .
321 .PD
322 .SH FILES
323 .BR /lib/ndb/dhcp "    directory of dynamic address files
324 .SH SOURCE
325 .B /sys/src/cmd/ip
326 .SH "SEE ALSO"
327 .IR ndb (6),
328 .IR booting (8)