nsupdate.html revision 61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews - Copyright (C) 2001-2003 Internet Software Consortium.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson - Permission to use, copy, modify, and distribute this software for any
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson - copyright notice and this permission notice appear in all copies.
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews<!-- $Id: nsupdate.html,v 1.16 2004/04/07 00:57:01 marka Exp $ -->
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>nsupdate</TITLE
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonNAME="GENERATOR"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCONTENT="Modular DocBook HTML Stylesheet Version 1.73
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonBGCOLOR="#FFFFFF"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonVLINK="#840084"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonALINK="#0000FF"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFNAMEDIV"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>nsupdate -- Dynamic DNS update utility</DIV
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFSYNOPSISDIV"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REPLACEABLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>keyname:secret</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REPLACEABLE"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="REPLACEABLE"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="OPTION"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="REPLACEABLE"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrews>udptimeout</I
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="OPTION"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="REPLACEABLE"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrews>udpretries</I
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="OPTION"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>] [filename]</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFSECT1"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>DESCRIPTION</H2
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonis used to submit Dynamic DNS Update requests as defined in RFC2136
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonto a name server.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis allows resource records to be added or removed from a zone
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonwithout manually editing the zone file.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonA single update request can contain requests to add or remove more than one
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonresource record.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Zones that are under dynamic control via
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonor a DHCP server should not be edited by hand.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonManual edits could
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonconflict with dynamic updates and cause data to be lost.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>The resource records that are dynamically added or removed with
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonhave to be in the same zone.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonRequests are sent to the zone's master server.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis is identified by the MNAME field of the zone's SOA record.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonoperate in debug mode.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis provides tracing information about the update requests that are
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonmade and the replies received from the name server.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Transaction signatures can be used to authenticate the Dynamic DNS
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian WellingtonThese use the TSIG resource record type described in RFC2845 or the
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian WellingtonSIG(0) record described in RFC3535 and RFC2931.
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian WellingtonTSIG relies on a shared secret that should only be known to
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellington> and the name server.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCurrently, the only supported encryption algorithm for TSIG is
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonHMAC-MD5, which is defined in RFC 2104.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonOnce other algorithms are defined for TSIG, applications will need to
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonensure they select the appropriate algorithm as well as the key when
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonauthenticating each other.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonFor instance suitable
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonstatements would be added to
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="FILENAME"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonso that the name server can associate the appropriate secret key
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonand algorithm with the IP address of the
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonclient application that will be using TSIG authentication.
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian WellingtonSIG(0) uses public key cryptography. To use a SIG(0) key, the public
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellingtonkey must be stored in a KEY record in a zone served by the name server.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="FILENAME"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellingtonoption (with an HMAC-MD5 key) to provide the shared secret needed to generate
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellingtona TSIG record for authenticating Dynamic DNS update requests.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThese options are mutually exclusive.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonreads the shared secret from the file
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonwhose name is of the form
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="FILENAME"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>K{name}.+157.+{random}.private</TT
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonreasons, the file
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="FILENAME"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>K{name}.+157.+{random}.key</TT
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonmust also be present. When the
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonoption is used, a signature is generated from
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>keyname:secret.</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonis the name of the key,
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonis the base64 encoded shared secret.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonoption is discouraged because the shared secret is supplied as a command
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonline argument in clear text.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis may be visible in the output from
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonor in a history file maintained by the user's shell.</P
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian WellingtonCLASS="OPTION"
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellington> may also be used to specify a SIG(0) key used
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellingtonto authenticate Dynamic DNS update requests. In this case, the key
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellingtonspecified is not an HMAC-MD5 key.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrewsuses UDP to send update requests to the name server unless they are too
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrewslarge to fit in a UDP request in which case TCP will be used.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonuse a TCP connection.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis may be preferable when a batch of update requests is made.</P
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="OPTION"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrews> option sets the maximum time a update request can
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrewstake before it is aborted. The default is 300 seconds. Zero can be used
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrewsto disable the timeout.</P
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="OPTION"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrews> option sets the UDP retry interval. The default is
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrews3 seconds. If zero the interval will be computed from the timeout interval
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrewsand number of UDP retries.</P
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsCLASS="OPTION"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrews> option sets the number of UDP retries. The default is
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrews3. If zero only one update request will be made.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFSECT1"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>INPUT FORMAT</H2
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonreads input from
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonor standard input.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonEach command is supplied on exactly one line of input.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonSome commands are for administrative purposes.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThe others are either update instructions or prerequisite checks on the
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssoncontents of the zone.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThese checks set conditions that some name or set of
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonresource records (RRset) either exists or is absent from the zone.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThese conditions must be met if the entire update request is to succeed.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonUpdates will be rejected if the tests for the prerequisite conditions fail.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Every update request consists of zero or more prerequisites
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonand zero or more updates.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis allows a suitably authenticated update request to proceed if some
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonspecified resource records are present or missing from the zone.
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian WellingtonA blank input line (or the <B
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian WellingtonCLASS="COMMAND"
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian Wellington> command) causes the
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian Wellingtonaccumulated commands to be sent as one Dynamic DNS update request to the
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian Wellingtonname server.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>The command formats and their meaning are as follows:
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="VARIABLELIST"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {servername} [port]</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Sends all dynamic update requests to the name server
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonWhen no server statement is provided,
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonwill send updates to the master server of the correct zone.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThe MNAME field of that zone's SOA record will identify the master
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonserver for that zone.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonis the port number on
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonwhere the dynamic update requests get sent.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonIf no port number is specified, the default DNS port number of 53 is
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {address} [port]</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Sends all dynamic update requests using the local
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonWhen no local statement is provided,
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark Andrewswill send updates using an address and port chosen by the system.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssoncan additionally be used to make requests come from a specific port.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonIf no port number is specified, the system will assign one. </P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {zonename}</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Specifies that all updates are to be made to the zone
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonstatement is provided,
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonwill attempt determine the correct zone to update based on the rest of the input.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrews> {classname}</P
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrews>Specify the default class.
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsCLASS="PARAMETER"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrews> is specified the default class is
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsCLASS="PARAMETER"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsCLASS="COMMAND"
0af994c26ff2462f9186ce0d694c37a4bcbd971dAndreas Gustafsson> {name} {secret}</P
0af994c26ff2462f9186ce0d694c37a4bcbd971dAndreas Gustafsson>Specifies that all updates are to be TSIG signed using the
0af994c26ff2462f9186ce0d694c37a4bcbd971dAndreas GustafssonCLASS="PARAMETER"
0af994c26ff2462f9186ce0d694c37a4bcbd971dAndreas GustafssonCLASS="PARAMETER"
0af994c26ff2462f9186ce0d694c37a4bcbd971dAndreas GustafssonCLASS="COMMAND"
0af994c26ff2462f9186ce0d694c37a4bcbd971dAndreas Gustafssonoverrides any key specified on the command line via
0af994c26ff2462f9186ce0d694c37a4bcbd971dAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>prereq nxdomain</B
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {domain-name}</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Requires that no resource record of any type exists with name
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>domain-name</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>prereq yxdomain</B
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {domain-name}</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>domain-name</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonexists (has as at least one resource record, of any type).</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>prereq nxrrset</B
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {domain-name} [class] {type}</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Requires that no resource record exists of the specified
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>domain-name</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrewsis omitted, IN (internet) is assumed.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>prereq yxrrset</B
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {domain-name} [class] {type}</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>This requires that a resource record of the specified
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>domain-name</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonis omitted, IN (internet) is assumed.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>prereq yxrrset</B
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {domain-name} [class] {type} {data...}</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonfrom each set of prerequisites of this form
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonsharing a common
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>domain-name</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonare combined to form a set of RRs. This set of RRs must
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonexactly match the set of RRs existing in the zone at the
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>domain-name</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonare written in the standard text representation of the resource record's
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>update delete</B
edac761923fac89405f7d1e4244a11d88a89f413Brian Wellington> {domain-name} [ttl] [class] [type [data...]]</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Deletes any resource records named
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>domain-name</I
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonis provided, only matching resource records will be removed.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThe internet class is assumed if
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
edac761923fac89405f7d1e4244a11d88a89f413Brian Wellingtonis not supplied. The
edac761923fac89405f7d1e4244a11d88a89f413Brian WellingtonCLASS="PARAMETER"
edac761923fac89405f7d1e4244a11d88a89f413Brian Wellingtonis ignored, and is only allowed for compatibility.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> {domain-name} {ttl} [class] {type} {data...}</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Adds a new resource record with the specified
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PARAMETER"
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian WellingtonCLASS="COMMAND"
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian Wellington>Displays the current message, containing all of the prerequisites and
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian Wellingtonupdates specified since the last send.</P
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian WellingtonCLASS="COMMAND"
f46b1b2329c4e56af6b231470e00053bad25e9e2Brian Wellington>Sends the current message. This is equivalent to entering a blank line.</P
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsCLASS="COMMAND"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrews>Displays the answer.</P
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrews>Lines beginning with a semicolon are comments and are ignored.</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFSECT1"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsNAME="AEN255"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>The examples below show how
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="COMMAND"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssoncould be used to insert and delete resource records from the
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonNotice that the input in each example contains a trailing blank line so that
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssona group of commands are sent as one dynamic update request to the
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonmaster name server for
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PROGRAMLISTING"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> update delete oldhost.example.com A
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> update add newhost.example.com 86400 A 172.16.1.1
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrews> send</PRE
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>Any A records for
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonand an A record for
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonit IP address 172.16.1.1 is added.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThe newly-added record has a 1 day TTL (86400 seconds)
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="PROGRAMLISTING"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson> prereq nxdomain nickname.example.com
e181d9899bc2b05c75ce995854931b8cd51aeeafAndreas Gustafsson> update add nickname.example.com 86400 CNAME somehost.example.com
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark Andrews> send</PRE
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>The prerequisite condition gets the name server to check that there
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonare no resource records of any type for
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonIf there are, the update request fails.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonIf this name does not exist, a CNAME for it is added.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis ensures that when the CNAME is added, it cannot conflict with the
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonlong-standing rule in RFC1034 that a name must not exist as any other
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonrecord type if it exists as a CNAME.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson(The rule has been updated for DNSSEC in RFC2535 to allow CNAMEs to have
3970098dcd2a7122541667b4b56cea8abce8ccf2Mark AndrewsRRSIG, DNSKEY and NSEC records.)</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFSECT1"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsNAME="AEN268"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="VARIABLELIST"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CONSTANT"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>used to identify default name server</P
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CONSTANT"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>K{name}.+157.+{random}.key</TT
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>base-64 encoding of HMAC-MD5 key created by
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>dnssec-keygen</SPAN
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CONSTANT"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>K{name}.+157.+{random}.private</TT
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>base-64 encoding of HMAC-MD5 key created by
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>dnssec-keygen</SPAN
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFSECT1"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsNAME="AEN292"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian Wellington>RFC2931</SPAN
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian WellingtonCLASS="CITEREFENTRY"
8fb0f1fa4253720a5da09f28c20696e4d666173cBrian WellingtonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="CITEREFENTRY"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFENTRYTITLE"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>dnssec-keygen</SPAN
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonCLASS="REFSECT1"
8dcabaace18bbfd2f9a09a0cb0f524cbb326cbabMark AndrewsNAME="AEN315"
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafsson>The TSIG key is redundantly stored in two separate files.
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas GustafssonThis is a consequence of nsupdate using the DST library
803b50652fd6ad81d04d18fc04332c8a94f8fe9aAndreas Gustafssonfor its cryptographic operations, and may change in future