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