Merge from vendor branch BINUTILS:
[dragonfly.git] / contrib / bind-9.2.4rc7 / bin / rndc / rndc.html
1 <!--
2  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
3  - Copyright (C) 2001  Internet Software Consortium.
4  -
5  - Permission to use, copy, modify, and distribute this software for any
6  - purpose with or without fee is hereby granted, provided that the above
7  - copyright notice and this permission notice appear in all copies.
8  -
9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15  - PERFORMANCE OF THIS SOFTWARE.
16 -->
17
18 <!-- $Id: rndc.html,v 1.7.2.3 2004/06/03 05:21:16 marka Exp $ -->
19
20 <HTML
21 ><HEAD
22 ><TITLE
23 >rndc</TITLE
24 ><META
25 NAME="GENERATOR"
26 CONTENT="Modular DocBook HTML Stylesheet Version 1.73
27 "></HEAD
28 ><BODY
29 CLASS="REFENTRY"
30 BGCOLOR="#FFFFFF"
31 TEXT="#000000"
32 LINK="#0000FF"
33 VLINK="#840084"
34 ALINK="#0000FF"
35 ><H1
36 ><A
37 NAME="AEN1"
38 ><SPAN
39 CLASS="APPLICATION"
40 >rndc</SPAN
41 ></A
42 ></H1
43 ><DIV
44 CLASS="REFNAMEDIV"
45 ><A
46 NAME="AEN9"
47 ></A
48 ><H2
49 >Name</H2
50 ><SPAN
51 CLASS="APPLICATION"
52 >rndc</SPAN
53 >&nbsp;--&nbsp;name server control utility</DIV
54 ><DIV
55 CLASS="REFSYNOPSISDIV"
56 ><A
57 NAME="AEN13"
58 ></A
59 ><H2
60 >Synopsis</H2
61 ><P
62 ><B
63 CLASS="COMMAND"
64 >rndc</B
65 >  [<TT
66 CLASS="OPTION"
67 >-c <TT
68 CLASS="REPLACEABLE"
69 ><I
70 >config-file</I
71 ></TT
72 ></TT
73 >] [<TT
74 CLASS="OPTION"
75 >-k <TT
76 CLASS="REPLACEABLE"
77 ><I
78 >key-file</I
79 ></TT
80 ></TT
81 >] [<TT
82 CLASS="OPTION"
83 >-s <TT
84 CLASS="REPLACEABLE"
85 ><I
86 >server</I
87 ></TT
88 ></TT
89 >] [<TT
90 CLASS="OPTION"
91 >-p <TT
92 CLASS="REPLACEABLE"
93 ><I
94 >port</I
95 ></TT
96 ></TT
97 >] [<TT
98 CLASS="OPTION"
99 >-V</TT
100 >] [<TT
101 CLASS="OPTION"
102 >-y <TT
103 CLASS="REPLACEABLE"
104 ><I
105 >key_id</I
106 ></TT
107 ></TT
108 >] {command}</P
109 ></DIV
110 ><DIV
111 CLASS="REFSECT1"
112 ><A
113 NAME="AEN34"
114 ></A
115 ><H2
116 >DESCRIPTION</H2
117 ><P
118 >        <B
119 CLASS="COMMAND"
120 >rndc</B
121 > controls the operation of a name
122         server.  It supersedes the <B
123 CLASS="COMMAND"
124 >ndc</B
125 > utility
126         that was provided in old BIND releases.  If
127         <B
128 CLASS="COMMAND"
129 >rndc</B
130 > is invoked with no command line
131         options or arguments, it prints a short summary of the
132         supported commands and the available options and their
133         arguments.
134     </P
135 ><P
136 >        <B
137 CLASS="COMMAND"
138 >rndc</B
139 > communicates with the name server
140         over a TCP connection, sending commands authenticated with
141         digital signatures.  In the current versions of
142         <B
143 CLASS="COMMAND"
144 >rndc</B
145 > and <B
146 CLASS="COMMAND"
147 >named</B
148 > named
149         the only supported authentication algorithm is HMAC-MD5,
150         which uses a shared secret on each end of the connection.
151         This provides TSIG-style authentication for the command
152         request and the name server's response.  All commands sent
153         over the channel must be signed by a key_id known to the
154         server.
155     </P
156 ><P
157 >        <B
158 CLASS="COMMAND"
159 >rndc</B
160 > reads a configuration file to
161         determine how to contact the name server and decide what
162         algorithm and key it should use.
163     </P
164 ></DIV
165 ><DIV
166 CLASS="REFSECT1"
167 ><A
168 NAME="AEN46"
169 ></A
170 ><H2
171 >OPTIONS</H2
172 ><P
173 ></P
174 ><DIV
175 CLASS="VARIABLELIST"
176 ><DL
177 ><DT
178 >-c <TT
179 CLASS="REPLACEABLE"
180 ><I
181 >config-file</I
182 ></TT
183 ></DT
184 ><DD
185 ><P
186 >             Use <TT
187 CLASS="REPLACEABLE"
188 ><I
189 >config-file</I
190 ></TT
191 >
192               as the configuration file instead of the default,
193               <TT
194 CLASS="FILENAME"
195 >/etc/rndc.conf</TT
196 >.
197           </P
198 ></DD
199 ><DT
200 >-k <TT
201 CLASS="REPLACEABLE"
202 ><I
203 >key-file</I
204 ></TT
205 ></DT
206 ><DD
207 ><P
208 >             Use <TT
209 CLASS="REPLACEABLE"
210 ><I
211 >key-file</I
212 ></TT
213 >
214               as the key file instead of the default,
215               <TT
216 CLASS="FILENAME"
217 >/etc/rndc.key</TT
218 >.  The key in
219               <TT
220 CLASS="FILENAME"
221 >/etc/rndc.key</TT
222 > will be used to authenticate
223               commands sent to the server if the <TT
224 CLASS="REPLACEABLE"
225 ><I
226 >config-file</I
227 ></TT
228 >
229               does not exist.
230           </P
231 ></DD
232 ><DT
233 >-s <TT
234 CLASS="REPLACEABLE"
235 ><I
236 >server</I
237 ></TT
238 ></DT
239 ><DD
240 ><P
241 >              <TT
242 CLASS="REPLACEABLE"
243 ><I
244 >server</I
245 ></TT
246 > is
247                the name or address of the server which matches a
248                server statement in the configuration file for
249                <B
250 CLASS="COMMAND"
251 >rndc</B
252 >.  If no server is supplied on the
253                command line, the host named by the default-server clause
254                in the option statement of the configuration file will be
255                used.
256           </P
257 ></DD
258 ><DT
259 >-p <TT
260 CLASS="REPLACEABLE"
261 ><I
262 >port</I
263 ></TT
264 ></DT
265 ><DD
266 ><P
267 >              Send commands to TCP port
268                <TT
269 CLASS="REPLACEABLE"
270 ><I
271 >port</I
272 ></TT
273 > instead
274                of BIND 9's default control channel port, 953.
275           </P
276 ></DD
277 ><DT
278 >-V</DT
279 ><DD
280 ><P
281 >              Enable verbose logging.
282           </P
283 ></DD
284 ><DT
285 >-y <TT
286 CLASS="REPLACEABLE"
287 ><I
288 >keyid</I
289 ></TT
290 ></DT
291 ><DD
292 ><P
293 >              Use the key <TT
294 CLASS="REPLACEABLE"
295 ><I
296 >keyid</I
297 ></TT
298 >
299                from the configuration file.
300                <TT
301 CLASS="REPLACEABLE"
302 ><I
303 >keyid</I
304 ></TT
305 > must be
306                known by named with the same algorithm and secret string
307                in order for control message validation to succeed.
308                If no <TT
309 CLASS="REPLACEABLE"
310 ><I
311 >keyid</I
312 ></TT
313 >
314                is specified, <B
315 CLASS="COMMAND"
316 >rndc</B
317 > will first look
318                for a key clause in the server statement of the server
319                being used, or if no server statement is present for that
320                host, then the default-key clause of the options statement.
321                Note that the configuration file contains shared secrets
322                which are used to send authenticated control commands
323                to name servers.  It should therefore not have general read
324                or write access.
325           </P
326 ></DD
327 ></DL
328 ></DIV
329 ><P
330 >      For the complete set of commands supported by <B
331 CLASS="COMMAND"
332 >rndc</B
333 >,
334       see the BIND 9 Administrator Reference Manual or run
335       <B
336 CLASS="COMMAND"
337 >rndc</B
338 > without arguments to see its help message.
339     </P
340 ></DIV
341 ><DIV
342 CLASS="REFSECT1"
343 ><A
344 NAME="AEN94"
345 ></A
346 ><H2
347 >LIMITATIONS</H2
348 ><P
349 >        <B
350 CLASS="COMMAND"
351 >rndc</B
352 > does not yet support all the commands of
353         the BIND 8 <B
354 CLASS="COMMAND"
355 >ndc</B
356 > utility.
357     </P
358 ><P
359 >        There is currently no way to provide the shared secret for a
360         <TT
361 CLASS="OPTION"
362 >key_id</TT
363 > without using the configuration file.
364     </P
365 ><P
366 >        Several error messages could be clearer.
367     </P
368 ></DIV
369 ><DIV
370 CLASS="REFSECT1"
371 ><A
372 NAME="AEN102"
373 ></A
374 ><H2
375 >SEE ALSO</H2
376 ><P
377 >      <SPAN
378 CLASS="CITEREFENTRY"
379 ><SPAN
380 CLASS="REFENTRYTITLE"
381 >rndc.conf</SPAN
382 >(5)</SPAN
383 >,
384       <SPAN
385 CLASS="CITEREFENTRY"
386 ><SPAN
387 CLASS="REFENTRYTITLE"
388 >named</SPAN
389 >(8)</SPAN
390 >,
391       <SPAN
392 CLASS="CITEREFENTRY"
393 ><SPAN
394 CLASS="REFENTRYTITLE"
395 >named.conf</SPAN
396 >(5)</SPAN
397 >
398       <SPAN
399 CLASS="CITEREFENTRY"
400 ><SPAN
401 CLASS="REFENTRYTITLE"
402 >ndc</SPAN
403 >(8)</SPAN
404 >,
405       <I
406 CLASS="CITETITLE"
407 >BIND 9 Administrator Reference Manual</I
408 >.
409     </P
410 ></DIV
411 ><DIV
412 CLASS="REFSECT1"
413 ><A
414 NAME="AEN118"
415 ></A
416 ><H2
417 >AUTHOR</H2
418 ><P
419 >        Internet Systems Consortium
420     </P
421 ></DIV
422 ></BODY
423 ></HTML
424 >