man.rndc.html revision 52ece689e0265f9a3e518de5b2539e749f6d35ac
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<!--
70e5a7403f0e0a3bd292b8287c5fed5772c15270Automatic Updater - Copyright (C) 2004-2006 Internet Systems Consortium, Inc. ("ISC")
499b34cea04a46823d003d4c0520c8b03e8513cbBrian Wellington - Copyright (C) 2000-2003 Internet Software Consortium.
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence -
ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater - Permission to use, copy, modify, and distribute this software for any
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington - purpose with or without fee is hereby granted, provided that the above
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington - copyright notice and this permission notice appear in all copies.
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence -
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington-->
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<!-- $Id: man.rndc.html,v 1.27 2006/04/23 10:14:12 marka Exp $ -->
70e5a7403f0e0a3bd292b8287c5fed5772c15270Automatic Updater<html>
9c3531d72aeaad6c5f01efe6a1c82023e1379e4dDavid Lawrence<head>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<title>rndc</title>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<link rel="prev" href="man.named.html" title="named">
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington</head>
90c099e88e9f16bfee9edee3ac1a51fc98843772Brian Wellington<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
90c099e88e9f16bfee9edee3ac1a51fc98843772Brian Wellington<div class="navheader">
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<table width="100%" summary="Navigation header">
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<tr>
28fc90e6c81338c5f34e065fdda49d320e362583Mark Andrews<td width="20%" align="left">
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff<a accesskey="p" href="man.named.html">Prev</a>�</td>
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff<th width="60%" align="center">Manual pages</th>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
dadd8860bbc6ed657ce1d64a7e813a6b7a1a2401Brian Wellington</td>
dadd8860bbc6ed657ce1d64a7e813a6b7a1a2401Brian Wellington</tr>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington</table>
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff<hr>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington</div>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<div class="refentry" lang="en">
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<a name="man.rndc"></a><div class="titlepage"></div>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<div class="refnamediv">
28fc90e6c81338c5f34e065fdda49d320e362583Mark Andrews<h2>Name</h2>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<p><span class="application">rndc</span> &#8212; name server control utility</p>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington</div>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<div class="refsynopsisdiv">
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<h2>Synopsis</h2>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<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>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington</div>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<div class="refsect1" lang="en">
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<a name="id2583804"></a><h2>DESCRIPTION</h2>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<p><span><strong class="command">rndc</strong></span>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington controls the operation of a name
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington server. It supersedes the <span><strong class="command">ndc</strong></span> utility
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein that was provided in old BIND releases. If
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington <span><strong class="command">rndc</strong></span> is invoked with no command line
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington options or arguments, it prints a short summary of the
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington supported commands and the available options and their
45e1bd63587102c3bb361eaca42ee7b714fb3542Mark Andrews arguments.
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington </p>
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington<p><span><strong class="command">rndc</strong></span>
90c099e88e9f16bfee9edee3ac1a51fc98843772Brian Wellington communicates with the name server
90c099e88e9f16bfee9edee3ac1a51fc98843772Brian Wellington over a TCP connection, sending commands authenticated with
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington digital signatures. In the current versions of
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span> named
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff the only supported authentication algorithm is HMAC-MD5,
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff which uses a shared secret on each end of the connection.
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff This provides TSIG-style authentication for the command
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington request and the name server's response. All commands sent
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff over the channel must be signed by a key_id known to the
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff server.
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington </p>
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff<p><span><strong class="command">rndc</strong></span>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein reads a configuration file to
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington determine how to contact the name server and decide what
45e1bd63587102c3bb361eaca42ee7b714fb3542Mark Andrews algorithm and key it should use.
45e1bd63587102c3bb361eaca42ee7b714fb3542Mark Andrews </p>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington</div>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<div class="refsect1" lang="en">
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<a name="id2583854"></a><h2>OPTIONS</h2>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<div class="variablelist"><dl>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<dd><p>
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff Use <em class="replaceable"><code>source-address</code></em>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington as the source address for the connection to the server.
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff Multiple instances are permitted to allow setting of both
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington the IPv4 and IPv6 source addresses.
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington </p></dd>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<dd><p>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington Use <em class="replaceable"><code>config-file</code></em>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington as the configuration file instead of the default,
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington <code class="filename">/etc/rndc.conf</code>.
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington </p></dd>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<dd><p>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington Use <em class="replaceable"><code>key-file</code></em>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington as the key file instead of the default,
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <code class="filename">/etc/rndc.key</code>. The key in
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington <code class="filename">/etc/rndc.key</code> will be used to
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington authenticate
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein does not exist.
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington </p></dd>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington<dd><p><em class="replaceable"><code>server</code></em> is
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington the name or address of the server which matches a
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington server statement in the configuration file for
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington <span><strong class="command">rndc</strong></span>. If no server is supplied on
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington the
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington command line, the host named by the default-server clause
783055c0a61eba5f3a828d1b138155bae575eb14Brian Wellington in the option statement of the configuration file will be
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff used.
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington </p></dd>
4e96d1fc0646de4d879e7a0bc1e7aba449a67596Michael Graff<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington<dd><p>
8a23742754e4640a298acb0d6bd7ed4da0c11798Brian Wellington Send commands to TCP port
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington <em class="replaceable"><code>port</code></em>
878d3073b13833ee1a50dfeabf8e400b6fdfc754Brian Wellington 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="id2584073"></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="id2584172"></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="id2584219"></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>