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