man.nsupdate.html revision 2a6d4c9948b3f4f31311bd799d114585a30419a9
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
a908d41cb4b0658c958383375c5a8f0bcaaf843dFrancis Dupont - Copyright (C) 2000-2003 Internet Software Consortium.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - purpose with or without fee is hereby granted, provided that the above
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - copyright notice and this permission notice appear in all copies.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - PERFORMANCE OF THIS SOFTWARE.
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt<!-- $Id: man.nsupdate.html,v 1.64 2009/10/07 01:14:42 tbox Exp $ -->
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<link rel="prev" href="man.named.html" title="named">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<link rel="next" href="man.rndc.html" title="rndc">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<table width="100%" summary="Navigation header">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<tr><th colspan="3" align="center"><span class="application">nsupdate</span></th></tr>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a accesskey="p" href="man.named.html">Prev</a>�</td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<th width="60%" align="center">Manual pages</th>
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt<td width="20%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="man.nsupdate"></a><div class="titlepage"></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p><span class="application">nsupdate</span> — Dynamic DNS update utility</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [<code class="option">-D</code>] [[<code class="option">-g</code>] | [<code class="option">-o</code>] | [<code class="option">-l</code>] | [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></code>] | [<code class="option">-k <em class="replaceable"><code>keyfile</code></em></code>]] [<code class="option">-t <em class="replaceable"><code>timeout</code></em></code>] [<code class="option">-u <em class="replaceable"><code>udptimeout</code></em></code>] [<code class="option">-r <em class="replaceable"><code>udpretries</code></em></code>] [<code class="option">-R <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-v</code>] [filename]</p></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p><span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is used to submit Dynamic DNS Update requests as defined in RFC2136
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to a name server.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This allows resource records to be added or removed from a zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews without manually editing the zone file.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews A single update request can contain requests to add or remove more than
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews resource record.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Zones that are under dynamic control via
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or a DHCP server should not be edited by hand.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Manual edits could
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews conflict with dynamic updates and cause data to be lost.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The resource records that are dynamically added or removed with
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt <span><strong class="command">nsupdate</strong></span>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt have to be in the same zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Requests are sent to the zone's master server.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This is identified by the MNAME field of the zone's SOA record.
095c47be5456c17087d7b39dfc97ebee65e0dfbbMark Andrews option makes
095c47be5456c17087d7b39dfc97ebee65e0dfbbMark Andrews <span><strong class="command">nsupdate</strong></span>
095c47be5456c17087d7b39dfc97ebee65e0dfbbMark Andrews operate in debug mode.
095c47be5456c17087d7b39dfc97ebee65e0dfbbMark Andrews This provides tracing information about the update requests that are
095c47be5456c17087d7b39dfc97ebee65e0dfbbMark Andrews made and the replies received from the name server.
095c47be5456c17087d7b39dfc97ebee65e0dfbbMark Andrews The <code class="option">-D</code> option makes <span><strong class="command">nsupdate</strong></span>
095c47be5456c17087d7b39dfc97ebee65e0dfbbMark Andrews report additional debugging information to <code class="option">-d</code>.
9f5443280fcfd625a06f63a1b457ed2335840278Mark Andrews The <code class="option">-L</code> option with an integer argument of zero or
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews higher sets the logging debug level. If zero, logging is disabled.
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki Transaction signatures can be used to authenticate the Dynamic
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews DNS updates. These use the TSIG resource record type described
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews in RFC2845 or the SIG(0) record described in RFC3535 and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews RFC2931 or GSS-TSIG as described in RFC3645. TSIG relies on
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a shared secret that should only be known to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span> and the name server. Currently,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the only supported encryption algorithm for TSIG is HMAC-MD5,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews which is defined in RFC 2104. Once other algorithms are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews defined for TSIG, applications will need to ensure they select
1059bc2e42e8214f8b73d3b4cd181d8394a94a6aFrancis Dupont the appropriate algorithm as well as the key when authenticating
1059bc2e42e8214f8b73d3b4cd181d8394a94a6aFrancis Dupont each other. For instance, suitable <span class="type">key</span> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="type">server</span> statements would be added to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">/etc/named.conf</code> so that the name server
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews can associate the appropriate secret key and algorithm with
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the IP address of the client application that will be using
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews TSIG authentication. SIG(0) uses public key cryptography.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews To use a SIG(0) key, the public key must be stored in a KEY
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews record in a zone served by the name server.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span> does not read
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews GSS-TSIG uses Kerberos credentials.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p><span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews uses the <code class="option">-y</code> or <code class="option">-k</code> option
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to provide the shared secret needed to generate a TSIG record
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for authenticating Dynamic DNS update requests, default type
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews HMAC-MD5. These options are mutually exclusive.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When the <code class="option">-y</code> option is used, a signature is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews generated from
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews [<span class="optional"><em class="parameter"><code>hmac:</code></em></span>]<em class="parameter"><code>keyname:secret.</code></em>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>keyname</code></em> is the name of the key, and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Use of the <code class="option">-y</code> option is discouraged because the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews shared secret is supplied as a command line argument in clear text.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This may be visible in the output from
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or in a history file maintained by the user's shell.
45fd95544cd650a8e6a0fc39b656d1109b811ac0Evan Hunt <code class="option">-k</code> option, <span><strong class="command">nsupdate</strong></span> reads
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki the shared secret from the file <em class="parameter"><code>keyfile</code></em>.
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki Keyfiles may be in two formats: a single file containing
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki statement, which may be generated automatically by
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki of the format <code class="filename">K{name}.+157.+{random}.key</code> and
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <code class="filename">K{name}.+157.+{random}.private</code>, which can be
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki generated by <span><strong class="command">dnssec-keygen</strong></span>.
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki The <code class="option">-k</code> may also be used to specify a SIG(0) key used
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki to authenticate Dynamic DNS update requests. In this case, the key
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews specified is not an HMAC-MD5 key.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span> can be run in a local-host only mode
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki using the <code class="option">-l</code> flag. This sets the server address to
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki localhost (disabling the <span><strong class="command">server</strong></span> so that the server
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews address cannot be overridden). Connections to the local server will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews use a TSIG key found in <code class="filename">/var/run/named/ddns.key</code>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews which is automatically generated by <span><strong class="command">named</strong></span> if any
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews local master zone has set <span><strong class="command">update-policy</strong></span> to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">local</strong></span>. The location of this key file can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews overridden with the <code class="option">-k</code> option.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews By default, <span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews uses UDP to send update requests to the name server unless they are too
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews large to fit in a UDP request in which case TCP will be used.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews option makes
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews use a TCP connection.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This may be preferable when a batch of update requests is made.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <code class="option">-p</code> sets the default port number to use for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews connections to a name server. The default is 53.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <code class="option">-t</code> option sets the maximum time an update request
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews take before it is aborted. The default is 300 seconds. Zero can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to disable the timeout.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <code class="option">-u</code> option sets the UDP retry interval. The default
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt 3 seconds. If zero, the interval will be computed from the timeout
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and number of UDP retries.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <code class="option">-r</code> option sets the number of UDP retries. The
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 3. If zero, only one update request will be made.
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt The <code class="option">-R <em class="replaceable"><code>randomdev</code></em></code> option
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt specifies a source of randomness. If the operating system
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt does not provide a <code class="filename">/dev/random</code> or
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt equivalent device, the default source of randomness is keyboard
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt input. <code class="filename">randomdev</code> specifies the name of
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt a character device or file containing random data to be used
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt instead of the default. The special value
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt <code class="filename">keyboard</code> indicates that keyboard input
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt should be used. This option may be specified multiple times.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p><span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews reads input from
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>filename</code></em>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or standard input.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Each command is supplied on exactly one line of input.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Some commands are for administrative purposes.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The others are either update instructions or prerequisite checks on the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews contents of the zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews These checks set conditions that some name or set of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews resource records (RRset) either exists or is absent from the zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews These conditions must be met if the entire update request is to succeed.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Updates will be rejected if the tests for the prerequisite conditions
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Every update request consists of zero or more prerequisites
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and zero or more updates.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This allows a suitably authenticated update request to proceed if some
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews specified resource records are present or missing from the zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews A blank input line (or the <span><strong class="command">send</strong></span> command)
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt accumulated commands to be sent as one Dynamic DNS update request to the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews name server.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The command formats and their meaning are as follows:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">server</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews {servername}
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Sends all dynamic update requests to the name server
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>servername</code></em>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When no server statement is provided,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will send updates to the master server of the correct zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The MNAME field of that zone's SOA record will identify the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews server for that zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is the port number on
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>servername</code></em>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews where the dynamic update requests get sent.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If no port number is specified, the default DNS port number of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">local</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Sends all dynamic update requests using the local
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>address</code></em>.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt When no local statement is provided,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will send updates using an address and port chosen by the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews can additionally be used to make requests come from a specific
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If no port number is specified, the system will assign one.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">zone</strong></span>
1059bc2e42e8214f8b73d3b4cd181d8394a94a6aFrancis Dupont Specifies that all updates are to be made to the zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>zonename</code></em>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews statement is provided,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will attempt determine the correct zone to update based on the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews rest of the input.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">class</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Specify the default class.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If no <em class="parameter"><code>class</code></em> is specified, the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews default class is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">ttl</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Specify the default time to live for records to be added.
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki The value <em class="parameter"><code>none</code></em> will clear the default
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <span><strong class="command">key</strong></span>
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki Specifies that all updates are to be TSIG-signed using the
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <em class="parameter"><code>keyname</code></em> <em class="parameter"><code>keysecret</code></em> pair.
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki The <span><strong class="command">key</strong></span> command
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki overrides any key specified on the command line via
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <code class="option">-y</code> or <code class="option">-k</code>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">prereq nxdomain</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews {domain-name}
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Requires that no resource record of any type exists with name
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>domain-name</code></em>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">prereq yxdomain</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews {domain-name}
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Requires that
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>domain-name</code></em>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews exists (has as at least one resource record, of any type).
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">prereq nxrrset</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews {domain-name}
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Requires that no resource record exists of the specified
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>domain-name</code></em>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is omitted, IN (internet) is assumed.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">prereq yxrrset</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews {domain-name}
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt This requires that a resource record of the specified
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>domain-name</code></em>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is omitted, IN (internet) is assumed.
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt <span><strong class="command">prereq yxrrset</strong></span>
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt {domain-name}
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt from each set of prerequisites of this form
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews sharing a common
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>domain-name</code></em>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are combined to form a set of RRs. This set of RRs must
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews exactly match the set of RRs existing in the zone at the
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt <em class="parameter"><code>domain-name</code></em>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are written in the standard text representation of the resource
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">update delete</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews {domain-name}
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt [type [data...]]
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt Deletes any resource records named
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="parameter"><code>domain-name</code></em>.
343aeac7176d28c4a1b9d246b1f7311b4cd5da7dFrancis Dupont is provided, only matching resource records will be removed.
343aeac7176d28c4a1b9d246b1f7311b4cd5da7dFrancis Dupont The internet class is assumed if
12bf5d4796505b4c20680531da96a31e6c2c1144Evan Hunt is not supplied. The
84f95ddb2572641022619950a211aff49e331c98Mukund Sivaraman is ignored, and is only allowed for compatibility.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">update add</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews {domain-name}
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Adds a new resource record with the specified
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <span><strong class="command">show</strong></span>
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki Displays the current message, containing all of the
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki prerequisites and
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki updates specified since the last send.
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <span><strong class="command">send</strong></span>
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki Sends the current message. This is equivalent to entering a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">answer</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Displays the answer.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">debug</strong></span>
343aeac7176d28c4a1b9d246b1f7311b4cd5da7dFrancis Dupont Turn on debugging.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Lines beginning with a semicolon are comments and are ignored.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The examples below show how
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span>
343aeac7176d28c4a1b9d246b1f7311b4cd5da7dFrancis Dupont could be used to insert and delete resource records from the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Notice that the input in each example contains a trailing blank line so
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a group of commands are sent as one dynamic update request to the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews master name server for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews> update delete oldhost.example.com A
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews> update add newhost.example.com 86400 A 172.16.1.1
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Any A records for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are deleted.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews And an A record for
b7c6138405d62bae04bd4d065d4a2057ff125707Francis Dupont <span class="type">newhost.example.com</span>
b7c6138405d62bae04bd4d065d4a2057ff125707Francis Dupont with IP address 172.16.1.1 is added.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The newly-added record has a 1 day TTL (86400 seconds).
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews> prereq nxdomain nickname.example.com
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews> update add nickname.example.com 86400 CNAME somehost.example.com
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The prerequisite condition gets the name server to check that there
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are no resource records of any type for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="type">nickname.example.com</span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If there are, the update request fails.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If this name does not exist, a CNAME for it is added.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This ensures that when the CNAME is added, it cannot conflict with the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews long-standing rule in RFC1034 that a name must not exist as any other
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews record type if it exists as a CNAME.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (The rule has been updated for DNSSEC in RFC2535 to allow CNAMEs to have
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews RRSIG, DNSKEY and NSEC records.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews used to identify default name server
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="term"><code class="constant">/var/run/named/ddns.key</code></span></dt>
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt sets the default TSIG key for use in local-only mode
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="term"><code class="constant">K{name}.+157.+{random}.key</code></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews base-64 encoding of HMAC-MD5 key created by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="term"><code class="constant">K{name}.+157.+{random}.private</code></span></dt>
98922b2b2b024dcca25be7c220cf3b16b1e6c4b5Evan Hunt base-64 encoding of HMAC-MD5 key created by
cc51cd2d2076e33117c60c9effcb8caccde4983bWitold Krecicki <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p><span class="citerefentry"><span class="refentrytitle">RFC2136</span></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC3007</span></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC2104</span></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC2845</span></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC1034</span></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC2535</span></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC2931</span></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="citerefentry"><span class="refentrytitle">ddns-confgen</span>(8)</span>,
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The TSIG key is redundantly stored in two separate files.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This is a consequence of nsupdate using the DST library
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for its cryptographic operations, and may change in future
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<table width="100%" summary="Navigation footer">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a accesskey="p" href="man.named.html">Prev</a>�</td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="40%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
98091cb21da79b0c7fd329fd64497dcb03402467Evan Hunt<td width="40%" align="right" valign="top">�<span class="application">rndc</span>