Infoblox::DTC::Pool - a DTC Pool object.
A DTC Pool object.
my $pool = Infoblox::DTC::Pool->new( name => $string,, #Required lb_preferred_method => 'ALL_AVAILABLE' | 'GLOBAL_AVAILABILITY' | 'RATIO' | 'ROUND_ROBIN' | 'TOPOLOGY' | 'DYNAMIC_RATIO', #Required disable => 'true' | 'false', #Optional / Default is 'false' comment => $string, #Optional / Default is undefined lb_preferred_topology => $topology, #Optional / Default is undefined lb_alternate_method => 'ALL_AVAILABLE' | 'GLOBAL_AVAILABILITY' | 'RATIO' | 'ROUND_ROBIN' | 'TOPOLOGY' | 'DYNAMIC_RATIO', #Optional / Default is undefined lb_alternate_topology => $topology, #Optional / Default is undefined availability => 'ANY' | 'QUORUM' | 'ALL', #Optional / Default is undefined quorum => $uint, #Optional / Default is undefined ttl => $uint, #Optional / Default is undefined override_ttl => 'true' | 'false', #Optional / Default is 'false' monitors => [$monitor1, $monitor2, ...], #Optional / Default is empty list servers => [$server1, $server2, ...], #Optional / Default is empty list dynamic_ratio_preferred => $ratio_setting, #Optional / Default is undefined dynamic_ratio_alternate => $ratio_setting, #Optional / Default is undefined extattrs => { $string => $extattr, ... }, #Optional / Default is undefined extensible_attributes => { $string => $string | $num, $string => [ $string | $num, ... ], ... } #Optional / Default is undefined );
You cannot set both extattrs and extensible_attributes attributes at the same time.
This section describes all the methods in a Session module that you can apply to a DTC Pool object
Use this method to add an object to the Infoblox appliance. See Infoblox::Session->add() for parameters and return values.
#construct an object my $pool = Infoblox::DTC::Pool->new( name => 'pool1', lb_preferred_method => 'RATIO', );
#submit for addition my $response = $session->add($pool);
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 DTC Pool name in a string format. comment - Optional. A DTC Pool comment. extattrs - Optional. A hash reference containing extensible attributes. extensible_attributes - Optional. A hash reference that contains extensible attributes. status_member - Optional. A member which provides object health status, default is Grid.
my @retrieved_objs = $session->get( object => 'Infoblox::DTC::Pool', name => 'pool1', );
my @retrieved_objs = $session->get( object => 'Infoblox::DTC::Pool', extensible_attributes => { 'Site' => 'Santa Clara' } );
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. $pool->comment('this is a modified comment'); #Submit modification my $response = $session->modify($pool);
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::DTC::Pool', name => 'pool1', ); #Find the desired object from the retrieved list. my $desired_pool = $retrieved_objs[0]; #Submit for removal my $response = $session->remove($desired_pool);
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 DTC Pool name in a string format. comment - Optional. A DTC Pool comment. extattrs - Optional. A hash reference containing extensible attributes. extensible_attributes - Optional. A hash reference that contains extensible attributes. status_member - Optional. A member which provides object health status, default is Grid.
my @retrieved_objs = $session->get( object => 'Infoblox::DTC::Pool', name => 'pool1', );
my @retrieved_objs = $session->get( object => 'Infoblox::DTC::Pool', extensible_attributes => { 'Site' => 'Santa Clara' } );
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 an DTC Pool resources availability status.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid values are 'ALL', 'ANY' and 'QUORUM'.
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 availability value my $availability = $pool->availability();
#modify availability value $pool->availability('ANY');
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 = $pool->comment();
#modify comment value $pool->comment('desired comment');
Use this method to set or retrieve the alternate dynamic ratio load balancing settings.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an Infoblox::DTC::Pool::DynamicRatioSetting object.
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 dynamic_ratio_alternate value my $dynamic_ratio_alternate = $pool->dynamic_ratio_alternate();
#Construct dynamic_ratio_alternate value my $dynamic_ratio = Infoblox::DTC::Pool::DynamicRatioSetting->new( method => 'ROUND_TRIP_DELAY', invert_monitor_metric => 'true', );
#modify dynamic_ratio_alternate value $pool->dynamic_ratio_alternate($dynamic_ratio);
Use this method to set or retrieve the preferred dynamic ratio load balancing settings.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an Infoblox::DTC::Pool::DynamicRatioSetting object.
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 dynamic_ratio_preferred value my $dynamic_ratio_preferred = $pool->dynamic_ratio_preferred();
#Construct dynamic_ratio_preferred value my $dynamic_ratio = Infoblox::DTC::Pool::DynamicRatioSetting->new( method => 'ROUND_TRIP_DELAY', invert_monitor_metric => 'true', );
#modify dynamic_ratio_preferred value $pool->dynamic_ratio_preferred($dynamic_ratio);
Use this method to enable or disable a DTC Pool.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to disable a DTC Pool or 'false' to enable it. The default value is 'false'.
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 disable value my $disable = $pool->disable();
#modify disable value $pool->disable('true');
Use this method to set or retrieve the extensible attributes associated with a DTC Pool object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Valid value is a hash reference containing the names of extensible attributes and their associated values (Infoblox::Grid::Extattr objects).
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 extattrs value my $ref_extattrs = $pool->extattrs();
#Modify extattrs $pool->extattrs({ 'Site' => $extattr1, 'Administrator' => $extattr2 });
Use this method to set or retrieve the extensible attributes associated with a DTC Pool object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
For valid values for extensible attributes, see Infoblox::Grid::ExtensibleAttributeDef/Extensible Attribute Values.
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 extensible attributes my $ref_extensible_attributes = $pool->extensible_attributes();
#Modify extensible attributes $pool->extensible_attributes({'Site' => 'Santa Clara', 'Administrator' => ['Peter', 'Tom']});
Use this method to retrieve a DTC Pool health information. This is a read-only attribute.
None
The valid return value is an Infoblox::DTC::Health object.
#get health value my $health = $pool->health();
Use this method to set or retrieve the alternate load balancing method for the DTC Pool object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid values are 'ALL_AVAILABLE', 'DYNAMIC_RATIO', 'NONE', 'GLOBAL_AVAILABILITY', 'RATIO', 'ROUND_ROBIN' and 'TOPOLOGY'.
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 lb_alternate_method value my $lb_alternate_method = $pool->lb_alternate_method();
#modify lb_alternate_method value $pool->lb_alternate_method('RATIO');
Use this method to set or retrieve topology rules for the alternate 'TOPOLOGY' load balancing method for the DTC Pool object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Not that this field will be retrieved from the appliance only if alternate load balancing method is 'TOPOLOGY'.
The valid value is an Infoblox::DTC::Topology object.
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 lb_alternate_topology value my $lb_alternate_topology = $pool->lb_alternate_topology();
#modify lb_alternate_topology value $pool->lb_alternate_topology($lb_alternate_topology);
Use this method to set or retrieve the preferred load balancing method for the DTC Pool object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid values are 'ALL_AVAILABLE', 'DYNAMIC_RATIO', 'GLOBAL_AVAILABILITY', 'RATIO', 'ROUND_ROBIN' and 'TOPOLOGY'.
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 lb_preferred_method value my $lb_preferred_method = $pool->lb_preferred_method();
#modify lb_preferred_method value $pool->lb_preferred_method('RATIO');
Use this method to set or retrieve topology rules for the preferred 'TOPOLOGY' load balancing method for the DTC Pool object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an Infoblox::DTC::Topology object.
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.
Not that this field will be retrieved from the appliance only if preferred load balancing method is 'TOPOLOGY'.
#get lb_preferred_topology value my $lb_preferred_topology = $pool->lb_preferred_topology();
#modify lb_preferred_topology value $pool->lb_preferred_topology($lb_preferred_topology);
Use this method to set or retrieve health monitors related to a DTC Pool object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an array which contains following objects: Infoblox::DTC::Monitor::TCP, Infoblox::DTC::Monitor::ICMP, Infoblox::DTC::Monitor::SIP, Infoblox::DTC::Monitor::HTTP, Infoblox::DTC::Monitor::PDP.
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 monitors value my @monitors = $pool->monitors();
#modify monitors value $pool->monitors([$monitor1, $monitor2]);
Use this method to set or retrieve a DTC Pool name.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired name in a 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 name value my $name = $pool->name();
#modify name value $pool->name('pool1');
The override_ttl attribute controls whether the TTL value in the object is used, instead of the Grid default.
The override_ttl attribute can be specified explicitly. It is also set implicitly when ttl is set to a defined value.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to set override_ttl flag or 'false' to disable it. Default value is 'false'.
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 override_ttl value my $override_ttl = $pool->override_ttl();
#modify override_ttl value $pool->override_ttl('true');
Use this method to set or retrieve the number of monitors that must report the resource as 'up' for 'QUORUM' availability mode to be available.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an unsigned integer.
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 quorum value my $quorum = $pool->quorum();
#modify quorum value $pool->quorum(20);
Use this method to set or retrieve a list of DTC Servers linked to a DTC Pool.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an array of Infoblox::DTC::Server::Link objects.
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 servers value my @servers = $pool->servers();
#modify servers value $pool->servers([$server1, $server2]);
Use this method to set a TTL value.
Setting this method to a defined value implicitly sets the override_ttl method to 'true'. Setting the parameter to undefined causes the appliance to use the Grid default and automatically resets the override_ttl attribute to 'false'.
Note that when ttl is set to a defined value and override_ttl is set to 'false', the last operation takes precedence. Thus the sequence $object->ttl(10); $object->override_ttl('false'); will set override_ttl to 'false', and the sequence $object->override_ttl('false'); $object->ttl(10); will result in override_ttl='true'.
The valid value is an unsigned integer.
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 ttl value my $ttl = $pool->ttl();
#modify ttl value $pool->ttl(10);
Infoblox Inc. http://www.infoblox.com/
Infoblox::Session, Infoblox::Session->add(), Infoblox::Session->get(), Infoblox::Session->modify(), Infoblox::Session->remove(), Infoblox::Session->search(), Infoblox::Grid::Extattr, Infoblox::Grid::ExtensibleAttributeDef/Extensible Attribute Values, Infoblox::DTC::Health, Infoblox::DTC::Pool::DynamicRatioSetting, Infoblox::DTC::Pool::Link, Infoblox::DTC::Server::Link, Infoblox::DTC::Topology, Infoblox::DTC::Monitor::TCP, Infoblox::DTC::Monitor::ICMP, Infoblox::DTC::Mo nitor::SIP, Infoblox::DTC::Monitor::HTTP, Infoblox::DTC::Monitor::PDP.
Copyright (c) 2017 Infoblox Inc.