/contrib/bind9/bin/rndc/rndc.docbook

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 253 lines · 232 code · 21 blank · 0 comment · 0 complexity · 778db76ff70cf682b4185a13769ec6f9 MD5 · raw file

  1. <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  2. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
  3. [<!ENTITY mdash "&#8212;">]>
  4. <!--
  5. - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
  6. - Copyright (C) 2000, 2001 Internet Software Consortium.
  7. -
  8. - Permission to use, copy, modify, and/or distribute this software for any
  9. - purpose with or without fee is hereby granted, provided that the above
  10. - copyright notice and this permission notice appear in all copies.
  11. -
  12. - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13. - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14. - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15. - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16. - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17. - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18. - PERFORMANCE OF THIS SOFTWARE.
  19. -->
  20. <!-- $Id: rndc.docbook,v 1.21 2007/12/14 20:39:14 marka Exp $ -->
  21. <refentry id="man.rndc">
  22. <refentryinfo>
  23. <date>June 30, 2000</date>
  24. </refentryinfo>
  25. <refmeta>
  26. <refentrytitle><application>rndc</application></refentrytitle>
  27. <manvolnum>8</manvolnum>
  28. <refmiscinfo>BIND9</refmiscinfo>
  29. </refmeta>
  30. <refnamediv>
  31. <refname><application>rndc</application></refname>
  32. <refpurpose>name server control utility</refpurpose>
  33. </refnamediv>
  34. <docinfo>
  35. <copyright>
  36. <year>2004</year>
  37. <year>2005</year>
  38. <year>2007</year>
  39. <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  40. </copyright>
  41. <copyright>
  42. <year>2000</year>
  43. <year>2001</year>
  44. <holder>Internet Software Consortium.</holder>
  45. </copyright>
  46. </docinfo>
  47. <refsynopsisdiv>
  48. <cmdsynopsis>
  49. <command>rndc</command>
  50. <arg><option>-b <replaceable class="parameter">source-address</replaceable></option></arg>
  51. <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
  52. <arg><option>-k <replaceable class="parameter">key-file</replaceable></option></arg>
  53. <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg>
  54. <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
  55. <arg><option>-V</option></arg>
  56. <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg>
  57. <arg choice="req">command</arg>
  58. </cmdsynopsis>
  59. </refsynopsisdiv>
  60. <refsect1>
  61. <title>DESCRIPTION</title>
  62. <para><command>rndc</command>
  63. controls the operation of a name
  64. server. It supersedes the <command>ndc</command> utility
  65. that was provided in old BIND releases. If
  66. <command>rndc</command> is invoked with no command line
  67. options or arguments, it prints a short summary of the
  68. supported commands and the available options and their
  69. arguments.
  70. </para>
  71. <para><command>rndc</command>
  72. communicates with the name server
  73. over a TCP connection, sending commands authenticated with
  74. digital signatures. In the current versions of
  75. <command>rndc</command> and <command>named</command>,
  76. the only supported authentication algorithm is HMAC-MD5,
  77. which uses a shared secret on each end of the connection.
  78. This provides TSIG-style authentication for the command
  79. request and the name server's response. All commands sent
  80. over the channel must be signed by a key_id known to the
  81. server.
  82. </para>
  83. <para><command>rndc</command>
  84. reads a configuration file to
  85. determine how to contact the name server and decide what
  86. algorithm and key it should use.
  87. </para>
  88. </refsect1>
  89. <refsect1>
  90. <title>OPTIONS</title>
  91. <variablelist>
  92. <varlistentry>
  93. <term>-b <replaceable class="parameter">source-address</replaceable></term>
  94. <listitem>
  95. <para>
  96. Use <replaceable class="parameter">source-address</replaceable>
  97. as the source address for the connection to the server.
  98. Multiple instances are permitted to allow setting of both
  99. the IPv4 and IPv6 source addresses.
  100. </para>
  101. </listitem>
  102. </varlistentry>
  103. <varlistentry>
  104. <term>-c <replaceable class="parameter">config-file</replaceable></term>
  105. <listitem>
  106. <para>
  107. Use <replaceable class="parameter">config-file</replaceable>
  108. as the configuration file instead of the default,
  109. <filename>/etc/rndc.conf</filename>.
  110. </para>
  111. </listitem>
  112. </varlistentry>
  113. <varlistentry>
  114. <term>-k <replaceable class="parameter">key-file</replaceable></term>
  115. <listitem>
  116. <para>
  117. Use <replaceable class="parameter">key-file</replaceable>
  118. as the key file instead of the default,
  119. <filename>/etc/rndc.key</filename>. The key in
  120. <filename>/etc/rndc.key</filename> will be used to
  121. authenticate
  122. commands sent to the server if the <replaceable class="parameter">config-file</replaceable>
  123. does not exist.
  124. </para>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry>
  128. <term>-s <replaceable class="parameter">server</replaceable></term>
  129. <listitem>
  130. <para><replaceable class="parameter">server</replaceable> is
  131. the name or address of the server which matches a
  132. server statement in the configuration file for
  133. <command>rndc</command>. If no server is supplied on the
  134. command line, the host named by the default-server clause
  135. in the options statement of the <command>rndc</command>
  136. configuration file will be used.
  137. </para>
  138. </listitem>
  139. </varlistentry>
  140. <varlistentry>
  141. <term>-p <replaceable class="parameter">port</replaceable></term>
  142. <listitem>
  143. <para>
  144. Send commands to TCP port
  145. <replaceable class="parameter">port</replaceable>
  146. instead
  147. of BIND 9's default control channel port, 953.
  148. </para>
  149. </listitem>
  150. </varlistentry>
  151. <varlistentry>
  152. <term>-V</term>
  153. <listitem>
  154. <para>
  155. Enable verbose logging.
  156. </para>
  157. </listitem>
  158. </varlistentry>
  159. <varlistentry>
  160. <term>-y <replaceable class="parameter">key_id</replaceable></term>
  161. <listitem>
  162. <para>
  163. Use the key <replaceable class="parameter">key_id</replaceable>
  164. from the configuration file.
  165. <replaceable class="parameter">key_id</replaceable>
  166. must be
  167. known by named with the same algorithm and secret string
  168. in order for control message validation to succeed.
  169. If no <replaceable class="parameter">key_id</replaceable>
  170. is specified, <command>rndc</command> will first look
  171. for a key clause in the server statement of the server
  172. being used, or if no server statement is present for that
  173. host, then the default-key clause of the options statement.
  174. Note that the configuration file contains shared secrets
  175. which are used to send authenticated control commands
  176. to name servers. It should therefore not have general read
  177. or write access.
  178. </para>
  179. </listitem>
  180. </varlistentry>
  181. </variablelist>
  182. <para>
  183. For the complete set of commands supported by <command>rndc</command>,
  184. see the BIND 9 Administrator Reference Manual or run
  185. <command>rndc</command> without arguments to see its help
  186. message.
  187. </para>
  188. </refsect1>
  189. <refsect1>
  190. <title>LIMITATIONS</title>
  191. <para><command>rndc</command>
  192. does not yet support all the commands of
  193. the BIND 8 <command>ndc</command> utility.
  194. </para>
  195. <para>
  196. There is currently no way to provide the shared secret for a
  197. <option>key_id</option> without using the configuration file.
  198. </para>
  199. <para>
  200. Several error messages could be clearer.
  201. </para>
  202. </refsect1>
  203. <refsect1>
  204. <title>SEE ALSO</title>
  205. <para><citerefentry>
  206. <refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum>
  207. </citerefentry>,
  208. <citerefentry>
  209. <refentrytitle>rndc-confgen</refentrytitle><manvolnum>8</manvolnum>
  210. </citerefentry>,
  211. <citerefentry>
  212. <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
  213. </citerefentry>,
  214. <citerefentry>
  215. <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
  216. </citerefentry>,
  217. <citerefentry>
  218. <refentrytitle>ndc</refentrytitle><manvolnum>8</manvolnum>
  219. </citerefentry>,
  220. <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
  221. </para>
  222. </refsect1>
  223. <refsect1>
  224. <title>AUTHOR</title>
  225. <para><corpauthor>Internet Systems Consortium</corpauthor>
  226. </para>
  227. </refsect1>
  228. </refentry><!--
  229. - Local variables:
  230. - mode: sgml
  231. - End:
  232. -->