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