man.rndc.html revision 1acf72525e7e0b41074593495dc5351485903569
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!--
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
bef75d63d74f58abc0f834ed271526672777ba29Automatic Updater -
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
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - copyright notice and this permission notice appear in all copies.
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt -
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - PERFORMANCE OF THIS SOFTWARE.
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt-->
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<!-- $Id: man.rndc.html,v 1.97 2008/10/22 01:11:41 tbox Exp $ -->
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<html>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<head>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<title>rndc</title>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<link rel="prev" href="man.nsupdate.html" title="nsupdate">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</head>
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="navheader">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<table width="100%" summary="Navigation header">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<tr>
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt<td width="20%" align="left">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<th width="60%" align="center">Manual pages</th>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</tr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</table>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<hr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refentry" lang="en">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a name="man.rndc"></a><div class="titlepage"></div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refnamediv">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<h2>Name</h2>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<p><span class="application">rndc</span> &#8212; name server control utility</p>
e1263b4b9c16f5ecd7640be046b1e1a5c592c1e0Automatic Updater</div>
e1263b4b9c16f5ecd7640be046b1e1a5c592c1e0Automatic Updater<div class="refsynopsisdiv">
e1263b4b9c16f5ecd7640be046b1e1a5c592c1e0Automatic Updater<h2>Synopsis</h2>
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt<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>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refsect1" lang="en">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="id2609611"></a><h2>DESCRIPTION</h2>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span><strong class="command">rndc</strong></span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User controls the operation of a name
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User server. It supersedes the <span><strong class="command">ndc</strong></span> utility
e1263b4b9c16f5ecd7640be046b1e1a5c592c1e0Automatic Updater that was provided in old BIND releases. If
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">rndc</strong></span> is invoked with no command line
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User options or arguments, it prints a short summary of the
e1263b4b9c16f5ecd7640be046b1e1a5c592c1e0Automatic Updater supported commands and the available options and their
e1263b4b9c16f5ecd7640be046b1e1a5c592c1e0Automatic Updater arguments.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p><span><strong class="command">rndc</strong></span>
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt communicates with the name server
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User over a TCP connection, sending commands authenticated with
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User digital signatures. In the current versions of
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User the only supported authentication algorithm is HMAC-MD5,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User which uses a shared secret on each end of the connection.
cb3c295308f7a3acfc748e60231ca05183e4393cAutomatic Updater This provides TSIG-style authentication for the command
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User request and the name server's response. All commands sent
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User over the channel must be signed by a key_id known to the
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt server.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p><span><strong class="command">rndc</strong></span>
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt reads a configuration file to
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User determine how to contact the name server and decide what
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User algorithm and key it should use.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refsect1" lang="en">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="id2609661"></a><h2>OPTIONS</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="variablelist"><dl>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dd><p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Use <em class="replaceable"><code>source-address</code></em>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User as the source address for the connection to the server.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Multiple instances are permitted to allow setting of both
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt the IPv4 and IPv6 source addresses.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p></dd>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt<dd><p>
ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt 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
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 options statement of the <span><strong class="command">rndc</strong></span>
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>key_id</code></em></span></dt>
<dd><p>
Use the key <em class="replaceable"><code>key_id</code></em>
from the configuration file.
<em class="replaceable"><code>key_id</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>key_id</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="id2610433"></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="id2610464"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
<span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</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="id2610519"></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.nsupdate.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">nsupdate</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>