Infoblox::DNS::DDNS::PrincipalCluster - A DDNS Principal Cluster object.
The DDNS Principal Cluster object represents a set of principals such that any principal in a DDNS Principal Cluster can update records created by any other principal in the same cluster.
my $cluster = Infoblox::DNS::DDNS::PrincipalCluster->new(
name => $string, # Required
group => $string, # Required
comment => $string, # Optional / Default is undefined
principals => [$string1, $string2, ...], # Optional / Default is undefined
);
This section describes all the methods in a Session module that you can apply to a DDNS Principal Cluster object.
Use this method to add an object to the Infoblox appliance. See Infoblox::Session->add() for parameters and return values.
#create DDNS principal cluster group
my $cluster_group = Infoblox::DNS::DDNS::PrincipalCluster::Group->new( name => 'cluster_group', ); #submit for addition my $response = $session->add($cluster_group);
#construct an object my $object = Infoblox::DNS::DDNS::PrincipalCluster->new( name => 'cluster1', group => 'cluster_group', );
#submit for addition my $response = $session->add($object);
Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.
Apply the following attribute to get a specific object:
name - Optional. A DDNS Principal cluster name in a string format. comment - Optional. A DDNS Principal cluster comment. group - Optional. A DDNS Principal cluster group name.
my @retrieved_objs = $session->get( object => 'Infoblox::DNS::DDNS::PrincipalCluster', name => 'cluster1', group => 'cluster_group', );
Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.
#Use method to modify the comment. $object->comment('this is a modified comment'); #Submit modification my $response = $session->modify($object);
Use this method to remove an object from the Infoblox appliance. See Infoblox::Session->remove() for parameters and return values.
To remove a specific object, first use get() or search() to retrieve the specific object, and then submit this object for removal.
#Get the objects with the same name my @retrieved_objs = $session->get( object => 'Infoblox::DNS::DDNS::PrincipalCluster', name => 'cluster1', ); #Find the desired object from the retrieved list. my $desired_cluster = $retrieved_objs[0]; #Submit for removal my $response = $session->remove($desired_cluster);
Use this method to search for objects in the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.
Apply the following attribute to get a specific object:
name - Optional. A DDNS Principal Cluster name in a string format. comment - Optional. A DDNS Principal Cluster comment. group - Optional. A DDNS Principal cluster group name.
my @retrieved_objs = $session->get( object => 'Infoblox::DNS::DDNS::PrincipalCluster', name => 'group11', );
Use this method to retrieve a list of DDNS Principal Clusters. See Infoblox::DNS::DDNS::PrincipalCluster::Group->clusters() for parameters and return values.
#get clusters value my $clusters = $object->clusters();
This section describes all the methods that you can use to set or retrieve the attribute values of the object.
Use this method to set or retrieve a descriptive comment.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a comment in string format (UTF-8) with a maximum of 256 bytes.
If you specified a parameter, the method returns 'true' when the modification succeeds, and returns 'false' when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#get comment value my $comment = $object->comment();
#modify comment value $object->comment('desired comment');
Use this method to set or retrieve the DDNS Principal Cluster group the cluster associated with.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a DDNS Principal Cluster group name in string format (UTF-8) with a maximum of 256 bytes.
If you specified a parameter, the method returns 'true' when the modification succeeds, and returns 'false' when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#get group value my $group = $object->group();
#modify group value $object->group('desired_group');
Use this method to set or retrieve the DDNS Principal Cluster name.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Desired name in string format with a maximum of 256 bytes.
If you specified a parameter, the method returns 'true' when the modification succeeds, and returns 'false' when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#get name value my $name = $object->name();
#modify name value $object->name('foo');
Use this method to set or retrieve a list of equivalent principals.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an array of desired principal names in string format.
If you specified a parameter, the method returns 'true' when the modification succeeds, and returns 'false' when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#get principals value my $principals = $object->principals();
#modify principals value $object->principals(['foo', 'bar']);
Infoblox Inc. http://www.infoblox.com/
Infoblox::Session, Infoblox::Session->add(), Infoblox::Session->get(), Infoblox::Session->modify(), Infoblox::Session->remove(), Infoblox::Session->search(), Infoblox::DNS::DDNS::PrincipalCluster::Group, Infoblox::DNS::DDNS::PrincipalCluster::Group->clusters().
Copyright (c) 2017 Infoblox Inc.