Infoblox::DNS::DDNS::PrincipalCluster::Group - A DDNS Principal Cluster Group object.

NAME

Infoblox::DNS::DDNS::PrincipalCluster::Group - A DDNS Principal Cluster Group object.

DESCRIPTION

The DDNS Principal Cluster Group object represents a set of DDNS Principal Clusters. A single group can be active at any time.

CONSTRUCTOR

    my $cluster = Infoblox::DNS::DDNS::PrincipalCluster::Group->new(
        name     => $string,                     # Required
        comment  => $string,                     # Optional / Default is undefined
    );

SESSION METHODS

This section describes all the methods in a Session module that you can apply to a DDNS Principal Cluster Group object.

Infoblox::Session->add( )

Use this method to add an object to the Infoblox appliance. See Infoblox::Session->add() for parameters and return values.

Example 
 #construct an object
 my $object = Infoblox::DNS::DDNS::PrincipalCluster::Group->new(
    name  => 'cluster1',
 );

 #submit for addition
 my $response = $session->add($object);

Infoblox::Session->get( )

Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.

Key Reference 
 Apply the following attribute to get a specific object:
  name    - Optional. A DDNS Principal Cluster Group name in a string format.
  comment - Optional. A DDNS Principal Cluster Group comment.
Example 
 my @retrieved_objs = $session->get(
     object => 'Infoblox::DNS::DDNS::PrincipalCluster::Group',
     name   => 'cluster1',
 );

Infoblox::Session->modify( )

Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.

Example 
 #Use method to modify the comment.
 $object->comment('this is a modified comment');
 #Submit modification
 my $response = $session->modify($object);

Infoblox::Session->remove( )

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.

Example 
 #Get the objects with the same name
 my @retrieved_objs = $session->get(
     object => 'Infoblox::DNS::DDNS::PrincipalCluster::Group',
     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);

Infoblox::Session->search( )

Use this method to search for objects in the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.

Key Reference 
 Apply the following attribute to get a specific object:
  name    - Optional. A DDNS Principal Cluster Group name in a string format.
  comment - Optional. A DDNS Principal Cluster Group comment.
Example 
 my @retrieved_objs = $session->get(
     object => 'Infoblox::DNS::DDNS::PrincipalCluster::Group',
     name   => 'group1',
 );

MODULE METHODS

Infoblox::Grid::DNS->ddns_principal_group( )

Use this method to set or retrieve the DDNS Principal Cluster Group. See Infoblox::Grid::DNS->ddns_principal_group() for parameters and return values.

Example 
 #get ddns_principal_group value
 my $ddns_principal_group = $object->ddns_principal_group();

 #modify ddns_principal_group value
 $object->ddns_principal_group($group1);

Infoblox::DNS::Zone->ddns_principal_group( )

Use this method to set or retrieve the DDNS Principal Cluster Group. See Infoblox::DNS::Zone->ddns_principal_group() for parameters and return values.

Example 
 #get ddns_principal_group value
 my $ddns_principal_group = $object->ddns_principal_group();

 #modify ddns_principal_group value
 $object->ddns_principal_group($group1);

Infoblox::DNS::View->ddns_principal_group( )

Use this method to set or retrieve the DDNS Principal Cluster Group. See Infoblox::DNS::View->ddns_principal_group() for parameters and return values.

Example 
 #get ddns_principal_group value
 my $ddns_principal_group = $object->ddns_principal_group();

 #modify ddns_principal_group value
 $object->ddns_principal_group($group1);

METHODS

This section describes all the methods that you can use to set or retrieve the attribute values of the object.

clusters( )

Use this method to retrieve a list of equivalent DDNS principal clusters. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return value is array of an Infoblox::DNS::DDNS::PrincipalCluster objects.

Example 
 #get clusters value
 my $clusters = $object->clusters();

comment( )

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.

Parameter

The valid value is a comment in string format (UTF-8) with a maximum of 256 bytes.

Returns

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.

Example 
 #get comment value
 my $comment = $object->comment();

 #modify comment value
 $object->comment('desired comment');

name( )

Use this method to set or retrieve the DDNS Principal Cluster Group name.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

Desired name in string format with a maximum of 256 bytes.

Returns

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.

Example 
 #get name value
 my $name = $object->name();

 #modify name value
 $object->name('foo');

AUTHOR

Infoblox Inc. http://www.infoblox.com/

SEE ALSO

Infoblox::Session, Infoblox::Session->add(), Infoblox::Session->get(), Infoblox::Session->modify(), Infoblox::Session->remove(), Infoblox::Session->search(), Infoblox::Grid::DNS, Infoblox::Grid::DNS->ddns_principal_group(), Infoblox::DNS::Zone, Infoblox::DNS::Zone->ddns_principal_group(), Infoblox::DNS::View, Infoblox::DNS::View->ddns_principal_group(),

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.