NAME

Unix::Conf::Bind8::Conf::Zone - Class for representing the Bind8 zone directive

SYNOPSIS

        Refer to the SYNOPSIS section in Unix::Conf::Bind8 for an overview.

DESCRIPTION

new ()

 Arguments
 NAME             => 'name',
 TYPE             => 'type',            # 'master'|'slave'|'forward'|'stub'|'hint'
 CLASS            => 'class',           # 'in'|'hs'|'hesiod'|'chaos'
 FILE             => 'pathname',
 MASTERS          => [ qw (ip1 ip2) ],  # only if TYPE =~  /'slave'|'stub'/
 FORWARD          => 'yes_no',
 FORWARDERS       => [ qw (ip1 ip2) ],
 CHECK-NAMES      => 'value',           # 'warn'|'fail'|'ignore'
 ALLOW-UPDATE     => [ qw (host1 host2) ],
 ALLOW-QUERY      => [ qw (host1 host2) ],
 ALLOW-TRANSFER   => [ qw (host1 host2) ],
 DIALUP           => 'yes_no',
 NOTIFY           => 'yes_no',
 ALSO-NOTIFY      => [ qw (ip1 ip2) ],

Class constructor Creates a new Unix::Conf::Bind8::Conf::Zone object and returns it if successful, an Err object otherwise. Direct use of this method is deprecated. Use Unix::Conf::Bind8::Conf::new_zone () instead.

name ()

 Arguments
 'zone',    # optional

Object method. Get/Set object's name attribute. If argument is passed, the method tries to set the name attribute to 'zone', and returns true if successful, an Err object otherwise. If no argument is passed, returns the name of the zone, if defined, an Err object otherwise.

class

 Arguments
 'class',     # optional

Object method. Get/Set object's class attribute. If argument is passed, the method tries to set the class attribute to 'class', and returns true if successful, an Err object otherwise. If no argument is passed, returns the class of the zone, if defined, an Err object otherwise.

file

 Arguments
 'file',    # optional

Object method. Get/Set the object's file attribute. If argument is passed, the method tries to set the file attribute to 'file', and returns true if successful, and Err object otherwise. If no argument is passed, returns the file of the zone, if defined, an Err object otherwise.

type ()

 Arguments
 'type',    # optional

Object method. Get/Set the object's type attribute. If argument is passed, the method tries to set the type attribute to 'type', and returns true if successful, an Err object otherwise. If no argument is passed, returns the type of the zone, if defined, an Err object otherwise.

add_masters ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Add the list of IP addresses specified in the argument to the list of masters and return true if successful, an Err object otherwise.

masters ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Get/Set the object's masters attribute. If argument is passed, the method tries to set the masters attribute to the list, and returns true if successful, an Err object otherwise. If no argument is passed, returns an array ref containing the masters list for zone, if defined, an Err object otherwise.

masters_port ()

 Arguments
 'port',     # optional

Object method. Get/Set the object's masters port attribute. If argument is passed, the method tries to set the masters port attribute to 'port', and returns true if successful, an Err object otherwise. If no argument is passed, returns the masters port, if defined, an Err object otherwise.

notify ()

 Arguments
 'yes_no',    # optional

Object method. Get/Set the object's notify attribute. If argument is passed, the method tries to set the notify attribute to 'yes_no', and returns true if successful, an Err object otherwise. If no argument is passed, returns the notify of the zone, if defined, an Err object otherwise.

add_also_notify ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Add the list of IP addresses specified in the argument, to the also_notify list and return true if successful, an Err object otherwise.

also_notify ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Get/Set the object's also_notify attribute. If argument is passed, the method tries to set the also_notify attribute to the list, and returns true if successful, an Err object otherwise. If no argument is passed, returns an array ref containing the also_notify list for zone, if defined, an Err object otherwise.

forward ()

 Arguments
 'yes_no',    # optional

Object method. Get/Set the object's forward attribute. If argument is passed, the method tries to set the forward of the zone object to 'yes_no', and returns true if successful, an Err object otherwise. If no argument is passed, returns the forward of the zone, if defined, an Err object otherwise.

forwarders ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Get/Set the object's forwaders attribute. If argument is passed, the method tries to set the forwaders list of the zone object to the list, and returns true if successful, an Err object otherwise. If no argument is passed, returns an array ref containing the forwaders list for zone, if defined, an Err object otherwise.

add_forwaders ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Add the list of IP addresses specified in the argument, to the forwaders list and return true if successful, an Err object otherwise.

add_allow_transfer ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Add the list of IP addresses specified in the argument, to the allow_transfer list and return true if successful, an Err object otherwise.

allow_transfer ()

 Arguments
 acl_object,    # optional

Object method. Get/Set the object's allow_transfer attribute. This is represented by a Unix::Conf::Bind8::Conf::Acl object. If argument is passed, the method tries to set the allow_transfer attribute, and returns true if successful, an Err object otherwise. If no argument is passed, the method returns the value of the allow_transfer attribute, if defined, an Err object otherwise.

allow_transfer_elements ()

Object method. Returns an array ref containing the elements of allow-transfer acl.

add_allow_query ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Add the list of IP addresses specified in the argument, to the allow_query list and return true if successful, an Err object otherwise.

allow_query ()

 Arguments
 acl_object,    # optional

Object method. Get/Set the object's allow_query attribute. This is represented by a Unix::Conf::Bind8::Conf::Acl object. If argument is passed, the method tries to set the allow_query attribute, and returns true if successful, an Err object otherwise. If no argument is passed, the method returns the value of the allow_query attribute, if defined, an Err object otherwise.

allow_query_elements ()

Object method. Returns an array ref containing the elements of allow-query acl.

add_allow_update ()

 Arguments
 [ qw (ip1 ip2) ],

Object method. Add the list of IP addresses specified in the argument, to the allow_update list and return true if successful, an Err object otherwise.

allow_update ()

 Arguments
 acl_object,    # optional

Object method. Get/Set the object's allow_update attribute. This is represented by a Unix::Conf::Bind8::Conf::Acl object. If argument is passed, the method tries to set the allow_update attribute, and returns true if successful, an Err object otherwise. If no argument is passed, the method returns the value of the allow_update attribute, if defined, an Err object otherwise.

allow_update_elements ()

Object method. Returns an array ref containing the elements of allow-update acl.

check_names ()

 Arguments
 'fail_warn_ignore',    # optional

Object method. Get/Set zone check-names. If argument is passed, the method tries to set the check-names of the zone object to 'fail_warn_ignore', and returns true if successful, an Err object otherwise. If no argument is specified, returns the value of the check-names attribute, if defined, an Err object otherwise.

transfer_source ()

 Arguments
 'IP Address',    # optional

Object method. Get/Set the transfer-source attribute. If argument is passed, the method tries to set the transfer-source attribute to 'IP Address', and returns true if successful, an Err object otherwise. If no argument is passed, returns the value of the transfer-source attribute, if defined, an Err object otherwise.

max_transfer_time_in ()

 Arguments
 number,

Object method. Get/Set the max-transfer-time-in attribute. If argument is passed, the method tries to set the max-transfer-time-in attribute to number, and returns true if successful, an Err object otherwise. If no argument is passed, returns the value of the max-transfer-time-in attribute, if defined, an Err object otherwise.

dialup ()

 Arguments
 'yes_no',    # optional

Object method. Get/Set the object's dialup attribute. If argument is passed, the method tries to set the dialup attribute to 'yes_no', and returns true if successful, an Err object otherwise. If no argument is passed, returns the value of the dialup attribute, if defined, an Err object otherwise.

delete_directive ()

 Arguments
 'directive',

Object method. Deletes the directive passed as argument, if defined, and returns true, an Err object otherwise.

get_db ()

 Arguments,
 number,    # 0/1 secure open

Constructor This method is a wrapper method of the class constructor of the Unix::Conf::Bind8::DB class. Creates and returns a new Unix::Conf::Bind8::DB object representing the records file for the zone, if successful, an error object otherwise.

TODO

delete_zonedir* style methods could be autocreated through closures. Also there must be methods to delete individual members of ALLOW-UPDATE style attributes.