Merge from vendor branch BZIP:
[dragonfly.git] / contrib / bind-9.3 / bin / rndc / rndc.html
1 <!--
2  - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
3  - Copyright (C) 2000, 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 <!-- $Id: rndc.html,v 1.7.2.1.4.12 2006/06/29 13:02:31 marka Exp $ -->
18 <html>
19 <head>
20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21 <title>rndc</title>
22 <meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
23 </head>
24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25 <a name="id2482688"></a><div class="titlepage"></div>
26 <div class="refnamediv">
27 <h2>Name</h2>
28 <p><span class="application">rndc</span> &#8212; name server control utility</p>
29 </div>
30 <div class="refsynopsisdiv">
31 <h2>Synopsis</h2>
32 <div class="cmdsynopsis"><p><code class="command">rndc</code>  [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>] [<code class="option">-s <em class="replaceable"><code>server</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
33 </div>
34 <div class="refsect1" lang="en">
35 <a name="id2549451"></a><h2>DESCRIPTION</h2>
36 <p>
37         <span><strong class="command">rndc</strong></span> controls the operation of a name
38         server.  It supersedes the <span><strong class="command">ndc</strong></span> utility
39         that was provided in old BIND releases.  If
40         <span><strong class="command">rndc</strong></span> is invoked with no command line
41         options or arguments, it prints a short summary of the
42         supported commands and the available options and their
43         arguments.
44     </p>
45 <p>
46         <span><strong class="command">rndc</strong></span> communicates with the name server
47         over a TCP connection, sending commands authenticated with
48         digital signatures.  In the current versions of
49         <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span> named
50         the only supported authentication algorithm is HMAC-MD5,
51         which uses a shared secret on each end of the connection.
52         This provides TSIG-style authentication for the command
53         request and the name server's response.  All commands sent
54         over the channel must be signed by a key_id known to the
55         server.
56     </p>
57 <p>
58         <span><strong class="command">rndc</strong></span> reads a configuration file to
59         determine how to contact the name server and decide what
60         algorithm and key it should use.
61     </p>
62 </div>
63 <div class="refsect1" lang="en">
64 <a name="id2549492"></a><h2>OPTIONS</h2>
65 <div class="variablelist"><dl>
66 <dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
67 <dd><p>
68               Use <em class="replaceable"><code>config-file</code></em>
69               as the configuration file instead of the default,
70               <code class="filename">/etc/rndc.conf</code>.
71           </p></dd>
72 <dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
73 <dd><p>
74               Use <em class="replaceable"><code>key-file</code></em>
75               as the key file instead of the default,
76               <code class="filename">/etc/rndc.key</code>.  The key in
77               <code class="filename">/etc/rndc.key</code> will be used to authenticate
78               commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
79               does not exist.
80           </p></dd>
81 <dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
82 <dd><p>
83                <em class="replaceable"><code>server</code></em> is
84                the name or address of the server which matches a
85                server statement in the configuration file for
86                <span><strong class="command">rndc</strong></span>.  If no server is supplied on the
87                command line, the host named by the default-server clause
88                in the option statement of the configuration file will be
89                used.
90           </p></dd>
91 <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
92 <dd><p>
93                Send commands to TCP port
94                <em class="replaceable"><code>port</code></em> instead
95                of BIND 9's default control channel port, 953.
96           </p></dd>
97 <dt><span class="term">-V</span></dt>
98 <dd><p>
99                Enable verbose logging.
100           </p></dd>
101 <dt><span class="term">-y <em class="replaceable"><code>keyid</code></em></span></dt>
102 <dd><p>
103                Use the key <em class="replaceable"><code>keyid</code></em>
104                from the configuration file.
105                <em class="replaceable"><code>keyid</code></em> must be
106                known by named with the same algorithm and secret string
107                in order for control message validation to succeed.
108                If no <em class="replaceable"><code>keyid</code></em>
109                is specified, <span><strong class="command">rndc</strong></span> will first look
110                for a key clause in the server statement of the server
111                being used, or if no server statement is present for that
112                host, then the default-key clause of the options statement.
113                Note that the configuration file contains shared secrets
114                which are used to send authenticated control commands
115                to name servers.  It should therefore not have general read
116                or write access.
117           </p></dd>
118 </dl></div>
119 <p>
120       For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
121       see the BIND 9 Administrator Reference Manual or run
122       <span><strong class="command">rndc</strong></span> without arguments to see its help message.
123     </p>
124 </div>
125 <div class="refsect1" lang="en">
126 <a name="id2549811"></a><h2>LIMITATIONS</h2>
127 <p>
128         <span><strong class="command">rndc</strong></span> does not yet support all the commands of
129         the BIND 8 <span><strong class="command">ndc</strong></span> utility.
130     </p>
131 <p>
132         There is currently no way to provide the shared secret for a
133         <code class="option">key_id</code> without using the configuration file.
134     </p>
135 <p>
136         Several error messages could be clearer.
137     </p>
138 </div>
139 <div class="refsect1" lang="en">
140 <a name="id2549840"></a><h2>SEE ALSO</h2>
141 <p>
142       <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
143       <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
144       <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>
145       <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
146       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
147     </p>
148 </div>
149 <div class="refsect1" lang="en">
150 <a name="id2549892"></a><h2>AUTHOR</h2>
151 <p>
152         <span class="corpauthor">Internet Systems Consortium</span>
153     </p>
154 </div>
155 </div></body>
156 </html>