rndc.html revision c247e3f281613fabe1af362e9f3157e35ebbe52c
98N/A<!--
98N/A - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
98N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
98N/A -
935N/A - Permission to use, copy, modify, and distribute this software for any
98N/A - purpose with or without fee is hereby granted, provided that the above
98N/A - copyright notice and this permission notice appear in all copies.
919N/A -
919N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
919N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
919N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
919N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
919N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
919N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
919N/A - PERFORMANCE OF THIS SOFTWARE.
919N/A-->
919N/A<!-- $Id: rndc.html,v 1.29 2007/05/31 23:28:55 marka Exp $ -->
919N/A<html>
919N/A<head>
919N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
919N/A<title>rndc</title>
919N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
919N/A</head>
919N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
98N/A<a name="man.rndc"></a><div class="titlepage"></div>
98N/A<div class="refnamediv">
98N/A<h2>Name</h2>
235N/A<p><span class="application">rndc</span> &#8212; name server control utility</p>
156N/A</div>
156N/A<div class="refsynopsisdiv">
156N/A<h2>Synopsis</h2>
156N/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>
98N/A</div>
98N/A<div class="refsect1" lang="en">
98N/A<a name="id2543413"></a><h2>DESCRIPTION</h2>
98N/A<p><span><strong class="command">rndc</strong></span>
493N/A controls the operation of a name
493N/A server. It supersedes the <span><strong class="command">ndc</strong></span> utility
98N/A that was provided in old BIND releases. If
911N/A <span><strong class="command">rndc</strong></span> is invoked with no command line
931N/A options or arguments, it prints a short summary of the
931N/A supported commands and the available options and their
911N/A arguments.
98N/A </p>
235N/A<p><span><strong class="command">rndc</strong></span>
493N/A communicates with the name server
98N/A over a TCP connection, sending commands authenticated with
916N/A digital signatures. In the current versions of
916N/A <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
916N/A the only supported authentication algorithm is HMAC-MD5,
916N/A which uses a shared secret on each end of the connection.
98N/A This provides TSIG-style authentication for the command
98N/A request and the name server's response. All commands sent
98N/A over the channel must be signed by a key_id known to the
606N/A server.
98N/A </p>
98N/A<p><span><strong class="command">rndc</strong></span>
98N/A reads a configuration file to
606N/A determine how to contact the name server and decide what
606N/A algorithm and key it should use.
98N/A </p>
493N/A</div>
493N/A<div class="refsect1" lang="en">
493N/A<a name="id2543448"></a><h2>OPTIONS</h2>
98N/A<div class="variablelist"><dl>
98N/A<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
98N/A<dd><p>
98N/A Use <em class="replaceable"><code>source-address</code></em>
908N/A as the source address for the connection to the server.
591N/A Multiple instances are permitted to allow setting of both
493N/A the IPv4 and IPv6 source addresses.
493N/A </p></dd>
493N/A<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
493N/A<dd><p>
493N/A Use <em class="replaceable"><code>config-file</code></em>
493N/A as the configuration file instead of the default,
493N/A <code class="filename">/etc/rndc.conf</code>.
493N/A </p></dd>
493N/A<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
705N/A<dd><p>
493N/A Use <em class="replaceable"><code>key-file</code></em>
557N/A as the key file instead of the default,
557N/A <code class="filename">/etc/rndc.key</code>. The key in
493N/A <code class="filename">/etc/rndc.key</code> will be used to
493N/A authenticate
606N/A commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
606N/A does not exist.
851N/A </p></dd>
851N/A<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
851N/A<dd><p><em class="replaceable"><code>server</code></em> is
851N/A the name or address of the server which matches a
851N/A server statement in the configuration file for
851N/A <span><strong class="command">rndc</strong></span>. If no server is supplied on
851N/A the
98N/A command line, the host named by the default-server clause
591N/A in the option statement of the configuration file will be
910N/A used.
851N/A </p></dd>
591N/A<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
910N/A<dd><p>
910N/A Send commands to TCP port
910N/A <em class="replaceable"><code>port</code></em>
910N/A instead
910N/A of BIND 9's default control channel port, 953.
910N/A </p></dd>
98N/A<dt><span class="term">-V</span></dt>
98N/A<dd><p>
910N/A Enable verbose logging.
910N/A </p></dd>
910N/A<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
98N/A<dd><p>
606N/A Use the key <em class="replaceable"><code>key_id</code></em>
98N/A from the configuration file.
606N/A <em class="replaceable"><code>key_id</code></em>
98N/A must be
591N/A known by named with the same algorithm and secret string
851N/A in order for control message validation to succeed.
111N/A If no <em class="replaceable"><code>key_id</code></em>
111N/A is specified, <span><strong class="command">rndc</strong></span> will first look
111N/A for a key clause in the server statement of the server
111N/A being used, or if no server statement is present for that
111N/A host, then the default-key clause of the options statement.
606N/A Note that the configuration file contains shared secrets
851N/A which are used to send authenticated control commands
851N/A to name servers. It should therefore not have general read
851N/A or write access.
606N/A </p></dd>
98N/A</dl></div>
851N/A<p>
733N/A For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
733N/A see the BIND 9 Administrator Reference Manual or run
733N/A <span><strong class="command">rndc</strong></span> without arguments to see its help
733N/A message.
733N/A </p>
606N/A</div>
851N/A<div class="refsect1" lang="en">
606N/A<a name="id2543652"></a><h2>LIMITATIONS</h2>
98N/A<p><span><strong class="command">rndc</strong></span>
851N/A does not yet support all the commands of
851N/A the BIND 8 <span><strong class="command">ndc</strong></span> utility.
851N/A </p>
851N/A<p>
935N/A There is currently no way to provide the shared secret for a
851N/A <code class="option">key_id</code> without using the configuration file.
851N/A </p>
851N/A<p>
212N/A Several error messages could be clearer.
851N/A </p>
935N/A</div>
606N/A<div class="refsect1" lang="en">
935N/A<a name="id2543678"></a><h2>SEE ALSO</h2>
935N/A<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
935N/A <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
935N/A <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
212N/A <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
98N/A <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
98N/A </p>
98N/A</div>
98N/A<div class="refsect1" lang="en">
182N/A<a name="id2543725"></a><h2>AUTHOR</h2>
98N/A<p><span class="corpauthor">Internet Systems Consortium</span>
908N/A </p>
908N/A</div>
</div></body>
</html>