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