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