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