contrib/bind9/bin/rndc/rndc.html

   1 <!--
   2  - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000, 2001 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and 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: rndc.html,v 1.8.18.19 2007/01/30 00:23:44 marka Exp $ -->
  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 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25 <a name="man.rndc"></a><div class="titlepage"></div>
  26 <div class="refnamediv">
  27 <h2>Name</h2>
  28 <p><span class="application">rndc</span> &#8212; name server control utility</p>
  29 </div>
  30 <div class="refsynopsisdiv">
  31 <h2>Synopsis</h2>
  32 <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>
  33 </div>
  34 <div class="refsect1" lang="en">
  35 <a name="id2543413"></a><h2>DESCRIPTION</h2>
  36 <p><span><strong class="command">rndc</strong></span>
  37       controls the operation of a name
  38       server.  It supersedes the <span><strong class="command">ndc</strong></span> utility
  39       that was provided in old BIND releases.  If
  40       <span><strong class="command">rndc</strong></span> is invoked with no command line
  41       options or arguments, it prints a short summary of the
  42       supported commands and the available options and their
  43       arguments.
  44     </p>
  45 <p><span><strong class="command">rndc</strong></span>
  46       communicates with the name server
  47       over a TCP connection, sending commands authenticated with
  48       digital signatures.  In the current versions of
  49       <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span> named
  50       the only supported authentication algorithm is HMAC-MD5,
  51       which uses a shared secret on each end of the connection.
  52       This provides TSIG-style authentication for the command
  53       request and the name server's response.  All commands sent
  54       over the channel must be signed by a key_id known to the
  55       server.
  56     </p>
  57 <p><span><strong class="command">rndc</strong></span>
  58       reads a configuration file to
  59       determine how to contact the name server and decide what
  60       algorithm and key it should use.
  61     </p>
  62 </div>
  63 <div class="refsect1" lang="en">
  64 <a name="id2543448"></a><h2>OPTIONS</h2>
  65 <div class="variablelist"><dl>
  66 <dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
  67 <dd><p>
  68             Use <em class="replaceable"><code>source-address</code></em>
  69             as the source address for the connection to the server.
  70             Multiple instances are permitted to allow setting of both
  71             the IPv4 and IPv6 source addresses.
  72           </p></dd>
  73 <dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
  74 <dd><p>
  75             Use <em class="replaceable"><code>config-file</code></em>
  76             as the configuration file instead of the default,
  77             <code class="filename">/etc/rndc.conf</code>.
  78           </p></dd>
  79 <dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
  80 <dd><p>
  81             Use <em class="replaceable"><code>key-file</code></em>
  82             as the key file instead of the default,
  83             <code class="filename">/etc/rndc.key</code>.  The key in
  84             <code class="filename">/etc/rndc.key</code> will be used to
  85             authenticate
  86             commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
  87             does not exist.
  88           </p></dd>
  89 <dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
  90 <dd><p><em class="replaceable"><code>server</code></em> is
  91                        the name or address of the server which matches a
  92             server statement in the configuration file for
  93             <span><strong class="command">rndc</strong></span>.  If no server is supplied on
  94             the
  95             command line, the host named by the default-server clause
  96             in the option statement of the configuration file will be
  97             used.
  98           </p></dd>
  99 <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
 100 <dd><p>
 101             Send commands to TCP port
 102             <em class="replaceable"><code>port</code></em>
 103             instead
 104             of BIND 9's default control channel port, 953.
 105           </p></dd>
 106 <dt><span class="term">-V</span></dt>
 107 <dd><p>
 108             Enable verbose logging.
 109           </p></dd>
 110 <dt><span class="term">-y <em class="replaceable"><code>keyid</code></em></span></dt>
 111 <dd><p>
 112             Use the key <em class="replaceable"><code>keyid</code></em>
 113             from the configuration file.
 114             <em class="replaceable"><code>keyid</code></em>
 115             must be
 116             known by named with the same algorithm and secret string
 117             in order for control message validation to succeed.
 118             If no <em class="replaceable"><code>keyid</code></em>
 119             is specified, <span><strong class="command">rndc</strong></span> will first look
 120             for a key clause in the server statement of the server
 121             being used, or if no server statement is present for that
 122             host, then the default-key clause of the options statement.
 123             Note that the configuration file contains shared secrets
 124             which are used to send authenticated control commands
 125             to name servers.  It should therefore not have general read
 126             or write access.
 127           </p></dd>
 128 </dl></div>
 129 <p>
 130       For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
 131       see the BIND 9 Administrator Reference Manual or run
 132       <span><strong class="command">rndc</strong></span> without arguments to see its help
 133       message.
 134     </p>
 135 </div>
 136 <div class="refsect1" lang="en">
 137 <a name="id2543652"></a><h2>LIMITATIONS</h2>
 138 <p><span><strong class="command">rndc</strong></span>
 139       does not yet support all the commands of
 140       the BIND 8 <span><strong class="command">ndc</strong></span> utility.
 141     </p>
 142 <p>
 143       There is currently no way to provide the shared secret for a
 144       <code class="option">key_id</code> without using the configuration file.
 145     </p>
 146 <p>
 147       Several error messages could be clearer.
 148     </p>
 149 </div>
 150 <div class="refsect1" lang="en">
 151 <a name="id2543678"></a><h2>SEE ALSO</h2>
 152 <p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
 153       <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 154       <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>
 155       <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
 156       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 157     </p>
 158 </div>
 159 <div class="refsect1" lang="en">
 160 <a name="id2543725"></a><h2>AUTHOR</h2>
 161 <p><span class="corpauthor">Internet Systems Consortium</span>
 162     </p>
 163 </div>
 164 </div></body>
 165 </html>