aboutsummaryrefslogtreecommitdiff
path: root/contrib/bind9/bin/rndc/rndc.html
blob: 56f1aa1dba159e5e079e2c3c606bad0fe9ac4c52 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<!--
 - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
 - Copyright (C) 2001  Internet Software Consortium.
 -
 - Permission to use, copy, modify, and distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<!-- $Id: rndc.html,v 1.7.2.1.4.3 2004/08/22 23:39:00 marka Exp $ -->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>rndc</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
></A
><SPAN
CLASS="APPLICATION"
>rndc</SPAN
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN9"
></A
><H2
>Name</H2
><SPAN
CLASS="APPLICATION"
>rndc</SPAN
>&nbsp;--&nbsp;name server control utility</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN13"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>rndc</B
>  [<VAR
CLASS="OPTION"
>-c <VAR
CLASS="REPLACEABLE"
>config-file</VAR
></VAR
>] [<VAR
CLASS="OPTION"
>-k <VAR
CLASS="REPLACEABLE"
>key-file</VAR
></VAR
>] [<VAR
CLASS="OPTION"
>-s <VAR
CLASS="REPLACEABLE"
>server</VAR
></VAR
>] [<VAR
CLASS="OPTION"
>-p <VAR
CLASS="REPLACEABLE"
>port</VAR
></VAR
>] [<VAR
CLASS="OPTION"
>-V</VAR
>] [<VAR
CLASS="OPTION"
>-y <VAR
CLASS="REPLACEABLE"
>key_id</VAR
></VAR
>] {command}</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN34"
></A
><H2
>DESCRIPTION</H2
><P
>        <B
CLASS="COMMAND"
>rndc</B
> controls the operation of a name
	server.  It supersedes the <B
CLASS="COMMAND"
>ndc</B
> utility
	that was provided in old BIND releases.  If
	<B
CLASS="COMMAND"
>rndc</B
> is invoked with no command line
	options or arguments, it prints a short summary of the
	supported commands and the available options and their
	arguments.
    </P
><P
>        <B
CLASS="COMMAND"
>rndc</B
> communicates with the name server
	over a TCP connection, sending commands authenticated with
	digital signatures.  In the current versions of
	<B
CLASS="COMMAND"
>rndc</B
> and <B
CLASS="COMMAND"
>named</B
> named
        the only supported authentication algorithm is HMAC-MD5,
	which uses a shared secret on each end of the connection.
	This provides TSIG-style authentication for the command
	request and the name server's response.  All commands sent
	over the channel must be signed by a key_id known to the
	server.
    </P
><P
>        <B
CLASS="COMMAND"
>rndc</B
> reads a configuration file to
	determine how to contact the name server and decide what
	algorithm and key it should use.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN46"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-c <VAR
CLASS="REPLACEABLE"
>config-file</VAR
></DT
><DD
><P
>	      Use <VAR
CLASS="REPLACEABLE"
>config-file</VAR
>
	      as the configuration file instead of the default,
	      <TT
CLASS="FILENAME"
>/etc/rndc.conf</TT
>.
	  </P
></DD
><DT
>-k <VAR
CLASS="REPLACEABLE"
>key-file</VAR
></DT
><DD
><P
>	      Use <VAR
CLASS="REPLACEABLE"
>key-file</VAR
>
	      as the key file instead of the default,
	      <TT
CLASS="FILENAME"
>/etc/rndc.key</TT
>.  The key in
	      <TT
CLASS="FILENAME"
>/etc/rndc.key</TT
> will be used to authenticate
	      commands sent to the server if the <VAR
CLASS="REPLACEABLE"
>config-file</VAR
>
	      does not exist.
	  </P
></DD
><DT
>-s <VAR
CLASS="REPLACEABLE"
>server</VAR
></DT
><DD
><P
>	       <VAR
CLASS="REPLACEABLE"
>server</VAR
> is
	       the name or address of the server which matches a
	       server statement in the configuration file for
	       <B
CLASS="COMMAND"
>rndc</B
>.  If no server is supplied on the
	       command line, the host named by the default-server clause
	       in the option statement of the configuration file will be
	       used.
	  </P
></DD
><DT
>-p <VAR
CLASS="REPLACEABLE"
>port</VAR
></DT
><DD
><P
>	       Send commands to TCP port
	       <VAR
CLASS="REPLACEABLE"
>port</VAR
> instead
	       of BIND 9's default control channel port, 953.
	  </P
></DD
><DT
>-V</DT
><DD
><P
>	       Enable verbose logging.
	  </P
></DD
><DT
>-y <VAR
CLASS="REPLACEABLE"
>keyid</VAR
></DT
><DD
><P
>	       Use the key <VAR
CLASS="REPLACEABLE"
>keyid</VAR
>
	       from the configuration file.
	       <VAR
CLASS="REPLACEABLE"
>keyid</VAR
> must be
	       known by named with the same algorithm and secret string
	       in order for control message validation to succeed.
	       If no <VAR
CLASS="REPLACEABLE"
>keyid</VAR
>
	       is specified, <B
CLASS="COMMAND"
>rndc</B
> will first look
	       for a key clause in the server statement of the server
	       being used, or if no server statement is present for that
	       host, then the default-key clause of the options statement.
	       Note that the configuration file contains shared secrets
	       which are used to send authenticated control commands
	       to name servers.  It should therefore not have general read
	       or write access.
	  </P
></DD
></DL
></DIV
><P
>      For the complete set of commands supported by <B
CLASS="COMMAND"
>rndc</B
>,
      see the BIND 9 Administrator Reference Manual or run
      <B
CLASS="COMMAND"
>rndc</B
> without arguments to see its help message.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN94"
></A
><H2
>LIMITATIONS</H2
><P
>        <B
CLASS="COMMAND"
>rndc</B
> does not yet support all the commands of
	the BIND 8 <B
CLASS="COMMAND"
>ndc</B
> utility.
    </P
><P
>        There is currently no way to provide the shared secret for a
        <VAR
CLASS="OPTION"
>key_id</VAR
> without using the configuration file.
    </P
><P
>        Several error messages could be clearer.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN102"
></A
><H2
>SEE ALSO</H2
><P
>      <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>rndc.conf</SPAN
>(5)</SPAN
>,
      <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>named</SPAN
>(8)</SPAN
>,
      <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>named.conf</SPAN
>(5)</SPAN
>
      <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>ndc</SPAN
>(8)</SPAN
>,
      <I
CLASS="CITETITLE"
>BIND 9 Administrator Reference Manual</I
>.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN118"
></A
><H2
>AUTHOR</H2
><P
>        Internet Systems Consortium
    </P
></DIV
></BODY
></HTML
>