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