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