.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::DNS::Update 3pm"
.TH Net::DNS::Update 3pm 2024-02-17 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::DNS::Update \- DNS dynamic update packet
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::DNS;
\&
\&    $update = Net::DNS::Update\->new( \*(Aqexample.com\*(Aq, \*(AqIN\*(Aq );
\&
\&    $update\->push( prereq => nxrrset(\*(Aqhost.example.com. AAAA\*(Aq) );
\&    $update\->push( update => rr_add(\*(Aqhost.example.com. 86400 AAAA 2001::DB8::F00\*(Aq) );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Net::DNS::Update is a subclass of Net::DNS::Packet, to be used for
making DNS dynamic updates.
.PP
Programmers should refer to RFC2136 for dynamic update semantics.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 3
\&    $update = Net::DNS::Update\->new;
\&    $update = Net::DNS::Update\->new( \*(Aqexample.com\*(Aq );
\&    $update = Net::DNS::Update\->new( \*(Aqexample.com\*(Aq, \*(AqIN\*(Aq );
.Ve
.PP
Returns a Net::DNS::Update object suitable for performing a DNS
dynamic update.	 Specifically, it creates a packet with the header
opcode set to UPDATE and the zone record type to SOA (per RFC 2136,
Section 2.3).
.PP
Programs must use the \fBpush()\fR method to add RRs to the prerequisite
and update sections before performing the update.
.PP
Arguments are the zone name and the class.  The zone and class may
be undefined or omitted and default to the default domain from the
resolver configuration and IN respectively.
.SS push
.IX Subsection "push"
.Vb 3
\&    $ancount = $update\->push( prereq => $rr );
\&    $nscount = $update\->push( update => $rr );
\&    $arcount = $update\->push( additional => $rr );
\&
\&    $nscount = $update\->push( update => $rr1, $rr2, $rr3 );
\&    $nscount = $update\->push( update => @rr );
.Ve
.PP
Adds RRs to the specified section of the update packet.
.PP
Returns the number of resource records in the specified section.
.PP
Section names may be abbreviated to the first three characters.
.SS unique_push
.IX Subsection "unique_push"
.Vb 3
\&    $ancount = $update\->unique_push( prereq => $rr );
\&    $nscount = $update\->unique_push( update => $rr );
\&    $arcount = $update\->unique_push( additional => $rr );
\&
\&    $nscount = $update\->unique_push( update => $rr1, $rr2, $rr3 );
\&    $nscount = $update\->unique_push( update => @rr );
.Ve
.PP
Adds RRs to the specified section of the update packet provided
that the RRs are not already present in the same section.
.PP
Returns the number of resource records in the specified section.
.PP
Section names may be abbreviated to the first three characters.
.SH EXAMPLES
.IX Header "EXAMPLES"
The first example below shows a complete program.
Subsequent examples show only the creation of the update packet.
.PP
Although the examples are presented using the string form of RRs,
the corresponding ( name => value ) form may also be used.
.SS "Add a new host"
.IX Subsection "Add a new host"
.Vb 1
\&    #!/usr/bin/perl
\&
\&    use Net::DNS;
\&
\&    # Create the update packet.
\&    my $update = Net::DNS::Update\->new(\*(Aqexample.com\*(Aq);
\&
\&    # Prerequisite is that no address records exist for the name.
\&    $update\->push( pre => nxrrset(\*(Aqhost.example.com. A\*(Aq) );
\&    $update\->push( pre => nxrrset(\*(Aqhost.example.com. AAAA\*(Aq) );
\&
\&    # Add two address records for the name.
\&    $update\->push( update => rr_add(\*(Aqhost.example.com. 86400 A 192.0.2.1\*(Aq) );
\&    $update\->push( update => rr_add(\*(Aqhost.example.com. 86400 AAAA 2001:DB8::1\*(Aq) );
\&
\&    # Send the update to the zone\*(Aqs primary nameserver.
\&    my $resolver = Net::DNS::Resolver\->new();
\&    $resolver\->nameservers(\*(AqDNSprimary.example.com\*(Aq);
\&
\&    my $reply = $resolver\->send($update);
\&
\&    # Did it work?
\&    if ($reply) {
\&            if ( $reply\->header\->rcode eq \*(AqNOERROR\*(Aq ) {
\&                    print "Update succeeded\en";
\&            } else {
\&                    print \*(AqUpdate failed: \*(Aq, $reply\->header\->rcode, "\en";
\&            }
\&    } else {
\&            print \*(AqUpdate failed: \*(Aq, $resolver\->errorstring, "\en";
\&    }
.Ve
.SS "Add an MX record for a name that already exists"
.IX Subsection "Add an MX record for a name that already exists"
.Vb 3
\&    my $update = Net::DNS::Update\->new(\*(Aqexample.com\*(Aq);
\&    $update\->push( prereq => yxdomain(\*(Aqexample.com\*(Aq) );
\&    $update\->push( update => rr_add(\*(Aqexample.com MX 10 mailhost.example.com\*(Aq) );
.Ve
.SS "Add a TXT record for a name that does not exist"
.IX Subsection "Add a TXT record for a name that does not exist"
.Vb 3
\&    my $update = Net::DNS::Update\->new(\*(Aqexample.com\*(Aq);
\&    $update\->push( prereq => nxdomain(\*(Aqinfo.example.com\*(Aq) );
\&    $update\->push( update => rr_add(\*(Aqinfo.example.com TXT "yabba dabba doo"\*(Aq) );
.Ve
.SS "Delete all A records for a name"
.IX Subsection "Delete all A records for a name"
.Vb 3
\&    my $update = Net::DNS::Update\->new(\*(Aqexample.com\*(Aq);
\&    $update\->push( prereq => yxrrset(\*(Aqhost.example.com A\*(Aq) );
\&    $update\->push( update => rr_del(\*(Aqhost.example.com A\*(Aq) );
.Ve
.SS "Delete all RRs for a name"
.IX Subsection "Delete all RRs for a name"
.Vb 3
\&    my $update = Net::DNS::Update\->new(\*(Aqexample.com\*(Aq);
\&    $update\->push( prereq => yxdomain(\*(Aqbyebye.example.com\*(Aq) );
\&    $update\->push( update => rr_del(\*(Aqbyebye.example.com\*(Aq) );
.Ve
.SS "Perform DNS update signed using a key generated by BIND tsig-keygen"
.IX Subsection "Perform DNS update signed using a key generated by BIND tsig-keygen"
.Vb 5
\&    my $update = Net::DNS::Update\->new(\*(Aqexample.com\*(Aq);
\&    $update\->push( update => rr_add(\*(Aqhost.example.com AAAA 2001:DB8::1\*(Aq) );
\&    $update\->sign_tsig( $key_file );
\&    my $reply = $resolver\->send( $update );
\&    $reply\->verify( $update ) || die $reply\->verifyerr;
.Ve
.SS "Signing the DNS update using a customised TSIG record"
.IX Subsection "Signing the DNS update using a customised TSIG record"
.Vb 1
\&    $update\->sign_tsig( $key_file, fudge => 60 );
.Ve
.SS "Signing the DNS update using private key generated by BIND dnssec-keygen"
.IX Subsection "Signing the DNS update using private key generated by BIND dnssec-keygen"
.Vb 1
\&    $update\->sign_tsig( "$dir/Khmac\-sha512.example.com.+165+01018.private" );
.Ve
.SS "Signing the DNS update using public key generated by BIND dnssec-keygen"
.IX Subsection "Signing the DNS update using public key generated by BIND dnssec-keygen"
.Vb 1
\&    $update\->sign_tsig( "$dir/Khmac\-sha512.example.com.+165+01018.key" );
.Ve
.SS "Another way to sign a DNS update"
.IX Subsection "Another way to sign a DNS update"
.Vb 1
\&    use Net::DNS::RR::TSIG;
\&
\&    my $tsig = create Net::DNS::RR::TSIG( $key_file );
\&    $tsig\->fudge(60);
\&
\&    my $update = Net::DNS::Update\->new(\*(Aqexample.com\*(Aq);
\&    $update\->push( update     => rr_add(\*(Aqhost.example.com AAAA 2001:DB8::1\*(Aq) );
\&    $update\->push( additional => $tsig );
.Ve
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c)1997\-2000 Michael Fuhr.
.PP
Portions Copyright (c)2002,2003 Chris Reinhardt.
.PP
Portions Copyright (c)2015 Dick Franks.
.PP
All rights reserved.
.SH LICENSE
.IX Header "LICENSE"
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted, provided
that the original copyright notices appear in all copies and that both
copyright notice and this permission notice appear in supporting
documentation, and that the name of the author not be used in advertising
or publicity pertaining to distribution of the software without specific
prior written permission.
.PP
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl Net::DNS Net::DNS::Packet Net::DNS::Header
Net::DNS::RR Net::DNS::Resolver
RFC2136 <https://tools.ietf.org/html/rfc2136>
RFC8945 <https://tools.ietf.org/html/rfc8945>