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