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