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