man.rndc.html revision 24e79a68e1b16324e17364fcd8959379ff6e20e9
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
c7ef13f6c9ef4436bc804b150e0a93307b11fa27Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
a5636b773fa05a272b6876afd99309c0b3090e2fMark Andrews - Permission to use, copy, modify, and distribute this software for any
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User - purpose with or without fee is hereby granted, provided that the above
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User - copyright notice and this permission notice appear in all copies.
5e047890ac9b745db060d95f7d1b4f876511240dTinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
137fdbc214e99c4cbe57551e9e14f2015c2e42aeTinderbox User - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
bed0874e1a09e810575328c4bfc346a47514b69fMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
02b47c5d62e1e827743684c28a08e871da454a2dMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User - PERFORMANCE OF THIS SOFTWARE.
e20309353e6246485c521278131d3fced73d7957Tinderbox User<!-- $Id: man.rndc.html,v 1.70 2008/02/18 12:53:14 marka Exp $ -->
3cc98b8ecedcbc8465f1cf2740b966b315662430Automatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
e20309353e6246485c521278131d3fced73d7957Tinderbox User<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
e20309353e6246485c521278131d3fced73d7957Tinderbox User<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<link rel="prev" href="man.named.html" title="named">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<table width="100%" summary="Navigation header">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<a accesskey="p" href="man.named.html">Prev</a>�</td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<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>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User<a name="man.rndc"></a><div class="titlepage"></div>
e130ab53e992670e2a2ecf043976ac09f21358d1Automatic Updater<p><span class="application">rndc</span> — name server control utility</p>
24934f08b9ff81c2be711e566e8002d145573031Tinderbox User<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>
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User<p><span><strong class="command">rndc</strong></span>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt controls the operation of a name
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User server. It supersedes the <span><strong class="command">ndc</strong></span> utility
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater that was provided in old BIND releases. If
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">rndc</strong></span> is invoked with no command line
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater options or arguments, it prints a short summary of the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews supported commands and the available options and their
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<p><span><strong class="command">rndc</strong></span>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews communicates with the name server
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews over a TCP connection, sending commands authenticated with
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater digital signatures. In the current versions of
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews 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>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews reads a configuration file to
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews determine how to contact the name server and decide what
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User algorithm and key it should use.
7feccf248d2a20a2ae48b290f58ded5abc853e9aTinderbox User<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
ad411d8ccf8a27eb903b842ab507ba6729d0246bTinderbox User Use <em class="replaceable"><code>source-address</code></em>
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater as the source address for the connection to the server.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Multiple instances are permitted to allow setting of both
ad411d8ccf8a27eb903b842ab507ba6729d0246bTinderbox User the IPv4 and IPv6 source addresses.
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark Andrews<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Use <em class="replaceable"><code>config-file</code></em>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews as the configuration file instead of the default,
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <code class="filename">/etc/rndc.conf</code>.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews Use <em class="replaceable"><code>key-file</code></em>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews as the key file instead of the default,
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews <code class="filename">/etc/rndc.key</code>. The key in
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <code class="filename">/etc/rndc.key</code> will be used to
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews authenticate
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews does not exist.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<dd><p><em class="replaceable"><code>server</code></em> is
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews the name or address of the server which matches a
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews server statement in the configuration file for
0eb371ca0dab50ae3462e98794a6126198c52f4bMark 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
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews in the options statement of the <span><strong class="command">rndc</strong></span>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews configuration file will be used.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark Andrews Send commands to TCP port
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User of BIND 9's default control channel port, 953.
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark Andrews Enable verbose logging.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User Use the key <em class="replaceable"><code>key_id</code></em>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont from the configuration file.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <em class="replaceable"><code>key_id</code></em>
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User known by named with the same algorithm and secret string
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews in order for control message validation to succeed.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews If no <em class="replaceable"><code>key_id</code></em>
bed0874e1a09e810575328c4bfc346a47514b69fMark Andrews is specified, <span><strong class="command">rndc</strong></span> will first look
24bf1e02f03577db0feb50b80238c4150c96d05dAutomatic Updater for a key clause in the server statement of the server
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews being used, or if no server statement is present for that
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews host, then the default-key clause of the options statement.
2ba8f584b97cbab864570e38fd26b8cb90961428Tinderbox User Note that the configuration file contains shared secrets
a308b69ac66fadf66863484f301314d6e6a3f1d2Automatic Updater which are used to send authenticated control commands
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews to name servers. It should therefore not have general read
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews or write access.
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews see the BIND 9 Administrator Reference Manual or run
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews <span><strong class="command">rndc</strong></span> without arguments to see its help
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater<a name="id2604368"></a><h2>LIMITATIONS</h2>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<p><span><strong class="command">rndc</strong></span>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews does not yet support all the commands of
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews the BIND 8 <span><strong class="command">ndc</strong></span> utility.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews There is currently no way to provide the shared secret for a
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <code class="option">key_id</code> without using the configuration file.
e16b482740c5e7ad4c27e271fa829b957cdf67d4Mark Andrews Several error messages could be clearer.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<p><span class="corpauthor">Internet Systems Consortium</span>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<table width="100%" summary="Navigation footer">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<a accesskey="p" href="man.named.html">Prev</a>�</td>
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<td width="40%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<span class="application">named</span>�</td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<td width="40%" align="right" valign="top">�<code class="filename">rndc.conf</code>