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