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

https://bitbucket.org/freebsd/freebsd-head/ · HTML · 203 lines · 186 code · 0 blank · 17 comment · 0 complexity · ab3854b567b7b954bce4a85e865777f9 MD5 · raw file 

    

  1. <!--
    2. 

  2.  - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
    3. 

  3.  - Copyright (C) 2000-2003 Internet Software Consortium.
    4. 

  4.  - 
    5. 

  5.  - Permission to use, copy, modify, and/or distribute this software for any
    6. 

  6.  - purpose with or without fee is hereby granted, provided that the above
    7. 

  7.  - copyright notice and this permission notice appear in all copies.
    8. 

  8.  - 
    9. 

  9.  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
    10. 

  10.  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
    11. 

  11.  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
    12. 

  12.  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
    13. 

  13.  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
    14. 

  14.  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
    15. 

  15.  - PERFORMANCE OF THIS SOFTWARE.
    16. 

  16. -->
    17. 

  17. <!-- $Id$ -->
    18. 

  18. <html>
    19. 

  19. <head>
    20. 

  20. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
    21. 

  21. <title>rndc</title>
    22. 

  22. <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
    23. 

  23. <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
    24. 

  24. <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
    25. 

  25. <link rel="prev" href="man.nsupdate.html" title="nsupdate">
    26. 

  26. <link rel="next" href="man.rndc.conf.html" title="rndc.conf">
    27. 

  27. </head>
    28. 

  28. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    29. 

  29. <div class="navheader">
    30. 

  30. <table width="100%" summary="Navigation header">
    31. 

  31. <tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
    32. 

  32. <tr>
    33. 

  33. <td width="20%" align="left">
    34. 

  34. <a accesskey="p" href="man.nsupdate.html">Prev</a> </td>
    35. 

  35. <th width="60%" align="center">Manual pages</th>
    36. 

  36. <td width="20%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
    37. 

  37. </td>
    38. 

  38. </tr>
    39. 

  39. </table>
    40. 

  40. <hr>
    41. 

  41. </div>
    42. 

  42. <div class="refentry" lang="en">
    43. 

  43. <a name="man.rndc"></a><div class="titlepage"></div>
    44. 

  44. <div class="refnamediv">
    45. 

  45. <h2>Name</h2>
    46. 

  46. <p><span class="application">rndc</span> &#8212; name server control utility</p>
    47. 

  47. </div>
    48. 

  48. <div class="refsynopsisdiv">
    49. 

  49. <h2>Synopsis</h2>
    50. 

  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. 

  51. </div>
    52. 

  52. <div class="refsect1" lang="en">
    53. 

  53. <a name="id2640665"></a><h2>DESCRIPTION</h2>
    54. 

  54. <p><span><strong class="command">rndc</strong></span>
    55. 

  55.       controls the operation of a name
    56. 

  56.       server.  It supersedes the <span><strong class="command">ndc</strong></span> utility
    57. 

  57.       that was provided in old BIND releases.  If
    58. 

  58.       <span><strong class="command">rndc</strong></span> is invoked with no command line
    59. 

  59.       options or arguments, it prints a short summary of the
    60. 

  60.       supported commands and the available options and their
    61. 

  61.       arguments.
    62. 

  62.     </p>
    63. 

  63. <p><span><strong class="command">rndc</strong></span>
    64. 

  64.       communicates with the name server
    65. 

  65.       over a TCP connection, sending commands authenticated with
    66. 

  66.       digital signatures.  In the current versions of
    67. 

  67.       <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
    68. 

  68.       the only supported authentication algorithm is HMAC-MD5,
    69. 

  69.       which uses a shared secret on each end of the connection.
    70. 

  70.       This provides TSIG-style authentication for the command
    71. 

  71.       request and the name server's response.  All commands sent
    72. 

  72.       over the channel must be signed by a key_id known to the
    73. 

  73.       server.
    74. 

  74.     </p>
    75. 

  75. <p><span><strong class="command">rndc</strong></span>
    76. 

  76.       reads a configuration file to
    77. 

  77.       determine how to contact the name server and decide what
    78. 

  78.       algorithm and key it should use.
    79. 

  79.     </p>
    80. 

  80. </div>
    81. 

  81. <div class="refsect1" lang="en">
    82. 

  82. <a name="id2640715"></a><h2>OPTIONS</h2>
    83. 

  83. <div class="variablelist"><dl>
    84. 

  84. <dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
    85. 

  85. <dd><p>
    86. 

  86.             Use <em class="replaceable"><code>source-address</code></em>
    87. 

  87.             as the source address for the connection to the server.
    88. 

  88.             Multiple instances are permitted to allow setting of both
    89. 

  89.             the IPv4 and IPv6 source addresses.
    90. 

  90.           </p></dd>
    91. 

  91. <dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
    92. 

  92. <dd><p>
    93. 

  93.             Use <em class="replaceable"><code>config-file</code></em>
    94. 

  94.             as the configuration file instead of the default,
    95. 

  95.             <code class="filename">/etc/rndc.conf</code>.
    96. 

  96.           </p></dd>
    97. 

  97. <dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
    98. 

  98. <dd><p>
    99. 

  99.             Use <em class="replaceable"><code>key-file</code></em>
    100. 

  100.             as the key file instead of the default,
    101. 

  101.             <code class="filename">/etc/rndc.key</code>.  The key in
    102. 

  102.             <code class="filename">/etc/rndc.key</code> will be used to
    103. 

  103.             authenticate
    104. 

  104.             commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
    105. 

  105.             does not exist.
    106. 

  106.           </p></dd>
    107. 

  107. <dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
    108. 

  108. <dd><p><em class="replaceable"><code>server</code></em> is
    109. 

  109.             the name or address of the server which matches a
    110. 

  110.             server statement in the configuration file for
    111. 

  111.             <span><strong class="command">rndc</strong></span>.  If no server is supplied on the
    112. 

  112.             command line, the host named by the default-server clause
    113. 

  113.             in the options statement of the <span><strong class="command">rndc</strong></span>
    114. 

  114. 	    configuration file will be used.
    115. 

  115.           </p></dd>
    116. 

  116. <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
    117. 

  117. <dd><p>
    118. 

  118.             Send commands to TCP port
    119. 

  119.             <em class="replaceable"><code>port</code></em>
    120. 

  120.             instead
    121. 

  121.             of BIND 9's default control channel port, 953.
    122. 

  122.           </p></dd>
    123. 

  123. <dt><span class="term">-V</span></dt>
    124. 

  124. <dd><p>
    125. 

  125.             Enable verbose logging.
    126. 

  126.           </p></dd>
    127. 

  127. <dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
    128. 

  128. <dd><p>
    129. 

  129.             Use the key <em class="replaceable"><code>key_id</code></em>
    130. 

  130.             from the configuration file.
    131. 

  131.             <em class="replaceable"><code>key_id</code></em>
    132. 

  132.             must be
    133. 

  133.             known by named with the same algorithm and secret string
    134. 

  134.             in order for control message validation to succeed.
    135. 

  135.             If no <em class="replaceable"><code>key_id</code></em>
    136. 

  136.             is specified, <span><strong class="command">rndc</strong></span> will first look
    137. 

  137.             for a key clause in the server statement of the server
    138. 

  138.             being used, or if no server statement is present for that
    139. 

  139.             host, then the default-key clause of the options statement.
    140. 

  140.             Note that the configuration file contains shared secrets
    141. 

  141.             which are used to send authenticated control commands
    142. 

  142.             to name servers.  It should therefore not have general read
    143. 

  143.             or write access.
    144. 

  144.           </p></dd>
    145. 

  145. </dl></div>
    146. 

  146. <p>
    147. 

  147.       For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
    148. 

  148.       see the BIND 9 Administrator Reference Manual or run
    149. 

  149.       <span><strong class="command">rndc</strong></span> without arguments to see its help
    150. 

  150.       message.
    151. 

  151.     </p>
    152. 

  152. </div>
    153. 

  153. <div class="refsect1" lang="en">
    154. 

  154. <a name="id2640940"></a><h2>LIMITATIONS</h2>
    155. 

  155. <p><span><strong class="command">rndc</strong></span>
    156. 

  156.       does not yet support all the commands of
    157. 

  157.       the BIND 8 <span><strong class="command">ndc</strong></span> utility.
    158. 

  158.     </p>
    159. 

  159. <p>
    160. 

  160.       There is currently no way to provide the shared secret for a
    161. 

  161.       <code class="option">key_id</code> without using the configuration file.
    162. 

  162.     </p>
    163. 

  163. <p>
    164. 

  164.       Several error messages could be clearer.
    165. 

  165.     </p>
    166. 

  166. </div>
    167. 

  167. <div class="refsect1" lang="en">
    168. 

  168. <a name="id2640971"></a><h2>SEE ALSO</h2>
    169. 

  169. <p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
    170. 

  170.       <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
    171. 

  171.       <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
    172. 

  172.       <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
    173. 

  173.       <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
    174. 

  174.       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
    175. 

  175.     </p>
    176. 

  176. </div>
    177. 

  177. <div class="refsect1" lang="en">
    178. 

  178. <a name="id2641027"></a><h2>AUTHOR</h2>
    179. 

  179. <p><span class="corpauthor">Internet Systems Consortium</span>
    180. 

  180.     </p>
    181. 

  181. </div>
    182. 

  182. </div>
    183. 

  183. <div class="navfooter">
    184. 

  184. <hr>
    185. 

  185. <table width="100%" summary="Navigation footer">
    186. 

  186. <tr>
    187. 

  187. <td width="40%" align="left">
    188. 

  188. <a accesskey="p" href="man.nsupdate.html">Prev</a> </td>
    189. 

  189. <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
    190. 

  190. <td width="40%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
    191. 

  191. </td>
    192. 

  192. </tr>
    193. 

  193. <tr>
    194. 

  194. <td width="40%" align="left" valign="top">
    195. 

  195. <span class="application">nsupdate</span> </td>
    196. 

  196. <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
    197. 

  197. <td width="40%" align="right" valign="top"> <code class="filename">rndc.conf</code>
    198. 

  198. </td>
    199. 

  199. </tr>
    200. 

  200. </table>
    201. 

  201. </div>
    202. 

  202. </body>
    203. 

  203. </html>
    204.