man.nsupdate.html revision c313914d0e66b20969215e519bbf2ab4ecf39512
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000-2018 Internet Systems Consortium, Inc. ("ISC")
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - This Source Code Form is subject to the terms of the Mozilla Public
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - License, v. 2.0. If a copy of the MPL was not distributed with this
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - file, You can obtain one at http://mozilla.org/MPL/2.0/.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="prev" href="man.named-rrchecker.html" title="named-rrchecker">
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<link rel="next" href="man.rndc.html" title="rndc">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<tr><th colspan="3" align="center"><span class="application">nsupdate</span></th></tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.named-rrchecker.html">Prev</a>�</td>
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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein — Dynamic DNS update utility
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein [<code class="option">-L <em class="replaceable"><code>level</code></em></code>]
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User | [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></code>]
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User | [<code class="option">-k <em class="replaceable"><code>keyfile</code></em></code>]
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User [<code class="option">-t <em class="replaceable"><code>timeout</code></em></code>]
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User [<code class="option">-u <em class="replaceable"><code>udptimeout</code></em></code>]
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User [<code class="option">-r <em class="replaceable"><code>udpretries</code></em></code>]
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User [<code class="option">-R <em class="replaceable"><code>randomdev</code></em></code>]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p><span class="command"><strong>nsupdate</strong></span>
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater is used to submit Dynamic DNS Update requests as defined in RFC 2136
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User to a name server.
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater This allows resource records to be added or removed from a zone
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater without manually editing the zone file.
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User A single update request can contain requests to add or remove more than
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User resource record.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Zones that are under dynamic control via
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User <span class="command"><strong>nsupdate</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or a DHCP server should not be edited by hand.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Manual edits could
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User conflict with dynamic updates and cause data to be lost.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The resource records that are dynamically added or removed with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>nsupdate</strong></span>
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User have to be in the same zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requests are sent to the zone's master server.
983df82baf1d7d0b668c98cf45928a19f175c6e7Tinderbox User This is identified by the MNAME field of the zone's SOA record.
7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews Transaction signatures can be used to authenticate the Dynamic
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DNS updates. These use the TSIG resource record type described
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater in RFC 2845 or the SIG(0) record described in RFC 2535 and
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater RFC 2931 or GSS-TSIG as described in RFC 3645.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein TSIG relies on
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews a shared secret that should only be known to
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <span class="command"><strong>nsupdate</strong></span> and the name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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. You can use <span class="command"><strong>ddns-confgen</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to generate suitable configuration fragments.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>nsupdate</strong></span>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews uses the <code class="option">-y</code> or <code class="option">-k</code> options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to provide the TSIG shared secret. These options are mutually exclusive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SIG(0) uses public key cryptography.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein To use a SIG(0) key, the public key must be stored in a KEY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein record in a zone served by the name server.
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is switched on with the <code class="option">-g</code> flag. A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <div class="variablelist"><dl class="variablelist">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Debug mode. This provides tracing information about the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein update requests that are made and the replies received
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein from the name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Extra debug mode.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Force interactive mode, even when standard input is not a terminal.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-k <em class="replaceable"><code>keyfile</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The file containing the TSIG authentication key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Keyfiles may be in two formats: a single file containing
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a <code class="filename">named.conf</code>-format <span class="command"><strong>key</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statement, which may be generated automatically by
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <span class="command"><strong>ddns-confgen</strong></span>, or a pair of files whose names are
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews of the format <code class="filename">K{name}.+157.+{random}.key</code> and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">K{name}.+157.+{random}.private</code>, which can be
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews generated by <span class="command"><strong>dnssec-keygen</strong></span>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The <code class="option">-k</code> may also be used to specify a SIG(0) key used
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews to authenticate Dynamic DNS update requests. In this case, the key
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews specified is not an HMAC-MD5 key.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Local-host only mode. This sets the server address to
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews localhost (disabling the <span class="command"><strong>server</strong></span> so that the server
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews address cannot be overridden). Connections to the local server will
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews use a TSIG key found in <code class="filename">/var/run/named/session.key</code>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein which is automatically generated by <span class="command"><strong>named</strong></span> if any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein local master zone has set <span class="command"><strong>update-policy</strong></span> to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>local</strong></span>. The location of this key file can be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein overridden with the <code class="option">-k</code> option.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-L <em class="replaceable"><code>level</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Set the logging debug level. If zero, logging is disabled.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater Set the port to use for connections to a name server. The
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater default is 53.
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater Print the list of private BIND-specific resource record
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater types whose format is understood
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater by <span class="command"><strong>nsupdate</strong></span>. See also
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater the <code class="option">-T</code> option.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-r <em class="replaceable"><code>udpretries</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The number of UDP retries. The default is 3. If zero, only
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein one update request will be made.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-R <em class="replaceable"><code>randomdev</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Where to obtain randomness. If the operating system
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein does not provide a <code class="filename">/dev/random</code> or
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein equivalent device, the default source of randomness is keyboard
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-t <em class="replaceable"><code>timeout</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The maximum time an update request can take before it is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein aborted. The default is 300 seconds. Zero can be used to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein disable the timeout.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Print the list of IANA standard resource record types
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein whose format is understood by <span class="command"><strong>nsupdate</strong></span>.
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews <span class="command"><strong>nsupdate</strong></span> will exit after the lists are
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews printed. The <code class="option">-T</code> option can be combined
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews with the <code class="option">-P</code> option.
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews decimal value of the type with no leading zeros. The rdata,
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews if present, will be parsed using the UNKNOWN rdata format,
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews (<backslash> <hash> <space> <length>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <space> <hexstring>).
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews<dt><span class="term">-u <em class="replaceable"><code>udptimeout</code></em></span></dt>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews The UDP retry interval. The default is 3 seconds. If zero,
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews the interval will be computed from the timeout interval and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein number of UDP retries.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use TCP even for small update requests.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein By default, <span class="command"><strong>nsupdate</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein uses UDP to send update requests to the name server unless they are too
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein large to fit in a UDP request in which case TCP will be used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein TCP may be preferable when a batch of update requests is made.
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User Print the version number and exit.
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User<dt><span class="term">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></span></dt>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User Literal TSIG authentication key.
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <em class="parameter"><code>keyname</code></em> is the name of the key, and
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <em class="parameter"><code>hmac</code></em> is the name of the key algorithm;
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User valid choices are <code class="literal">hmac-md5</code>,
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <code class="literal">hmac-sha1</code>, <code class="literal">hmac-sha224</code>,
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <code class="literal">hmac-sha256</code>, <code class="literal">hmac-sha384</code>, or
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <code class="literal">hmac-sha512</code>. If <em class="parameter"><code>hmac</code></em>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User is not specified, the default is <code class="literal">hmac-md5</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or if MD5 was disabled <code class="literal">hmac-sha256</code>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein NOTE: 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 or in a history file maintained by the user's shell.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p><span class="command"><strong>nsupdate</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews specified resource records are present or missing from the zone.
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews A blank input line (or the <span class="command"><strong>send</strong></span> command)
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews accumulated commands to be sent as one Dynamic DNS update request to the
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The command formats and their meaning are as follows:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="variablelist"><dl class="variablelist">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>server</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein {servername}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sends all dynamic update requests to the name server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>servername</code></em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When no server statement is provided,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>nsupdate</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will send updates to the master server of the correct zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The MNAME field of that zone's SOA record will identify the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server for that zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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 class="command"><strong>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,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>nsupdate</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will send updates using an address and port chosen by the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein can additionally be used to make requests come from a specific
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If no port number is specified, the system will assign one.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>zone</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies that all updates are to be made to the zone
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>zonename</code></em>.
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater statement is provided,
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater <span class="command"><strong>nsupdate</strong></span>
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater will attempt determine the correct zone to update based on the
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater rest of the input.
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater <span class="command"><strong>class</strong></span>
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater Specify the default class.
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater If no <em class="parameter"><code>class</code></em> is specified, the
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater default class is
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater <em class="parameter"><code>IN</code></em>.
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater <span class="command"><strong>ttl</strong></span>
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater Specify the default time to live for records to be added.
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater The value <em class="parameter"><code>none</code></em> will clear the default
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>key</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein [hmac:] {keyname}
dad65f7c93330a10705384739dff3a6d4dfe1e70Tinderbox User Specifies that all updates are to be TSIG-signed using the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>keyname</code></em> <em class="parameter"><code>secret</code></em> pair.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If <em class="parameter"><code>hmac</code></em> is specified, then it sets the
dad65f7c93330a10705384739dff3a6d4dfe1e70Tinderbox User signing algorithm in use; the default is
dad65f7c93330a10705384739dff3a6d4dfe1e70Tinderbox User <code class="literal">hmac-md5</code> or if MD5 was disabled
bae169ea64bf736d6ea6074c2af3d7c117079972Tinderbox User <code class="literal">hmac-sha256</code>. The <span class="command"><strong>key</strong></span>
bae169ea64bf736d6ea6074c2af3d7c117079972Tinderbox User command overrides any key specified on the command line via
bae169ea64bf736d6ea6074c2af3d7c117079972Tinderbox User <code class="option">-y</code> or <code class="option">-k</code>.
a24330c4805a224191ab687d0291963062fe3355Tinderbox User <span class="command"><strong>gsstsig</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use GSS-TSIG to sign the updated. This is equivalent to
dad65f7c93330a10705384739dff3a6d4dfe1e70Tinderbox User specifying <code class="option">-g</code> on the command line.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <span class="command"><strong>oldgsstsig</strong></span>
dad65f7c93330a10705384739dff3a6d4dfe1e70Tinderbox User 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 command line.
dad65f7c93330a10705384739dff3a6d4dfe1e70Tinderbox User <span class="command"><strong>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.
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User <span class="command"><strong>check-names</strong></span>
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User Turn on or off check-names processing on records to
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User be added. Check-names has no effect on prerequisites
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User or records to be deleted. By default check-names
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User processing is on. If check-names processing fails
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User the record will not be added to the UPDATE message.
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User <span class="command"><strong>[<span class="optional">prereq</span>] nxdomain</strong></span>
8f70b6b48364b58f2823e735c35bf77787de0860Tinderbox User {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 class="command"><strong>[<span class="optional">prereq</span>] 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 class="command"><strong>[<span class="optional">prereq</span>] 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 class="command"><strong>[<span class="optional">prereq</span>] yxrrset</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein {domain-name}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This requires that a resource record of the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>domain-name</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is omitted, IN (internet) is assumed.
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews <span class="command"><strong>[<span class="optional">prereq</span>] yxrrset</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein {domain-name}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein from each set of prerequisites of this form
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein sharing a common
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
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews exactly match the set of RRs existing in the zone at the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>domain-name</code></em>.
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews are written in the standard text representation of the resource
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews <span class="command"><strong>[<span class="optional">update</span>] del[<span class="optional">ete</span>]</strong></span>
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews {domain-name}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein [type [data...]]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Deletes any resource records named
035992291cb70ec3be4046fcea921b4a6acb1c77Mark Andrews <em class="parameter"><code>domain-name</code></em>.
68b30890ebd441a6a1ae3fdf71744d07d02cd030Mark Andrews is provided, only matching resource records will be removed.
035992291cb70ec3be4046fcea921b4a6acb1c77Mark Andrews The internet class is assumed if
035992291cb70ec3be4046fcea921b4a6acb1c77Mark Andrews is not supplied. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is ignored, and is only allowed for compatibility.
d9184858dd5d7677050a813d444c281c56f697aaTinderbox User <span class="command"><strong>[<span class="optional">update</span>] add</strong></span>
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews Adds a new resource record with the specified
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews <span class="command"><strong>show</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Displays the current message, containing all of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein prerequisites and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein updates specified since the last send.
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <span class="command"><strong>send</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sends the current message. This is equivalent to entering a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>answer</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Displays the answer.
ac93437301f55ed69bf85883a497a75598c628f9Automatic Updater <span class="command"><strong>debug</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Turn on debugging.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>version</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Print version number.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>help</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Print a list of commands.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce Lines beginning with a semicolon are comments and are ignored.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The examples below show how
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>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
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce a group of commands are sent as one dynamic update request to the
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce master name server for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> update delete oldhost.example.com A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> update add newhost.example.com 86400 A 172.16.1.1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Any A records for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein are deleted.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce And an A record for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> update add nickname.example.com 86400 CNAME somehost.example.com
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The prerequisite condition gets the name server to check that there
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein are no resource records of any type for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If there are, the update request fails.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If this name does not exist, a CNAME for it is added.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This ensures that when the CNAME is added, it cannot conflict with the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein long-standing rule in RFC 1034 that a name must not exist as any other
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews record type if it exists as a CNAME.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein RRSIG, DNSKEY and NSEC records.)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <div class="variablelist"><dl class="variablelist">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein used to identify default name server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term"><code class="constant">/var/run/named/session.key</code></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein base-64 encoding of HMAC-MD5 key created by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="refentrytitle">dnssec-keygen</span>(8)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="refentrytitle">dnssec-keygen</span>(8)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="refentrytitle">ddns-confgen</span>(8)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="refentrytitle">dnssec-keygen</span>(8)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The TSIG key is redundantly stored in two separate files.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This is a consequence of nsupdate using the DST library
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for its cryptographic operations, and may change in future
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.named-rrchecker.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<span class="application">named-rrchecker</span>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right" valign="top">�<span class="application">rndc</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.3 (Extended Support Version)</p>