ddns-confgen.html revision 2cbb4ab75757fbb656997a82c14ca07db37d481a
305N/A<!--
305N/A - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
305N/A -
305N/A - Permission to use, copy, modify, and distribute this software for any
305N/A - purpose with or without fee is hereby granted, provided that the above
305N/A - copyright notice and this permission notice appear in all copies.
305N/A -
305N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
305N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
305N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
305N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
305N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
305N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
305N/A - PERFORMANCE OF THIS SOFTWARE.
305N/A-->
305N/A<!-- $Id: ddns-confgen.html,v 1.8 2009/07/04 01:13:18 tbox Exp $ -->
305N/A<html>
305N/A<head>
305N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
305N/A<title>ddns-confgen</title>
305N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
305N/A</head>
844N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
305N/A<a name="man.ddns-confgen"></a><div class="titlepage"></div>
305N/A<div class="refnamediv">
305N/A<h2>Name</h2>
305N/A<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
305N/A</div>
305N/A<div class="refsynopsisdiv">
615N/A<h2>Synopsis</h2>
586N/A<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>
618N/A</div>
586N/A<div class="refsect1" lang="en">
305N/A<a name="id2543377"></a><h2>DESCRIPTION</h2>
844N/A<p><span><strong class="command">ddns-confgen</strong></span>
844N/A generates a key for use by <span><strong class="command">nsupdate</strong></span>
305N/A and <span><strong class="command">named</strong></span>. It simplifies configuration
305N/A of dynamic zones by generating a key and providing the
305N/A <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
305N/A syntax that will be needed to use it, including an example
305N/A <span><strong class="command">update-policy</strong></span> statement.
305N/A </p>
305N/A<p>
844N/A If a domain name is specified on the command line, it will
844N/A be used in the name of the generated key and in the sample
305N/A <span><strong class="command">named.conf</strong></span> syntax. For example,
305N/A <span><strong class="command">ddns-confgen example.com</strong></span> would
305N/A generate a key called "ddns-key.example.com", and sample
305N/A <span><strong class="command">named.conf</strong></span> command that could be used
305N/A in the zone definition for "example.com".
305N/A </p>
305N/A<p>
305N/A Note that <span><strong class="command">named</strong></span> itself can configure a
305N/A local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
305N/A <span><strong class="command">ddns-confgen</strong></span> is only needed when a
615N/A more elaborate configuration is required: for instance, if
305N/A <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
305N/A </p>
455N/A</div>
455N/A<div class="refsect1" lang="en">
305N/A<a name="id2543436"></a><h2>OPTIONS</h2>
305N/A<div class="variablelist"><dl>
305N/A<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
305N/A<dd><p>
305N/A Specifies the algorithm to use for the TSIG key. Available
305N/A choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
305N/A hmac-sha384 and hmac-sha512. The default is hmac-sha256.
305N/A </p></dd>
305N/A<dt><span class="term">-h</span></dt>
305N/A<dd><p>
305N/A Prints a short summary of the options and arguments to
305N/A <span><strong class="command">ddns-confgen</strong></span>.
305N/A </p></dd>
305N/A<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
437N/A<dd><p>
305N/A Specifies the key name of the DDNS authentication key.
305N/A The default is <code class="constant">ddns-key</code> when neither
305N/A the <code class="option">-s</code> nor <code class="option">-z</code> option is
305N/A specified; otherwise, the default
305N/A is <code class="constant">ddns-key</code> as a separate label
305N/A followed by the argument of the option, e.g.,
305N/A <code class="constant">ddns-key.example.com.</code>
305N/A The key name must have the format of a valid domain name,
305N/A consisting of letters, digits, hyphens and periods.
305N/A </p></dd>
305N/A<dt><span class="term">-q</span></dt>
305N/A<dd><p>
305N/A Quiet mode: Print only the key, with no explanatory text or
305N/A usage examples.
305N/A </p></dd>
305N/A<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
305N/A<dd><p>
305N/A Specifies a source of random data for generating the
305N/A authorization. If the operating system does not provide a
305N/A <code class="filename">/dev/random</code> or equivalent device, the
305N/A default source of randomness is keyboard input.
305N/A <code class="filename">randomdev</code> specifies the name of a
305N/A character device or file containing random data to be used
305N/A instead of the default. The special value
305N/A <code class="filename">keyboard</code> indicates that keyboard input
305N/A should be used.
305N/A </p></dd>
<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
<dd><p>
Single host mode: The example <span><strong class="command">named.conf</strong></span> text
shows how to set an update policy for the specified
<em class="replaceable"><code>name</code></em>
using the "name" nametype.
The default key name is
ddns-key.<em class="replaceable"><code>name</code></em>.
Note that the "self" nametype cannot be used, since
the name to be updated may differ from the key name.
This option cannot be used with the <code class="option">-z</code> option.
</p></dd>
<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
<dd><p>
zone mode: The example <span><strong class="command">named.conf</strong></span> text
shows how to set an update policy for the specified
<em class="replaceable"><code>zone</code></em>
using the "zonesub" nametype, allowing updates to all subdomain
names within
that <em class="replaceable"><code>zone</code></em>.
This option cannot be used with the <code class="option">-s</code> option.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2543624"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
<span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
<span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2543662"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div></body>
</html>