contrib/bind9/bin/confgen/ddns-confgen.8

   1 .\" Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
   2 .\"
   3 .\" Permission to use, copy, modify, and/or distribute this software for any
   4 .\" purpose with or without fee is hereby granted, provided that the above
   5 .\" copyright notice and this permission notice appear in all copies.
   6 .\"
   7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   8 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
   9 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  10 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  11 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  12 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  13 .\" PERFORMANCE OF THIS SOFTWARE.
  14 .\"
  15 .\" $Id$
  16 .\"
  17 .hy 0
  18 .ad l
  19 .\"     Title: ddns\-confgen
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  22 .\"      Date: Jan 29, 2009
  23 .\"    Manual: BIND9
  24 .\"    Source: BIND9
  25 .\"
  26 .TH "DDNS\-CONFGEN" "8" "Jan 29, 2009" "BIND9" "BIND9"
  27 .\" disable hyphenation
  28 .nh
  29 .\" disable justification (adjust text to left margin only)
  30 .ad l
  31 .SH "NAME"
  32 ddns\-confgen \- ddns key generation tool
  33 .SH "SYNOPSIS"
  34 .HP 13
  35 \fBddns\-confgen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\-s\ \fIname\fR | \-z\ \fIzone\fR] [\fB\-q\fR] [name]
  36 .SH "DESCRIPTION"
  37 .PP
  38 \fBddns\-confgen\fR
  39 generates a key for use by
  40 \fBnsupdate\fR
  41 and
  42 \fBnamed\fR. It simplifies configuration of dynamic zones by generating a key and providing the
  43 \fBnsupdate\fR
  44 and
  45 \fBnamed.conf\fR
  46 syntax that will be needed to use it, including an example
  47 \fBupdate\-policy\fR
  48 statement.
  49 .PP
  50 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
  51 \fBnamed.conf\fR
  52 syntax. For example,
  53 \fBddns\-confgen example.com\fR
  54 would generate a key called "ddns\-key.example.com", and sample
  55 \fBnamed.conf\fR
  56 command that could be used in the zone definition for "example.com".
  57 .PP
  58 Note that
  59 \fBnamed\fR
  60 itself can configure a local DDNS key for use with
  61 \fBnsupdate \-l\fR.
  62 \fBddns\-confgen\fR
  63 is only needed when a more elaborate configuration is required: for instance, if
  64 \fBnsupdate\fR
  65 is to be used from a remote system.
  66 .SH "OPTIONS"
  67 .PP
  68 \-a \fIalgorithm\fR
  69 .RS 4
  70 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.
  71 .RE
  72 .PP
  73 \-h
  74 .RS 4
  75 Prints a short summary of the options and arguments to
  76 \fBddns\-confgen\fR.
  77 .RE
  78 .PP
  79 \-k \fIkeyname\fR
  80 .RS 4
  81 Specifies the key name of the DDNS authentication key. The default is
  82 \fBddns\-key\fR
  83 when neither the
  84 \fB\-s\fR
  85 nor
  86 \fB\-z\fR
  87 option is specified; otherwise, the default is
  88 \fBddns\-key\fR
  89 as a separate label followed by the argument of the option, e.g.,
  90 \fBddns\-key.example.com.\fR
  91 The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods.
  92 .RE
  93 .PP
  94 \-q
  95 .RS 4
  96 Quiet mode: Print only the key, with no explanatory text or usage examples.
  97 .RE
  98 .PP
  99 \-r \fIrandomfile\fR
 100 .RS 4
 101 Specifies a source of random data for generating the authorization. If the operating system does not provide a
 102 \fI/dev/random\fR
 103 or equivalent device, the default source of randomness is keyboard input.
 104 \fIrandomdev\fR
 105 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 106 \fIkeyboard\fR
 107 indicates that keyboard input should be used.
 108 .RE
 109 .PP
 110 \-s \fIname\fR
 111 .RS 4
 112 Single host mode: The example
 113 \fBnamed.conf\fR
 114 text shows how to set an update policy for the specified
 115 \fIname\fR
 116 using the "name" nametype. The default key name is ddns\-key.\fIname\fR. 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
 117 \fB\-z\fR
 118 option.
 119 .RE
 120 .PP
 121 \-z \fIzone\fR
 122 .RS 4
 123 zone mode: The example
 124 \fBnamed.conf\fR
 125 text shows how to set an update policy for the specified
 126 \fIzone\fR
 127 using the "zonesub" nametype, allowing updates to all subdomain names within that
 128 \fIzone\fR. This option cannot be used with the
 129 \fB\-s\fR
 130 option.
 131 .RE
 132 .SH "SEE ALSO"
 133 .PP
 134 \fBnsupdate\fR(1),
 135 \fBnamed.conf\fR(5),
 136 \fBnamed\fR(8),
 137 BIND 9 Administrator Reference Manual.
 138 .SH "AUTHOR"
 139 .PP
 140 Internet Systems Consortium
 141 .SH "COPYRIGHT"
 142 Copyright \(co 2009 Internet Systems Consortium, Inc. ("ISC")
 143 .br