]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/dhcpd
dhcpd(8), ndb(6): update documentation (thanks k0ga)
[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 ipmask
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 rootserver
164 used by Unix machines for boot NFS server
165 .TP
166 .B vendor
167 Specific vendor attribute for dhcp and bootp
168 .PD
169 .PP
170 .I Dhcpd
171 will answer
172 .SM BOOTP
173 requests only if it has been specifically targeted or if it
174 has read access to the boot file for the requester.  That means that the requester
175 must specify a boot file in the request or one has to exist in NDB for
176 .I dhcpd
177 to answer.
178 .I Dhcpd
179 will answer all
180 .SM DHCP
181 requests for which it can associate an IP address with the
182 requester.
183 The options are:
184 .TP
185 .B d
186 Print debugging to standard output.
187 .TP
188 .B h
189 Change directory to
190 .IR homedir .
191 The default is
192 .BR / .
193 This should match the
194 .I homedir
195 setting of
196 .I tftpd
197 so that the existence check of non-rooted file names
198 is consistent.
199 .TP
200 .B f
201 Specify a file other than
202 .B /lib/ndb/local
203 as the network database.
204 .TP
205 .B m
206 Mute: don't reply to requests, just log them and what
207 .I dhcpd
208 would have done.
209 .TP
210 .B M
211 Use
212 .I secs
213 as the minimum lease time for dynamic addresses.
214 .TP
215 .B n
216 Don't answer
217 .SM BOOTP
218 requests.
219 .TP
220 .B p
221 Answer
222 .SM DHCP
223 requests from
224 .SM PPTP
225 clients only.
226 .TP
227 .B r
228 Mute static addresses: don't reply to requests for static addresses,
229 just log them and what
230 .I dhcpd
231 would have done.
232 .TP
233 .B s
234 Sleep 2 seconds before answering requests for static addresses.
235 This is used to make a server be a backup only.
236 .TP
237 .B S
238 Sleep 2 seconds before answering requests for dynamic addresses.
239 .TP
240 .B x
241 The IP stack to use is mounted at 
242 .IR netmtpt .
243 The default is
244 .BR /net .
245 .TP
246 .B Z
247 Use
248 .I secs
249 as the minimum lease time for static addresses.
250 .PD
251 .PP
252 .I Dhcp6d
253 provides DHCPv6 service for IPv6 clients. Only network boot and
254 DNS parameters are supported.
255 .PP
256 .I Dhcpleases
257 prints out the currently valid DHCP leases found in the
258 .B /lib/ndb/dhcp
259 directory.
260 .PP
261 .I Rarpd
262 performs the Reverse Address Resolution Protocol, translating
263 Ethernet addresses into IP addresses.
264 The options are:
265 .TP
266 .B d
267 Print debugging to standard output.
268 .TP
269 .B e
270 Use the Ethernet mounted at
271 .BI /net/ etherdev\f1.
272 .TP
273 .B x
274 The IP stack to use is mounted at 
275 .IR netmtpt .
276 The default is
277 .BR /net .
278 .PD
279 .PP
280 .I Tftpd
281 transfers files to systems that are booting.
282 It runs as user
283 .B none
284 and can only access files with global read permission.
285 The options are:
286 .TP
287 .B d
288 Print debugging to standard output.
289 .TP
290 .B x
291 The IP stack to use is mounted at 
292 .IR netmtpt .
293 The default is
294 .BR /net .
295 .TP
296 .B h
297 Change directory to
298 .IR homedir .
299 The default is
300 .BR / .
301 All requests for files with non-rooted file names are served starting at this
302 directory. This needs to be consistent with the
303 .I homedir
304 setting of
305 .IR dhcpd .
306 .I Tftpd
307 supports only octet mode.
308 .TP
309 .B r
310 Restricts access to only those files rooted in the
311 .IR homedir .
312 .PD
313 .SH FILES
314 .BR /lib/ndb/dhcp "    directory of dynamic address files
315 .SH SOURCE
316 .B /sys/src/cmd/ip
317 .SH "SEE ALSO"
318 .IR ndb (6),
319 .IR booting (8)