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