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