man.rndc.html revision 4abdfc917e6635a7c81d1f931a0c79227e72d025
fec509a05ddbf645268fe2e537314def7d1b67c8gm<!--
fec509a05ddbf645268fe2e537314def7d1b67c8gm - Copyright (C) 2004-2006 Internet Systems Consortium, Inc. ("ISC")
fec509a05ddbf645268fe2e537314def7d1b67c8gm - Copyright (C) 2000-2003 Internet Software Consortium.
fec509a05ddbf645268fe2e537314def7d1b67c8gm -
fec509a05ddbf645268fe2e537314def7d1b67c8gm - Permission to use, copy, modify, and distribute this software for any
fec509a05ddbf645268fe2e537314def7d1b67c8gm - purpose with or without fee is hereby granted, provided that the above
fec509a05ddbf645268fe2e537314def7d1b67c8gm - copyright notice and this permission notice appear in all copies.
fec509a05ddbf645268fe2e537314def7d1b67c8gm -
fec509a05ddbf645268fe2e537314def7d1b67c8gm - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
fec509a05ddbf645268fe2e537314def7d1b67c8gm - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
fec509a05ddbf645268fe2e537314def7d1b67c8gm - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
fec509a05ddbf645268fe2e537314def7d1b67c8gm - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fec509a05ddbf645268fe2e537314def7d1b67c8gm - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
fec509a05ddbf645268fe2e537314def7d1b67c8gm - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
fec509a05ddbf645268fe2e537314def7d1b67c8gm - PERFORMANCE OF THIS SOFTWARE.
fec509a05ddbf645268fe2e537314def7d1b67c8gm-->
fec509a05ddbf645268fe2e537314def7d1b67c8gm<!-- $Id: man.rndc.html,v 1.40 2007/01/26 23:29:04 marka Exp $ -->
fec509a05ddbf645268fe2e537314def7d1b67c8gm<html>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<head>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<title>rndc</title>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
32e0ab73531b6e6e8957e9ecdbbd42603865f2d0Misaki Miyashita<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<link rel="prev" href="man.named.html" title="named">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
fec509a05ddbf645268fe2e537314def7d1b67c8gm</head>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<div class="navheader">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<table width="100%" summary="Navigation header">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<tr>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<td width="20%" align="left">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<a accesskey="p" href="man.named.html">Prev</a>�</td>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<th width="60%" align="center">Manual pages</th>
fe54a78e1aacf39261ad56e9903bce02e3fb6d21Hai-May Chao<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
fec509a05ddbf645268fe2e537314def7d1b67c8gm</td>
fec509a05ddbf645268fe2e537314def7d1b67c8gm</tr>
fec509a05ddbf645268fe2e537314def7d1b67c8gm</table>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<hr>
fec509a05ddbf645268fe2e537314def7d1b67c8gm</div>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<div class="refentry" lang="en">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<a name="man.rndc"></a><div class="titlepage"></div>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<div class="refnamediv">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<h2>Name</h2>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<p><span class="application">rndc</span> &#8212; name server control utility</p>
fec509a05ddbf645268fe2e537314def7d1b67c8gm</div>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<div class="refsynopsisdiv">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<h2>Synopsis</h2>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<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>
fec509a05ddbf645268fe2e537314def7d1b67c8gm</div>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<div class="refsect1" lang="en">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<a name="id2603850"></a><h2>DESCRIPTION</h2>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<p><span><strong class="command">rndc</strong></span>
fec509a05ddbf645268fe2e537314def7d1b67c8gm controls the operation of a name
fec509a05ddbf645268fe2e537314def7d1b67c8gm server. It supersedes the <span><strong class="command">ndc</strong></span> utility
fec509a05ddbf645268fe2e537314def7d1b67c8gm that was provided in old BIND releases. If
fec509a05ddbf645268fe2e537314def7d1b67c8gm <span><strong class="command">rndc</strong></span> is invoked with no command line
fec509a05ddbf645268fe2e537314def7d1b67c8gm options or arguments, it prints a short summary of the
fec509a05ddbf645268fe2e537314def7d1b67c8gm supported commands and the available options and their
fec509a05ddbf645268fe2e537314def7d1b67c8gm arguments.
fec509a05ddbf645268fe2e537314def7d1b67c8gm </p>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<p><span><strong class="command">rndc</strong></span>
fec509a05ddbf645268fe2e537314def7d1b67c8gm communicates with the name server
fec509a05ddbf645268fe2e537314def7d1b67c8gm over a TCP connection, sending commands authenticated with
fec509a05ddbf645268fe2e537314def7d1b67c8gm digital signatures. In the current versions of
fec509a05ddbf645268fe2e537314def7d1b67c8gm <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span> named
fec509a05ddbf645268fe2e537314def7d1b67c8gm the only supported authentication algorithm is HMAC-MD5,
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe which uses a shared secret on each end of the connection.
fe54a78e1aacf39261ad56e9903bce02e3fb6d21Hai-May Chao This provides TSIG-style authentication for the command
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe request and the name server's response. All commands sent
fe54a78e1aacf39261ad56e9903bce02e3fb6d21Hai-May Chao over the channel must be signed by a key_id known to the
fe54a78e1aacf39261ad56e9903bce02e3fb6d21Hai-May Chao server.
fe54a78e1aacf39261ad56e9903bce02e3fb6d21Hai-May Chao </p>
fe54a78e1aacf39261ad56e9903bce02e3fb6d21Hai-May Chao<p><span><strong class="command">rndc</strong></span>
fe54a78e1aacf39261ad56e9903bce02e3fb6d21Hai-May Chao reads a configuration file to
fec509a05ddbf645268fe2e537314def7d1b67c8gm determine how to contact the name server and decide what
fec509a05ddbf645268fe2e537314def7d1b67c8gm algorithm and key it should use.
fec509a05ddbf645268fe2e537314def7d1b67c8gm </p>
fec509a05ddbf645268fe2e537314def7d1b67c8gm</div>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<div class="refsect1" lang="en">
fec509a05ddbf645268fe2e537314def7d1b67c8gm<a name="id2603969"></a><h2>OPTIONS</h2>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<div class="variablelist"><dl>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<dd><p>
fec509a05ddbf645268fe2e537314def7d1b67c8gm Use <em class="replaceable"><code>source-address</code></em>
fec509a05ddbf645268fe2e537314def7d1b67c8gm as the source address for the connection to the server.
fec509a05ddbf645268fe2e537314def7d1b67c8gm Multiple instances are permitted to allow setting of both
fec509a05ddbf645268fe2e537314def7d1b67c8gm the IPv4 and IPv6 source addresses.
fec509a05ddbf645268fe2e537314def7d1b67c8gm </p></dd>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<dd><p>
fec509a05ddbf645268fe2e537314def7d1b67c8gm Use <em class="replaceable"><code>config-file</code></em>
fec509a05ddbf645268fe2e537314def7d1b67c8gm as the configuration file instead of the default,
fec509a05ddbf645268fe2e537314def7d1b67c8gm <code class="filename">/etc/rndc.conf</code>.
fec509a05ddbf645268fe2e537314def7d1b67c8gm </p></dd>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
fec509a05ddbf645268fe2e537314def7d1b67c8gm<dd><p>
fec509a05ddbf645268fe2e537314def7d1b67c8gm Use <em class="replaceable"><code>key-file</code></em>
fec509a05ddbf645268fe2e537314def7d1b67c8gm as the key file instead of the default,
fec509a05ddbf645268fe2e537314def7d1b67c8gm <code class="filename">/etc/rndc.key</code>. The key in
fec509a05ddbf645268fe2e537314def7d1b67c8gm <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
the name or address of the server which matches a
server statement in the configuration file for
<span><strong class="command">rndc</strong></span>. 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><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>
<dt><span class="term">-y <em class="replaceable"><code>keyid</code></em></span></dt>
<dd><p>
Use the key <em class="replaceable"><code>keyid</code></em>
from the configuration file.
<em class="replaceable"><code>keyid</code></em>
must be
known by named with the same algorithm and secret string
in order for control message validation to succeed.
If no <em class="replaceable"><code>keyid</code></em>
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">
<a name="id2604802"></a><h2>LIMITATIONS</h2>
<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">
<a name="id2604833"></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>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2604880"></a><h2>AUTHOR</h2>
<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">
<a accesskey="p" href="man.named.html">Prev</a>�</td>
<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>
<td width="40%" align="left" valign="top">
<span class="application">named</span>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<code class="filename">rndc.conf</code>
</td>
</tr>
</table>
</div>
</body>
</html>