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