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