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