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