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