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