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