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