man.rndc.html revision b0e8629055a766d4555a005a283c2889a5974945
1fb011b1db93ca25396756ec5e3621d75b39812dTinderbox User - Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2000-2003 Internet Software Consortium.
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and distribute this software for any
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - purpose with or without fee is hereby granted, provided that the above
689023771c563d8660e45d439a207e06e96de28fMark Andrews - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- $Id: man.rndc.html,v 1.41 2007/01/30 00:25:00 marka Exp $ -->
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<link rel="prev" href="man.named.html" title="named">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.named.html">Prev</a>�</td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a name="man.rndc"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">rndc</span> — name server control utility</p>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span><strong class="command">rndc</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein controls the operation of a name
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server. It supersedes the <span><strong class="command">ndc</strong></span> utility
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein that was provided in old BIND releases. If
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">rndc</strong></span> is invoked with no command line
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User options or arguments, it prints a short summary of the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User supported commands and the available options and their
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span><strong class="command">rndc</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein communicates with the name server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein over a TCP connection, sending commands authenticated with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein digital signatures. In the current versions of
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span> named
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User the only supported authentication algorithm is HMAC-MD5,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User which uses a shared secret on each end of the connection.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User This provides TSIG-style authentication for the command
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein request and the name server's response. All commands sent
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein over the channel must be signed by a key_id known to the
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews<p><span><strong class="command">rndc</strong></span>
88a2182a1ad4fc7af07272af6b05b74db7f28e52Tinderbox User reads a configuration file to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein determine how to contact the name server and decide what
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm and key it should use.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use <em class="replaceable"><code>source-address</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein as the source address for the connection to the server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Multiple instances are permitted to allow setting of both
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the IPv4 and IPv6 source addresses.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Use <em class="replaceable"><code>config-file</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein as the configuration file instead of the default,
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User <code class="filename">/etc/rndc.conf</code>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Use <em class="replaceable"><code>key-file</code></em>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User as the key file instead of the default,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <code class="filename">/etc/rndc.key</code>. The key in
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater <code class="filename">/etc/rndc.key</code> will be used to
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater does not exist.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dd><p><em class="replaceable"><code>server</code></em> is
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User the name or address of the server which matches a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server statement in the configuration file for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">rndc</strong></span>. If no server is supplied on
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein command line, the host named by the default-server clause
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in the option statement of the configuration file will be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Send commands to TCP port
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <em class="replaceable"><code>port</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of BIND 9's default control channel port, 953.
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews Enable verbose logging.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-y <em class="replaceable"><code>keyid</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use the key <em class="replaceable"><code>keyid</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein from the configuration file.
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews <em class="replaceable"><code>keyid</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein known by named with the same algorithm and secret string
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in order for control message validation to succeed.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User If no <em class="replaceable"><code>keyid</code></em>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User is specified, <span><strong class="command">rndc</strong></span> will first look
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User for a key clause in the server statement of the server
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User being used, or if no server statement is present for that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein host, then the default-key clause of the options statement.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note that the configuration file contains shared secrets
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein which are used to send authenticated control commands
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews to name servers. It should therefore not have general read
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or write access.
fc74b733bf679e1b3fb1599e32d445dffe325208Tinderbox User For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein see the BIND 9 Administrator Reference Manual or run
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">rndc</strong></span> without arguments to see its help
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span><strong class="command">rndc</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein does not yet support all the commands of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the BIND 8 <span><strong class="command">ndc</strong></span> utility.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein There is currently no way to provide the shared secret for a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">key_id</code> without using the configuration file.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Several error messages could be clearer.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="corpauthor">Internet Systems Consortium</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.named.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
517ae3de96aaf870049c52f1224e38a85fe7f21aAutomatic Updater<td width="40%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right" valign="top">�<code class="filename">rndc.conf</code>