contrib/bind9/doc/arm/man.rndc.html

   1 <!--
   2  - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and/or distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <!-- $Id$ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>rndc</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  24 <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
  25 <link rel="prev" href="man.nsupdate.html" title="nsupdate">
  26 <link rel="next" href="man.rndc.conf.html" title="rndc.conf">
  27 </head>
  28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  29 <div class="navheader">
  30 <table width="100%" summary="Navigation header">
  31 <tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
  32 <tr>
  33 <td width="20%" align="left">
  34 <a accesskey="p" href="man.nsupdate.html">Prev</a> </td>
  35 <th width="60%" align="center">Manual pages</th>
  36 <td width="20%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
  37 </td>
  38 </tr>
  39 </table>
  40 <hr>
  41 </div>
  42 <div class="refentry" lang="en">
  43 <a name="man.rndc"></a><div class="titlepage"></div>
  44 <div class="refnamediv">
  45 <h2>Name</h2>
  46 <p><span class="application">rndc</span> &#8212; name server control utility</p>
  47 </div>
  48 <div class="refsynopsisdiv">
  49 <h2>Synopsis</h2>
  50 <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>
  51 </div>
  52 <div class="refsect1" lang="en">
  53 <a name="id2638953"></a><h2>DESCRIPTION</h2>
  54 <p><span><strong class="command">rndc</strong></span>
  55       controls the operation of a name
  56       server.  It supersedes the <span><strong class="command">ndc</strong></span> utility
  57       that was provided in old BIND releases.  If
  58       <span><strong class="command">rndc</strong></span> is invoked with no command line
  59       options or arguments, it prints a short summary of the
  60       supported commands and the available options and their
  61       arguments.
  62     </p>
  63 <p><span><strong class="command">rndc</strong></span>
  64       communicates with the name server
  65       over a TCP connection, sending commands authenticated with
  66       digital signatures.  In the current versions of
  67       <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
  68       the only supported authentication algorithm is HMAC-MD5,
  69       which uses a shared secret on each end of the connection.
  70       This provides TSIG-style authentication for the command
  71       request and the name server's response.  All commands sent
  72       over the channel must be signed by a key_id known to the
  73       server.
  74     </p>
  75 <p><span><strong class="command">rndc</strong></span>
  76       reads a configuration file to
  77       determine how to contact the name server and decide what
  78       algorithm and key it should use.
  79     </p>
  80 </div>
  81 <div class="refsect1" lang="en">
  82 <a name="id2639003"></a><h2>OPTIONS</h2>
  83 <div class="variablelist"><dl>
  84 <dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
  85 <dd><p>
  86             Use <em class="replaceable"><code>source-address</code></em>
  87             as the source address for the connection to the server.
  88             Multiple instances are permitted to allow setting of both
  89             the IPv4 and IPv6 source addresses.
  90           </p></dd>
  91 <dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
  92 <dd><p>
  93             Use <em class="replaceable"><code>config-file</code></em>
  94             as the configuration file instead of the default,
  95             <code class="filename">/etc/rndc.conf</code>.
  96           </p></dd>
  97 <dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
  98 <dd><p>
  99             Use <em class="replaceable"><code>key-file</code></em>
 100             as the key file instead of the default,
 101             <code class="filename">/etc/rndc.key</code>.  The key in
 102             <code class="filename">/etc/rndc.key</code> will be used to
 103             authenticate
 104             commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
 105             does not exist.
 106           </p></dd>
 107 <dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
 108 <dd><p><em class="replaceable"><code>server</code></em> is
 109             the name or address of the server which matches a
 110             server statement in the configuration file for
 111             <span><strong class="command">rndc</strong></span>.  If no server is supplied on the
 112             command line, the host named by the default-server clause
 113             in the options statement of the <span><strong class="command">rndc</strong></span>
 114             configuration file will be used.
 115           </p></dd>
 116 <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
 117 <dd><p>
 118             Send commands to TCP port
 119             <em class="replaceable"><code>port</code></em>
 120             instead
 121             of BIND 9's default control channel port, 953.
 122           </p></dd>
 123 <dt><span class="term">-V</span></dt>
 124 <dd><p>
 125             Enable verbose logging.
 126           </p></dd>
 127 <dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
 128 <dd><p>
 129             Use the key <em class="replaceable"><code>key_id</code></em>
 130             from the configuration file.
 131             <em class="replaceable"><code>key_id</code></em>
 132             must be
 133             known by named with the same algorithm and secret string
 134             in order for control message validation to succeed.
 135             If no <em class="replaceable"><code>key_id</code></em>
 136             is specified, <span><strong class="command">rndc</strong></span> will first look
 137             for a key clause in the server statement of the server
 138             being used, or if no server statement is present for that
 139             host, then the default-key clause of the options statement.
 140             Note that the configuration file contains shared secrets
 141             which are used to send authenticated control commands
 142             to name servers.  It should therefore not have general read
 143             or write access.
 144           </p></dd>
 145 </dl></div>
 146 <p>
 147       For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
 148       see the BIND 9 Administrator Reference Manual or run
 149       <span><strong class="command">rndc</strong></span> without arguments to see its help
 150       message.
 151     </p>
 152 </div>
 153 <div class="refsect1" lang="en">
 154 <a name="id2639228"></a><h2>LIMITATIONS</h2>
 155 <p><span><strong class="command">rndc</strong></span>
 156       does not yet support all the commands of
 157       the BIND 8 <span><strong class="command">ndc</strong></span> utility.
 158     </p>
 159 <p>
 160       There is currently no way to provide the shared secret for a
 161       <code class="option">key_id</code> without using the configuration file.
 162     </p>
 163 <p>
 164       Several error messages could be clearer.
 165     </p>
 166 </div>
 167 <div class="refsect1" lang="en">
 168 <a name="id2639259"></a><h2>SEE ALSO</h2>
 169 <p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
 170       <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
 171       <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 172       <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
 173       <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
 174       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 175     </p>
 176 </div>
 177 <div class="refsect1" lang="en">
 178 <a name="id2639315"></a><h2>AUTHOR</h2>
 179 <p><span class="corpauthor">Internet Systems Consortium</span>
 180     </p>
 181 </div>
 182 </div>
 183 <div class="navfooter">
 184 <hr>
 185 <table width="100%" summary="Navigation footer">
 186 <tr>
 187 <td width="40%" align="left">
 188 <a accesskey="p" href="man.nsupdate.html">Prev</a> </td>
 189 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 190 <td width="40%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
 191 </td>
 192 </tr>
 193 <tr>
 194 <td width="40%" align="left" valign="top">
 195 <span class="application">nsupdate</span> </td>
 196 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 197 <td width="40%" align="right" valign="top"> <code class="filename">rndc.conf</code>
 198 </td>
 199 </tr>
 200 </table>
 201 </div>
 202 </body>
 203 </html>