man.rndc.html 9.46 KB
Newer Older
Mark Andrews's avatar
gregen  
Mark Andrews committed
1
<!--
Automatic Updater's avatar
Automatic Updater committed
2
 - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
Mark Andrews's avatar
gregen  
Mark Andrews committed
3 4
 - Copyright (C) 2000-2003 Internet Software Consortium.
 - 
Automatic Updater's avatar
regen  
Automatic Updater committed
5
 - Permission to use, copy, modify, and/or distribute this software for any
Mark Andrews's avatar
gregen  
Mark Andrews committed
6 7 8 9 10 11 12 13 14 15 16
 - 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.
-->
Tinderbox User's avatar
Tinderbox User committed
17
<!-- $Id$ -->
Mark Andrews's avatar
gregen  
Mark Andrews committed
18 19 20 21
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc</title>
Mark Andrews's avatar
regen  
Mark Andrews committed
22
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
Mark Andrews's avatar
gregen  
Mark Andrews committed
23 24
<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
Automatic Updater's avatar
regen  
Automatic Updater committed
25
<link rel="prev" href="man.nsupdate.html" title="nsupdate">
Mark Andrews's avatar
gregen  
Mark Andrews committed
26 27 28 29 30 31 32 33
<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
<tr>
<td width="20%" align="left">
Automatic Updater's avatar
regen  
Automatic Updater committed
34
<a accesskey="p" href="man.nsupdate.html">Prev</a> </td>
Mark Andrews's avatar
gregen  
Mark Andrews committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
<th width="60%" align="center">Manual pages</th>
<td width="20%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="refentry" lang="en">
<a name="man.rndc"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p><span class="application">rndc</span> &#8212; name server control utility</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p><code class="command">rndc</code>  [<code class="option">-b <em class="replaceable"><code>source-address</code></em></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>
</div>
<div class="refsect1" lang="en">
Tinderbox User's avatar
Tinderbox User committed
53
<a name="id2641440"></a><h2>DESCRIPTION</h2>
Mark Andrews's avatar
gregen  
Mark Andrews committed
54 55 56 57 58 59 60 61 62 63 64 65 66
<p><span><strong class="command">rndc</strong></span>
      controls the operation of a name
      server.  It supersedes the <span><strong class="command">ndc</strong></span> utility
      that was provided in old BIND releases.  If
      <span><strong class="command">rndc</strong></span> 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><span><strong class="command">rndc</strong></span>
      communicates with the name server
      over a TCP connection, sending commands authenticated with
      digital signatures.  In the current versions of
Mark Andrews's avatar
regen  
Mark Andrews committed
67
      <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
Mark Andrews's avatar
gregen  
Mark Andrews committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81
      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><span><strong class="command">rndc</strong></span>
      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" lang="en">
Tinderbox User's avatar
Tinderbox User committed
82
<a name="id2641490"></a><h2>OPTIONS</h2>
Mark Andrews's avatar
gregen  
Mark Andrews committed
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
<div class="variablelist"><dl>
<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
<dd><p>
            Use <em class="replaceable"><code>source-address</code></em>
            as the source address for the connection to the server.
            Multiple instances are permitted to allow setting of both
            the IPv4 and IPv6 source addresses.
          </p></dd>
<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
<dd><p>
            Use <em class="replaceable"><code>config-file</code></em>
            as the configuration file instead of the default,
            <code class="filename">/etc/rndc.conf</code>.
          </p></dd>
<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
<dd><p>
            Use <em class="replaceable"><code>key-file</code></em>
            as the key file instead of the default,
            <code class="filename">/etc/rndc.key</code>.  The key in
            <code class="filename">/etc/rndc.key</code> will be used to
            authenticate
            commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
            does not exist.
          </p></dd>
<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
<dd><p><em class="replaceable"><code>server</code></em> is
Mark Andrews's avatar
regen  
Mark Andrews committed
109
            the name or address of the server which matches a
Mark Andrews's avatar
gregen  
Mark Andrews committed
110
            server statement in the configuration file for
Mark Andrews's avatar
regen  
Mark Andrews committed
111
            <span><strong class="command">rndc</strong></span>.  If no server is supplied on the
Mark Andrews's avatar
gregen  
Mark Andrews committed
112
            command line, the host named by the default-server clause
Mark Andrews's avatar
regen  
Mark Andrews committed
113 114
            in the options statement of the <span><strong class="command">rndc</strong></span>
	    configuration file will be used.
Mark Andrews's avatar
gregen  
Mark Andrews committed
115 116 117 118 119 120 121 122 123 124 125 126
          </p></dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
<dd><p>
            Send commands to TCP port
            <em class="replaceable"><code>port</code></em>
            instead
            of BIND 9's default control channel port, 953.
          </p></dd>
<dt><span class="term">-V</span></dt>
<dd><p>
            Enable verbose logging.
          </p></dd>
Mark Andrews's avatar
regen  
Mark Andrews committed
127
<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
Mark Andrews's avatar
gregen  
Mark Andrews committed
128
<dd><p>
Mark Andrews's avatar
regen  
Mark Andrews committed
129
            Use the key <em class="replaceable"><code>key_id</code></em>
Mark Andrews's avatar
gregen  
Mark Andrews committed
130
            from the configuration file.
Mark Andrews's avatar
regen  
Mark Andrews committed
131
            <em class="replaceable"><code>key_id</code></em>
Mark Andrews's avatar
gregen  
Mark Andrews committed
132 133 134
            must be
            known by named with the same algorithm and secret string
            in order for control message validation to succeed.
Mark Andrews's avatar
regen  
Mark Andrews committed
135
            If no <em class="replaceable"><code>key_id</code></em>
Mark Andrews's avatar
gregen  
Mark Andrews committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
            is specified, <span><strong class="command">rndc</strong></span> 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 <span><strong class="command">rndc</strong></span>,
      see the BIND 9 Administrator Reference Manual or run
      <span><strong class="command">rndc</strong></span> without arguments to see its help
      message.
    </p>
</div>
<div class="refsect1" lang="en">
Tinderbox User's avatar
Tinderbox User committed
154
<a name="id2642397"></a><h2>LIMITATIONS</h2>
Mark Andrews's avatar
gregen  
Mark Andrews committed
155 156 157 158 159 160 161 162 163 164 165 166 167
<p><span><strong class="command">rndc</strong></span>
      does not yet support all the commands of
      the BIND 8 <span><strong class="command">ndc</strong></span> utility.
    </p>
<p>
      There is currently no way to provide the shared secret for a
      <code class="option">key_id</code> without using the configuration file.
    </p>
<p>
      Several error messages could be clearer.
    </p>
</div>
<div class="refsect1" lang="en">
Tinderbox User's avatar
Tinderbox User committed
168
<a name="id2642428"></a><h2>SEE ALSO</h2>
Mark Andrews's avatar
gregen  
Mark Andrews committed
169
<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
Mark Andrews's avatar
regen  
Mark Andrews committed
170
      <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
Mark Andrews's avatar
gregen  
Mark Andrews committed
171
      <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
Mark Andrews's avatar
regen  
Mark Andrews committed
172
      <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
Mark Andrews's avatar
gregen  
Mark Andrews committed
173 174 175 176 177
      <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
    </p>
</div>
<div class="refsect1" lang="en">
Tinderbox User's avatar
Tinderbox User committed
178
<a name="id2642484"></a><h2>AUTHOR</h2>
Mark Andrews's avatar
gregen  
Mark Andrews committed
179 180 181 182 183 184 185 186 187
<p><span class="corpauthor">Internet Systems Consortium</span>
    </p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
Automatic Updater's avatar
regen  
Automatic Updater committed
188
<a accesskey="p" href="man.nsupdate.html">Prev</a> </td>
Mark Andrews's avatar
gregen  
Mark Andrews committed
189 190 191 192 193
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
</td>
</tr>
<tr>
Mark Andrews's avatar
regen  
Mark Andrews committed
194
<td width="40%" align="left" valign="top">
Automatic Updater's avatar
regen  
Automatic Updater committed
195
<span class="application">nsupdate</span> </td>
Mark Andrews's avatar
gregen  
Mark Andrews committed
196
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
Mark Andrews's avatar
regen  
Mark Andrews committed
197 198
<td width="40%" align="right" valign="top"> <code class="filename">rndc.conf</code>
</td>
Mark Andrews's avatar
gregen  
Mark Andrews committed
199 200 201 202 203
</tr>
</table>
</div>
</body>
</html>