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