man.rndc.html revision 1d216bfaa764f2b40c57cf61987453c5a6fa9b0a
273e421813f295d65aab512f508e8fb575d997d4gouldtj<!--
273e421813f295d65aab512f508e8fb575d997d4gouldtj - Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
273e421813f295d65aab512f508e8fb575d997d4gouldtj - Copyright (C) 2000-2003 Internet Software Consortium.
273e421813f295d65aab512f508e8fb575d997d4gouldtj -
273e421813f295d65aab512f508e8fb575d997d4gouldtj - Permission to use, copy, modify, and distribute this software for any
273e421813f295d65aab512f508e8fb575d997d4gouldtj - purpose with or without fee is hereby granted, provided that the above
273e421813f295d65aab512f508e8fb575d997d4gouldtj - copyright notice and this permission notice appear in all copies.
273e421813f295d65aab512f508e8fb575d997d4gouldtj -
273e421813f295d65aab512f508e8fb575d997d4gouldtj - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
273e421813f295d65aab512f508e8fb575d997d4gouldtj - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
273e421813f295d65aab512f508e8fb575d997d4gouldtj - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
273e421813f295d65aab512f508e8fb575d997d4gouldtj - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5cf507fca7719ae9280d0a5199e024e920f1284dAlex Valavanis - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
273e421813f295d65aab512f508e8fb575d997d4gouldtj - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
273e421813f295d65aab512f508e8fb575d997d4gouldtj - PERFORMANCE OF THIS SOFTWARE.
273e421813f295d65aab512f508e8fb575d997d4gouldtj-->
273e421813f295d65aab512f508e8fb575d997d4gouldtj<!-- $Id: man.rndc.html,v 1.64 2007/12/14 22:37:22 marka Exp $ -->
273e421813f295d65aab512f508e8fb575d997d4gouldtj<html>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<head>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<title>rndc</title>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<link rel="prev" href="man.named.html" title="named">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
273e421813f295d65aab512f508e8fb575d997d4gouldtj</head>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<div class="navheader">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<table width="100%" summary="Navigation header">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<tr>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<td width="20%" align="left">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<a accesskey="p" href="man.named.html">Prev</a>�</td>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<th width="60%" align="center">Manual pages</th>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
e4a9f366dbcb54f76b8c42869fa6873808132357gouldtj</td>
273e421813f295d65aab512f508e8fb575d997d4gouldtj</tr>
273e421813f295d65aab512f508e8fb575d997d4gouldtj</table>
57e8d5fd57a890842b51a13207e222fcf953816cJazzyNico<hr>
57e8d5fd57a890842b51a13207e222fcf953816cJazzyNico</div>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<div class="refentry" lang="en">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<a name="man.rndc"></a><div class="titlepage"></div>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<div class="refnamediv">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<h2>Name</h2>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<p><span class="application">rndc</span> &#8212; name server control utility</p>
23f5c868ef859f55e8e9be34afe046fc520b689dKris</div>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<div class="refsynopsisdiv">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<h2>Synopsis</h2>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<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>
273e421813f295d65aab512f508e8fb575d997d4gouldtj</div>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<div class="refsect1" lang="en">
273e421813f295d65aab512f508e8fb575d997d4gouldtj<a name="id2603956"></a><h2>DESCRIPTION</h2>
273e421813f295d65aab512f508e8fb575d997d4gouldtj<p><span><strong class="command">rndc</strong></span>
273e421813f295d65aab512f508e8fb575d997d4gouldtj controls the operation of a name
server. It supersedes the <span><strong class="command">ndc</strong></span> utility
that was provided in old BIND releases. If
<span><strong class="command">rndc</strong></span> is invoked with no command line
options or arguments, it prints a short summary of the
supported commands and the available options and their
arguments.
</p>
<p><span><strong class="command">rndc</strong></span>
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>,
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="id2604006"></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 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="id2604299"></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="id2604672"></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="id2604727"></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>