ddns-confgen.docbook revision 45d4d69a8d662b6a00e3723c5488af40174a63cb
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt [<!ENTITY mdash "&#8212;">]>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt<!--
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt -
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - Permission to use, copy, modify, and/or distribute this software for any
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - purpose with or without fee is hereby granted, provided that the above
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - copyright notice and this permission notice appear in all copies.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt -
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - PERFORMANCE OF THIS SOFTWARE.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt-->
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉<!-- $Id: ddns-confgen.docbook,v 1.4 2009/06/16 22:36:53 jinmei Exp $ -->
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt<refentry id="man.ddns-confgen">
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentryinfo>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <date>Jan 29, 2009</date>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refentryinfo>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refmeta>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle><application>ddns-confgen</application></refentrytitle>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <manvolnum>8</manvolnum>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refmiscinfo>BIND9</refmiscinfo>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refmeta>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refnamediv>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refname><application>ddns-confgen</application></refname>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refpurpose>ddns key generation tool</refpurpose>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refnamediv>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <docinfo>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <copyright>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <year>2009</year>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </copyright>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </docinfo>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refsynopsisdiv>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <cmdsynopsis>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>ddns-confgen</command>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <arg><option>-h</option></arg>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <arg><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <arg><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <arg><option>-s name | -z zone</option></arg>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <arg><option>-q</option></arg>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <arg choice="opt">name</arg>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </cmdsynopsis>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refsynopsisdiv>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <title>DESCRIPTION</title>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para><command>ddns-confgen</command>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt generates a key for use by <command>nsupdate</command>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt and <command>named</command>. It simplifies configuration
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt of dynamic zones by generating a key and providing the
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>nsupdate</command> and <command>named.conf</command>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt syntax that will be needed to use it, including an example
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>update-policy</command> statement.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt If a domain name is specified on the command line, it will
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt be used in the name of the generated key and in the sample
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>named.conf</command> syntax. For example,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>ddns-confgen example.com</command> would
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt generate a key called "ddns-key.example.com", and sample
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>named.conf</command> command that could be used
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt in the zone definition for "example.com".
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Note that <command>named</command> itself can configure a
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt local DDNS key for use with <command>nsupdate -l</command>.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>ddns-confgen</command> is only needed when a
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt more elaborate configuration is required: for instance, if
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>nsupdate</command> is to be used from a remote system.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <title>OPTIONS</title>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <variablelist>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-a <replaceable class="parameter">algorithm</replaceable></term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Specifies the algorithm to use for the TSIG key. Available
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt hmac-sha384 and hmac-sha512. The default is hmac-sha256.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-h</term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Prints a short summary of the options and arguments to
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>ddns-confgen</command>.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-k <replaceable class="parameter">keyname</replaceable></term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Specifies the key name of the DDNS authentication key.
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 The default is <constant>ddns-key</constant> when neither
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 the <command>-s</command> nor <command>-z</command> option is
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 specified; otherwise, the default
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 is <constant>ddns-key</constant> as a separate label
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 followed by the argument of the option, e.g.,
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <constant>ddns-key.example.com.</constant>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt The key name must have the format of a valid domain name,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt consisting of letters, digits, hyphens and periods.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-q</term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Quiet mode: Print only the key, with no explanatory text or
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt usage examples.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-r <replaceable class="parameter">randomfile</replaceable></term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Specifies a source of random data for generating the
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt authorization. If the operating system does not provide a
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <filename>/dev/random</filename> or equivalent device, the
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt default source of randomness is keyboard input.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <filename>randomdev</filename> specifies the name of a
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt character device or file containing random data to be used
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt instead of the default. The special value
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <filename>keyboard</filename> indicates that keyboard input
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt should be used.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <term>-s <replaceable class="parameter">name</replaceable></term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Self mode: The example <command>named.conf</command> text
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 shows how to set an update policy for the specified
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <replaceable class="parameter">name</replaceable>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 using the "self" nametype, instead of the "subdomain"
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 nametype which allows matching on any name within a
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 specified domain.
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 This option cannot be used with the <command>-z</command> option.
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 </para>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 </listitem>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 </varlistentry>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <varlistentry>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <term>-z <replaceable class="parameter">zone</replaceable></term>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <listitem>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <para>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 zone mode: The example <command>named.conf</command> text
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 shows how to set an update policy for the specified
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <replaceable class="parameter">zone</replaceable>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 using the "zonesub" nametype, allowing updates to all subdomain
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 names within
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 that <replaceable class="parameter">zone</replaceable>.
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 This option cannot be used with the <command>-s</command> option.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </listitem>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </variablelist>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <title>SEE ALSO</title>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para><citerefentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle>nsupdate</refentrytitle><manvolnum>1</manvolnum>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </citerefentry>,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <citerefentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </citerefentry>,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <citerefentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </citerefentry>,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <title>AUTHOR</title>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <para><corpauthor>Internet Systems Consortium</corpauthor>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </para>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refsect1>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt</refentry><!--
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - Local variables:
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - mode: sgml
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - End:
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt-->