/contrib/bind9/bin/confgen/ddns-confgen.docbook

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 218 lines · 199 code · 19 blank · 0 comment · 0 complexity · e800ef5c57db763cce0d1c822d010be3 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) 2009 Internet Systems Consortium, Inc. ("ISC")
  6. -
  7. - Permission to use, copy, modify, and/or distribute this software for any
  8. - purpose with or without fee is hereby granted, provided that the above
  9. - copyright notice and this permission notice appear in all copies.
  10. -
  11. - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12. - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13. - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14. - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15. - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16. - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17. - PERFORMANCE OF THIS SOFTWARE.
  18. -->
  19. <!-- $Id: ddns-confgen.docbook,v 1.6 2009/09/18 22:08:55 fdupont Exp $ -->
  20. <refentry id="man.ddns-confgen">
  21. <refentryinfo>
  22. <date>Jan 29, 2009</date>
  23. </refentryinfo>
  24. <refmeta>
  25. <refentrytitle><application>ddns-confgen</application></refentrytitle>
  26. <manvolnum>8</manvolnum>
  27. <refmiscinfo>BIND9</refmiscinfo>
  28. </refmeta>
  29. <refnamediv>
  30. <refname><application>ddns-confgen</application></refname>
  31. <refpurpose>ddns key generation tool</refpurpose>
  32. </refnamediv>
  33. <docinfo>
  34. <copyright>
  35. <year>2009</year>
  36. <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  37. </copyright>
  38. </docinfo>
  39. <refsynopsisdiv>
  40. <cmdsynopsis>
  41. <command>ddns-confgen</command>
  42. <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
  43. <arg><option>-h</option></arg>
  44. <arg><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
  45. <arg><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
  46. <group>
  47. <arg choice="plain">-s <replaceable class="parameter">name</replaceable></arg>
  48. <arg choice="plain">-z <replaceable class="parameter">zone</replaceable></arg>
  49. </group>
  50. <arg><option>-q</option></arg>
  51. <arg choice="opt">name</arg>
  52. </cmdsynopsis>
  53. </refsynopsisdiv>
  54. <refsect1>
  55. <title>DESCRIPTION</title>
  56. <para><command>ddns-confgen</command>
  57. generates a key for use by <command>nsupdate</command>
  58. and <command>named</command>. It simplifies configuration
  59. of dynamic zones by generating a key and providing the
  60. <command>nsupdate</command> and <command>named.conf</command>
  61. syntax that will be needed to use it, including an example
  62. <command>update-policy</command> statement.
  63. </para>
  64. <para>
  65. If a domain name is specified on the command line, it will
  66. be used in the name of the generated key and in the sample
  67. <command>named.conf</command> syntax. For example,
  68. <command>ddns-confgen example.com</command> would
  69. generate a key called "ddns-key.example.com", and sample
  70. <command>named.conf</command> command that could be used
  71. in the zone definition for "example.com".
  72. </para>
  73. <para>
  74. Note that <command>named</command> itself can configure a
  75. local DDNS key for use with <command>nsupdate -l</command>.
  76. <command>ddns-confgen</command> is only needed when a
  77. more elaborate configuration is required: for instance, if
  78. <command>nsupdate</command> is to be used from a remote system.
  79. </para>
  80. </refsect1>
  81. <refsect1>
  82. <title>OPTIONS</title>
  83. <variablelist>
  84. <varlistentry>
  85. <term>-a <replaceable class="parameter">algorithm</replaceable></term>
  86. <listitem>
  87. <para>
  88. Specifies the algorithm to use for the TSIG key. Available
  89. choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
  90. hmac-sha384 and hmac-sha512. The default is hmac-sha256.
  91. </para>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry>
  95. <term>-h</term>
  96. <listitem>
  97. <para>
  98. Prints a short summary of the options and arguments to
  99. <command>ddns-confgen</command>.
  100. </para>
  101. </listitem>
  102. </varlistentry>
  103. <varlistentry>
  104. <term>-k <replaceable class="parameter">keyname</replaceable></term>
  105. <listitem>
  106. <para>
  107. Specifies the key name of the DDNS authentication key.
  108. The default is <constant>ddns-key</constant> when neither
  109. the <option>-s</option> nor <option>-z</option> option is
  110. specified; otherwise, the default
  111. is <constant>ddns-key</constant> as a separate label
  112. followed by the argument of the option, e.g.,
  113. <constant>ddns-key.example.com.</constant>
  114. The key name must have the format of a valid domain name,
  115. consisting of letters, digits, hyphens and periods.
  116. </para>
  117. </listitem>
  118. </varlistentry>
  119. <varlistentry>
  120. <term>-q</term>
  121. <listitem>
  122. <para>
  123. Quiet mode: Print only the key, with no explanatory text or
  124. usage examples.
  125. </para>
  126. </listitem>
  127. </varlistentry>
  128. <varlistentry>
  129. <term>-r <replaceable class="parameter">randomfile</replaceable></term>
  130. <listitem>
  131. <para>
  132. Specifies a source of random data for generating the
  133. authorization. If the operating system does not provide a
  134. <filename>/dev/random</filename> or equivalent device, the
  135. default source of randomness is keyboard input.
  136. <filename>randomdev</filename> specifies the name of a
  137. character device or file containing random data to be used
  138. instead of the default. The special value
  139. <filename>keyboard</filename> indicates that keyboard input
  140. should be used.
  141. </para>
  142. </listitem>
  143. </varlistentry>
  144. <varlistentry>
  145. <term>-s <replaceable class="parameter">name</replaceable></term>
  146. <listitem>
  147. <para>
  148. Single host mode: The example <command>named.conf</command> text
  149. shows how to set an update policy for the specified
  150. <replaceable class="parameter">name</replaceable>
  151. using the "name" nametype.
  152. The default key name is
  153. ddns-key.<replaceable class="parameter">name</replaceable>.
  154. Note that the "self" nametype cannot be used, since
  155. the name to be updated may differ from the key name.
  156. This option cannot be used with the <option>-z</option> option.
  157. </para>
  158. </listitem>
  159. </varlistentry>
  160. <varlistentry>
  161. <term>-z <replaceable class="parameter">zone</replaceable></term>
  162. <listitem>
  163. <para>
  164. zone mode: The example <command>named.conf</command> text
  165. shows how to set an update policy for the specified
  166. <replaceable class="parameter">zone</replaceable>
  167. using the "zonesub" nametype, allowing updates to all subdomain
  168. names within
  169. that <replaceable class="parameter">zone</replaceable>.
  170. This option cannot be used with the <option>-s</option> option.
  171. </para>
  172. </listitem>
  173. </varlistentry>
  174. </variablelist>
  175. </refsect1>
  176. <refsect1>
  177. <title>SEE ALSO</title>
  178. <para><citerefentry>
  179. <refentrytitle>nsupdate</refentrytitle><manvolnum>1</manvolnum>
  180. </citerefentry>,
  181. <citerefentry>
  182. <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
  183. </citerefentry>,
  184. <citerefentry>
  185. <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
  186. </citerefentry>,
  187. <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
  188. </para>
  189. </refsect1>
  190. <refsect1>
  191. <title>AUTHOR</title>
  192. <para><corpauthor>Internet Systems Consortium</corpauthor>
  193. </para>
  194. </refsect1>
  195. </refentry><!--
  196. - Local variables:
  197. - mode: sgml
  198. - End:
  199. -->