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