man.ddns-confgen.html revision 7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65e
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - Copyright (C) 2000-2003 Internet Software Consortium.
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - Permission to use, copy, modify, and distribute this software for any
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - purpose with or without fee is hereby granted, provided that the above
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - copyright notice and this permission notice appear in all copies.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - PERFORMANCE OF THIS SOFTWARE.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<!-- $Id: man.ddns-confgen.html,v 1.5 2009/06/17 01:12:48 tbox Exp $ -->
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<a name="man.ddns-confgen"></a><div class="titlepage"></div>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<div class="cmdsynopsis"><p><code class="command">ddns-confgen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s name | -z zone</code>] [<code class="option">-q</code>] [name]</p></div>
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<a name="id2634550"></a><h2>DESCRIPTION</h2>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><span><strong class="command">ddns-confgen</strong></span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt generates a key for use by <span><strong class="command">nsupdate</strong></span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt and <span><strong class="command">named</strong></span>. It simplifies configuration
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt of dynamic zones by generating a key and providing the
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt syntax that will be needed to use it, including an example
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">update-policy</strong></span> statement.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt If a domain name is specified on the command line, it will
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt be used in the name of the generated key and in the sample
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">named.conf</strong></span> syntax. For example,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">ddns-confgen example.com</strong></span> would
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt generate a key called "ddns-key.example.com", and sample
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">named.conf</strong></span> command that could be used
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt in the zone definition for "example.com".
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Note that <span><strong class="command">named</strong></span> itself can configure a
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">ddns-confgen</strong></span> is only needed when a
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt more elaborate configuration is required: for instance, if
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Specifies the algorithm to use for the TSIG key. Available
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt hmac-sha384 and hmac-sha512. The default is hmac-sha256.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Prints a short summary of the options and arguments to
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">ddns-confgen</strong></span>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Specifies the key name of the DDNS authentication key.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater The default is <code class="constant">ddns-key</code> when neither
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater the <span><strong class="command">-s</strong></span> nor <span><strong class="command">-z</strong></span> option is
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater specified; otherwise, the default
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater is <code class="constant">ddns-key</code> as a separate label
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater followed by the argument of the option, e.g.,
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater <code class="constant">ddns-key.example.com.</code>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt The key name must have the format of a valid domain name,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt consisting of letters, digits, hyphens and periods.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Quiet mode: Print only the key, with no explanatory text or
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt usage examples.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Specifies a source of random data for generating the
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt authorization. If the operating system does not provide a
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <code class="filename">/dev/random</code> or equivalent device, the
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt default source of randomness is keyboard input.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <code class="filename">randomdev</code> specifies the name of a
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt character device or file containing random data to be used
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt instead of the default. The special value
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <code class="filename">keyboard</code> indicates that keyboard input
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt should be used.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Self mode: The example <span><strong class="command">named.conf</strong></span> text
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater shows how to set an update policy for the specified
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater <em class="replaceable"><code>name</code></em>
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater using the "self" nametype, instead of the "subdomain"
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater nametype which allows matching on any name within a
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater specified domain.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater This option cannot be used with the <span><strong class="command">-z</strong></span> option.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater zone mode: The example <span><strong class="command">named.conf</strong></span> text
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater shows how to set an update policy for the specified
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater <em class="replaceable"><code>zone</code></em>
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater using the "zonesub" nametype, allowing updates to all subdomain
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater that <em class="replaceable"><code>zone</code></em>.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater This option cannot be used with the <span><strong class="command">-s</strong></span> option.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><span class="corpauthor">Internet Systems Consortium</span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<span class="application">rndc-confgen</span>�</td>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>