Infoblox::DTC::Pool::DynamicRatioSetting - An DTC Pool dynamic ratio setting object.
The DTC Pool dynamic ratio setting object provides settings for dynamic ratio load balancing if you later select preferred or alternate as the load balancing method.
my $object = Infoblox::DTC::Pool::DynamicRatioSetting->new( method => 'MONITOR' | 'ROUND_TRIP_DELAY', # Optional monitor => $dtc_monitor, # Optional monitor_metric => $string, # Optional monitor_weighing => 'RATIO' | 'PRIORITY', # Optional invert_monitor_metric => 'true' | 'false', # Optional );
The object does not support any session methods.
The following functions can be applied to the object.
Use this method to set or retrieve the preferred dynamic ratio load balancing settings. See Infoblox::DTC::Pool->dynamic_ratio_preferred() for parameters and return values.
#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 set or retrieve the alternate dynamic ratio load balancing settings. See Infoblox::DTC::Pool->dynamic_ratio_alternate() for parameters and return values.
#get dynamic_ratio_alternate value my $dynamic_ratio_alternate = $pool->dynamic_ratio_alternate();
#modify dynamic_ratio_alternate value $pool->dynamic_ratio_alternate($dynamic_ratio);
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 the dynamic ratio load balancing method.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid values are 'MONITOR' and 'ROUND_TRIP_DELAY'.
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 method value my $method = $object->method();
#Modify method value $object->method('MONITOR');
Use this method to set or retrieve the DTC monitor that will be used for the dynamic ratio load balancing.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an Infoblox::DTC::Monitor::TCP, Infoblox::DTC::Monitor::ICMP, Infoblox::DTC::Monitor::SIP, Infoblox::DTC::Monitor::HTTP, or Infoblox::DTC::Monitor::PDP objects.
Note that you must retrieve the object from the server first, or set the name of the monitor.
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 monitor value my $monitor = $object->monitor();
#Construct Infoblox::DTC::Monitor::SNMP object (should be an existing object) my $snmp_monitor = Infoblox::DTC::Monitor::SNMP->new(name => 'snmp1');
#Modify monitor value $object->monitor($snmp_monitor);
Use this method to set or retrieve the DTC monitor metric that will be used for dynamic weighing.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired metric 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 monitor_metric value my $monitor_metric = $object->monitor_metric();
#Modify monitor_metric value $object->monitor_metric('222');
Use this method to set or retrieve the weighing settings for the dynamic ratio load balancing servers.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid values are 'PRIORITY' and 'RATIO'. 'PRIORITY' means that all clients will be forwarded to the least loaded server. 'RATIO' means that distribution will be calculated based on dynamic weights.
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 monitor_weighing value my $monitor_weighing = $object->monitor_weighing();
#Modify monitor_weighing value $object->monitor_weighing('RATIO');
Use this method to set or retrieve the flag that indicates whether the inverted value of the monitor metric is used.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to force the server to use the inverted monitor metric and 'false' to use the direct metric value. The default 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 invert_monitor_metric value my $invert_monitor_metric = $object->invert_monitor_metric();
#Modify invert_monitor_metric value $object->invert_monitor_metric('true');
Infoblox Inc. http://www.infoblox.com/
Infoblox::DTC::Pool, Infoblox::DTC::Pool->dynamic_ratio_preferred(), Infoblox::DTC::Pool->dynamic_ratio_alternate(), Infoblox::DTC::Monitor::TCP, Infoblox::DTC::Monitor::ICMP, Infoblox::DTC::Monitor::SIP, Infoblox::DTC::Monitor::HTTP, Infoblox::DTC::Monitor::PDP
Copyright (c) 2017 Infoblox Inc.