man.ddns-confgen.html 8.41 KB
Newer Older
1
<!--
Automatic Updater's avatar
regen  
Automatic Updater committed
2 3 4
 - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
 - Copyright (C) 2000-2003 Internet Software Consortium.
 - 
Automatic Updater's avatar
regen  
Automatic Updater committed
5
 - Permission to use, copy, modify, and/or distribute this software for any
6 7
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
Automatic Updater's avatar
regen  
Automatic Updater committed
8
 - 
9 10
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
Automatic Updater's avatar
regen  
Automatic Updater committed
11
 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 13 14 15 16
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->
Automatic Updater's avatar
regen  
Automatic Updater committed
17
<!-- $Id: man.ddns-confgen.html,v 1.15 2009/08/27 01:14:39 tbox Exp $ -->
18 19 20 21
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>ddns-confgen</title>
Automatic Updater's avatar
regen  
Automatic Updater committed
22
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="man.rndc-confgen.html">Prev</a> </td>
<th width="60%" align="center">Manual pages</th>
<td width="20%" align="right"> </td>
</tr>
</table>
<hr>
</div>
<div class="refentry" lang="en">
<a name="man.ddns-confgen"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
Automatic Updater's avatar
regen  
Automatic Updater committed
48
<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>
49 50
</div>
<div class="refsect1" lang="en">
Automatic Updater's avatar
regen  
Automatic Updater committed
51
<a name="id2636567"></a><h2>DESCRIPTION</h2>
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
<p><span><strong class="command">ddns-confgen</strong></span>
      generates a key for use by <span><strong class="command">nsupdate</strong></span>
      and <span><strong class="command">named</strong></span>.  It simplifies configuration
      of dynamic zones by generating a key and providing the
      <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
      syntax that will be needed to use it, including an example
      <span><strong class="command">update-policy</strong></span> statement.
    </p>
<p>
      If a domain name is specified on the command line, it will
      be used in the name of the generated key and in the sample
      <span><strong class="command">named.conf</strong></span> syntax.  For example,
      <span><strong class="command">ddns-confgen example.com</strong></span> would
      generate a key called "ddns-key.example.com", and sample
      <span><strong class="command">named.conf</strong></span> command that could be used
      in the zone definition for "example.com".
    </p>
<p>
      Note that <span><strong class="command">named</strong></span> itself can configure a
      local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
      <span><strong class="command">ddns-confgen</strong></span> is only needed when a 
      more elaborate configuration is required: for instance, if
      <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
    </p>
</div>
<div class="refsect1" lang="en">
Automatic Updater's avatar
regen  
Automatic Updater committed
78
<a name="id2636654"></a><h2>OPTIONS</h2>
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
<div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd><p>
            Specifies the algorithm to use for the TSIG key.  Available
            choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
            hmac-sha384 and hmac-sha512.  The default is hmac-sha256.
	  </p></dd>
<dt><span class="term">-h</span></dt>
<dd><p>
	    Prints a short summary of the options and arguments to
	    <span><strong class="command">ddns-confgen</strong></span>.
	  </p></dd>
<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
<dd><p>
	    Specifies the key name of the DDNS authentication key.
Automatic Updater's avatar
regen  
Automatic Updater committed
94
	    The default is <code class="constant">ddns-key</code> when neither
Automatic Updater's avatar
regen  
Automatic Updater committed
95
	    the <code class="option">-s</code> nor <code class="option">-z</code> option is
Automatic Updater's avatar
regen  
Automatic Updater committed
96 97 98 99
	    specified; otherwise, the default
	    is <code class="constant">ddns-key</code> as a separate label
	    followed by the argument of the option, e.g.,
	    <code class="constant">ddns-key.example.com.</code>
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
	    The key name must have the format of a valid domain name,
	    consisting of letters, digits, hyphens and periods.
	  </p></dd>
<dt><span class="term">-q</span></dt>
<dd><p>
	    Quiet mode:  Print only the key, with no explanatory text or
            usage examples.
	  </p></dd>
<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
<dd><p>
            Specifies a source of random data for generating the
            authorization.  If the operating system does not provide a
            <code class="filename">/dev/random</code> or equivalent device, the
            default source of randomness is keyboard input.
            <code class="filename">randomdev</code> specifies the name of a
            character device or file containing random data to be used
            instead of the default.  The special value
            <code class="filename">keyboard</code> indicates that keyboard input
            should be used.
	  </p></dd>
Automatic Updater's avatar
regen  
Automatic Updater committed
120
<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
121
<dd><p>
Automatic Updater's avatar
regen  
Automatic Updater committed
122 123
	    Single host mode: The example <span><strong class="command">named.conf</strong></span> text
	    shows how to set an update policy for the specified
Automatic Updater's avatar
regen  
Automatic Updater committed
124
	    <em class="replaceable"><code>name</code></em>
Automatic Updater's avatar
regen  
Automatic Updater committed
125 126 127 128 129 130
	    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.
Automatic Updater's avatar
regen  
Automatic Updater committed
131 132 133 134 135 136 137 138 139
	  </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>.
Automatic Updater's avatar
regen  
Automatic Updater committed
140
	    This option cannot be used with the <code class="option">-s</code> option.
141 142 143 144
	  </p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
Automatic Updater's avatar
regen  
Automatic Updater committed
145
<a name="id2636923"></a><h2>SEE ALSO</h2>
146 147 148 149 150 151 152
<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">
Automatic Updater's avatar
regen  
Automatic Updater committed
153
<a name="id2636962"></a><h2>AUTHOR</h2>
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
<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>