Net::DNS::RR::SOA

Section: User Contributed Perl Documentation (3)
Updated: 2021-01-27
Page Index
 

NAME

Net::DNS::RR::SOA - DNS SOA resource record  

SYNOPSIS

    use Net::DNS;
    $rr = Net::DNS::RR->new('name SOA mname rname 0 14400 3600 1814400 3600');

 

DESCRIPTION

Class for DNS Start of Authority (SOA) resource records.  

METHODS

The available methods are those inherited from the base class augmented by the type-specific methods defined in this package.

Use of undocumented package features or direct access to internal data structures is discouraged and could result in program termination or other unpredictable behaviour.  

mname

    $mname = $rr->mname;
    $rr->mname( $mname );

The domain name of the name server that was the original or primary source of data for this zone.  

rname

    $rname = $rr->rname;
    $rr->rname( $rname );

The mailbox which identifies the person responsible for maintaining this zone.  

serial

    $serial = $rr->serial;
    $serial = $rr->serial(value);

Unsigned 32 bit version number of the original copy of the zone. Zone transfers preserve this value.

RFC1982 defines a strict (irreflexive) partial ordering for zone serial numbers. The serial number will be incremented unless the replacement value argument satisfies the ordering constraint.  

refresh

    $refresh = $rr->refresh;
    $rr->refresh( $refresh );

A 32 bit time interval before the zone should be refreshed.  

retry

    $retry = $rr->retry;
    $rr->retry( $retry );

A 32 bit time interval that should elapse before a failed refresh should be retried.  

expire

    $expire = $rr->expire;
    $rr->expire( $expire );

A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.  

minimum

    $minimum = $rr->minimum;
    $rr->minimum( $minimum );

The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone.  

Zone Serial Number Management

The internal logic of the serial() method offers support for several widely used zone serial numbering policies.  

Strictly Sequential

    $successor = $soa->serial( SEQUENTIAL );

The existing serial number is incremented modulo 2**32 because the value returned by the auxilliary SEQUENTIAL() function can never satisfy the serial number ordering constraint.  

Date Encoded

    $successor = $soa->serial( YYYYMMDDxx );

The 32 bit value returned by the auxilliary YYYYMMDDxx() function will be used if it satisfies the ordering constraint, otherwise the serial number will be incremented as above.

Serial number increments must be limited to 100 per day for the date information to remain useful.  

Time Encoded

    $successor = $soa->serial( UNIXTIME );

The 32 bit value returned by the auxilliary UNIXTIME() function will used if it satisfies the ordering constraint, otherwise the existing serial number will be incremented as above.  

COPYRIGHT

Copyright (c)1997 Michael Fuhr.

Portions Copyright (c)2003 Chris Reinhardt.

Portions Copyright (c)2010,2012 Dick Franks.

All rights reserved.

Package template (c)2009,2012 O.M.Kolkman and R.W.Franks.  

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 above copyright notice appear in all copies and that both that 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.

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.  

SEE ALSO

perl, Net::DNS, Net::DNS::RR, RFC1035 Section 3.3.13, RFC1982


 

Index

NAME
SYNOPSIS
DESCRIPTION
METHODS
mname
rname
serial
refresh
retry
expire
minimum
Zone Serial Number Management
Strictly Sequential
Date Encoded
Time Encoded
COPYRIGHT
LICENSE
SEE ALSO