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