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