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