Class: IControl::GlobalLB::Globals

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/global_lb/globals.rb,
lib/icontrol/global_lb.rb

Overview

The Globals interface enables you to set and get global variables.

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#aol_aware_stateEnabledState

Gets the state to indicate whether local DNS servers that belong to AOL (America Online) are recognized.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



16
17
18
# File 'lib/icontrol/global_lb/globals.rb', line 16

def aol_aware_state
  super
end

#auto_configure_stateEnabledState

Gets the state indicating whether to auto configure BIGIP/3DNS servers (automatic addition and deletion of self IPs and virtual servers.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



28
29
30
# File 'lib/icontrol/global_lb/globals.rb', line 28

def auto_configure_state
  super
end

#auto_sync_stateEnabledState

Gets the state to indicate whether to autosync. Allows automatic updates of wideip.conf to/from other 3-DNSes.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



40
41
42
# File 'lib/icontrol/global_lb/globals.rb', line 40

def auto_sync_state
  super
end

#cache_ldns_stateEnabledState

Gets the state to indicate whether to cache LDNSes.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



51
52
53
# File 'lib/icontrol/global_lb/globals.rb', line 51

def cache_ldns_state
  super
end

#check_dynamic_dependency_stateEnabledState

Gets the state to indicate whether to check availability of a path before it uses the path for load balancing.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



63
64
65
# File 'lib/icontrol/global_lb/globals.rb', line 63

def check_dynamic_dependency_state
  super
end

#check_static_dependency_stateEnabledState

Gets the state to indicate whether to check the availability of virtual servers.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



74
75
76
# File 'lib/icontrol/global_lb/globals.rb', line 74

def check_static_dependency_state
  super
end

#default_alternate_lb_methodLBMethod

Gets the default alternate LB method.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



85
86
87
# File 'lib/icontrol/global_lb/globals.rb', line 85

def default_alternate_lb_method
  super
end

#default_fallback_lb_methodLBMethod

Gets the default fallback LB method.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



96
97
98
# File 'lib/icontrol/global_lb/globals.rb', line 96

def default_fallback_lb_method
  super
end

#default_probe_limitlong

Gets the default probe limit, the number of times to probe a path.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



107
108
109
# File 'lib/icontrol/global_lb/globals.rb', line 107

def default_probe_limit
  super
end

#down_multiplelong

Gets the "down_multiple“ valu. If a host server or a host virtual server has been marked down for the last down_threshold probing cycles (timer_get_host_data or timer_get_vs_data respectively), then perform service checks every down_multiple

  • timer period instead.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



121
122
123
# File 'lib/icontrol/global_lb/globals.rb', line 121

def down_multiple
  super
end

#down_thresholdlong

Gets the "down_threshold“ valu. If a host server or a host virtual server has been marked down for the last down_threshold probing cycles (timer_get_host_data or timer_get_vs_data respectively), then perform service checks every down_multiple

  • timer period instead.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



135
136
137
# File 'lib/icontrol/global_lb/globals.rb', line 135

def down_threshold
  super
end

#drain_request_stateEnabledState

Gets the state to indicate whether persistent connections are allowed to remain connected, until TTL expires, when disabling a pool.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



147
148
149
# File 'lib/icontrol/global_lb/globals.rb', line 147

def drain_request_state
  super
end

#dump_topology_stateEnabledState

Gets the state to indicate whether to dump the topology.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



158
159
160
# File 'lib/icontrol/global_lb/globals.rb', line 158

def dump_topology_state
  super
end

#fb_respect_acl_stateEnabledState

Gets the state to indicate whether to respect ACL.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



169
170
171
# File 'lib/icontrol/global_lb/globals.rb', line 169

def fb_respect_acl_state
  super
end

#fb_respect_dependency_stateEnabledState

Gets the state to indicate whether to respect virtual server status when load balancing switches to the fallback mode.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



181
182
183
# File 'lib/icontrol/global_lb/globals.rb', line 181

def fb_respect_dependency_state
  super
end

#ldns_durationlong

Gets the number of seconds that an inactive LDNS remains cached.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



192
193
194
# File 'lib/icontrol/global_lb/globals.rb', line 192

def ldns_duration
  super
end

#ldns_probe_protocolsLDNSProbeProtocol

Gets the LDNS probe protocols. The order of the protocols in the sequence will be used to indicate the preferred protocols, i.e. the first protocol in the sequence is the most preferred protocol.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



205
206
207
# File 'lib/icontrol/global_lb/globals.rb', line 205

def ldns_probe_protocols
  super
end

Gets the link compensate inbound state. If set, the link allotment calculation will take into account traffic which does not flow through the BIGIP, i.e. if more traffic is flowing through a link as measured by SNMP on the router than is flowing through the BIGIP. This applies to inbound traffic which the major volume will initiate from internal clients.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



220
221
222
# File 'lib/icontrol/global_lb/globals.rb', line 220

def link_compensate_inbound_state
  super
end

Gets the link compensate outbound state. If set, the link allotment calculation will take into account traffic which does not flow through the BIGIP, i.e. if more traffic is flowing through a link as measured by SNMP on the router than is flowing through the BIGIP. This applies to outbound traffic which the major volume will initiate from internal clients.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



235
236
237
# File 'lib/icontrol/global_lb/globals.rb', line 235

def link_compensate_outbound_state
  super
end

Gets the link compensation history.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



246
247
248
# File 'lib/icontrol/global_lb/globals.rb', line 246

def link_compensation_history
  super
end

Gets the link limit factor, which is used to set a target percentage for traffic. For example, if it is set to 90, the ratio cost based load-balancing will set a ratio with a maximum valu equal to 90% of the limit valu for the link. Default is 95%.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



259
260
261
# File 'lib/icontrol/global_lb/globals.rb', line 259

def link_limit_factor
  super
end

Gets the link prepaid factor. Maximum percentage of traffic allocated to link which has a traffic allotment which has been prepaid. Default is 95%.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



271
272
273
# File 'lib/icontrol/global_lb/globals.rb', line 271

def link_prepaid_factor
  super
end

#lower_bound_percentage_columnlong

Gets the lower bound percentage column options in Internet Weather Map.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



282
283
284
# File 'lib/icontrol/global_lb/globals.rb', line 282

def lower_bound_percentage_column
  super
end

#lower_bound_percentage_rowlong

Gets the lower bound percentage row options in Internet Weather Map.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



293
294
295
# File 'lib/icontrol/global_lb/globals.rb', line 293

def lower_bound_percentage_row
  super
end

Gets the maximum link over limit count. The count of how many times in a row traffic may be over the defined limit for the link before it is shut off entirely. Default is 1.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



306
307
308
# File 'lib/icontrol/global_lb/globals.rb', line 306

def maximum_link_over_limit_count
  super
end

#maximum_synchronous_monitor_requestlong

Gets the maximum synchronous monitor request, which is used to control the maximum number of monitor requests being sent out at one time for a given probing interval. This will allow the user to smooth out monitor probe requests as much as they desire.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



319
320
321
# File 'lib/icontrol/global_lb/globals.rb', line 319

def maximum_synchronous_monitor_request
  super
end

Gets the over-limit link limit factor. If traffic on a link exceeds the limit, this factor will be used instead of the link_limit_factor until the traffic is over limit for more than max_link_over_limit_count times. Once the limit has been exceeded too many times, all traffic is shut off for the link. The default for over_limit_link_limit_factor is 90%.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



334
335
336
# File 'lib/icontrol/global_lb/globals.rb', line 334

def over_limit_link_limit_factor
  super
end

#path_durationlong

Gets the number of seconds that a path remains cached after its last access.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



345
346
347
# File 'lib/icontrol/global_lb/globals.rb', line 345

def path_duration
  super
end

#path_ttllong

Gets the TTL for the path information.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



356
357
358
# File 'lib/icontrol/global_lb/globals.rb', line 356

def path_ttl
  super
end

#paths_never_die_stateEnabledState

Gets the state indicating whether the dynamic load balancing modes can use path data even after the TTL for the path data has expired..

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



368
369
370
# File 'lib/icontrol/global_lb/globals.rb', line 368

def paths_never_die_state
  super
end

#persistence_masklong

Gets the persistence mask. This function is deprecated and new applications should use get_static_persistence_cidr_mask.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



380
381
382
# File 'lib/icontrol/global_lb/globals.rb', line 380

def persistence_mask
  super
end

#probe_disabled_object_stateEnabledState

Gets the state that if enabled, GTM will still probe disabled object.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



391
392
393
# File 'lib/icontrol/global_lb/globals.rb', line 391

def probe_disabled_object_state
  super
end

#qos_factor_bpslong

Gets the factor used to normalize bits per second when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



403
404
405
# File 'lib/icontrol/global_lb/globals.rb', line 403

def qos_factor_bps
  super
end

#qos_factor_connection_ratelong

Gets the factor used to normalize connection rates when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



416
417
418
# File 'lib/icontrol/global_lb/globals.rb', line 416

def qos_factor_connection_rate
  super
end

#qos_factor_hit_ratiolong

Gets the factor used to normalize ping packet completion rates when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



428
429
430
# File 'lib/icontrol/global_lb/globals.rb', line 428

def qos_factor_hit_ratio
  super
end

#qos_factor_hopslong

Gets the factor used to normalize hops when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



439
440
441
# File 'lib/icontrol/global_lb/globals.rb', line 439

def qos_factor_hops
  super
end

#qos_factor_lcslong

Gets the factor used to normalize link capacity valus when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



451
452
453
# File 'lib/icontrol/global_lb/globals.rb', line 451

def qos_factor_lcs
  super
end

#qos_factor_packet_ratelong

Gets the factor used to normalize packet rates when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



463
464
465
# File 'lib/icontrol/global_lb/globals.rb', line 463

def qos_factor_packet_rate
  super
end

#qos_factor_rttlong

Gets the factor used to normalize round-trip time valus when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



475
476
477
# File 'lib/icontrol/global_lb/globals.rb', line 475

def qos_factor_rtt
  super
end

#qos_factor_topologylong

Gets the factor used to normalize topology valus when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



487
488
489
# File 'lib/icontrol/global_lb/globals.rb', line 487

def qos_factor_topology
  super
end

#qos_factor_vs_capacitylong

Gets the factor used to normalize virtual server capacity valus when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



499
500
501
# File 'lib/icontrol/global_lb/globals.rb', line 499

def qos_factor_vs_capacity
  super
end

#qos_factor_vs_scorelong

Gets the factor used to normalize virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



511
512
513
# File 'lib/icontrol/global_lb/globals.rb', line 511

def qos_factor_vs_score
  super
end

#reset_ripeness_stateEnabledState

Gets the state to indicate whether ripeness valu is allowed to be reset.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



522
523
524
# File 'lib/icontrol/global_lb/globals.rb', line 522

def reset_ripeness_state
  super
end

#rtt_packet_lengthlong

Gets the length of the packet sent out in a probe request to determine path information.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



533
534
535
# File 'lib/icontrol/global_lb/globals.rb', line 533

def rtt_packet_length
  super
end

#rtt_sample_countlong

Gets the number of packets to send out in a probe request to determine path information.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



544
545
546
# File 'lib/icontrol/global_lb/globals.rb', line 544

def rtt_sample_count
  super
end

#rtt_timeoutlong

Gets the timeout for RTT, in seconds.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



555
556
557
# File 'lib/icontrol/global_lb/globals.rb', line 555

def rtt_timeout
  super
end

#set_aol_aware_state(opts) ⇒ Object

Sets the state to indicate whether local DNS servers that belong to AOL (America Online) are recognized.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



742
743
744
745
# File 'lib/icontrol/global_lb/globals.rb', line 742

def set_aol_aware_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_auto_configure_state(opts) ⇒ Object

Sets the state indicating whether to auto configure BIGIP/3DNS servers (automatic addition and deletion of self IPs and virtual servers.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



756
757
758
759
# File 'lib/icontrol/global_lb/globals.rb', line 756

def set_auto_configure_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_auto_sync_state(opts) ⇒ Object

Sets the state to indicate whether to autosync. Allows automatic updates of wideip.conf to/from other 3-DNSes.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



770
771
772
773
# File 'lib/icontrol/global_lb/globals.rb', line 770

def set_auto_sync_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_cache_ldns_state(opts) ⇒ Object

Sets the state to indicate whether to cache LDNSes.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



783
784
785
786
# File 'lib/icontrol/global_lb/globals.rb', line 783

def set_cache_ldns_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_check_dynamic_dependency_state(opts) ⇒ Object

Sets the state to indicate whether to check availability of a path before it uses the path for load balancing.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



797
798
799
800
# File 'lib/icontrol/global_lb/globals.rb', line 797

def set_check_dynamic_dependency_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_check_static_dependency_state(opts) ⇒ Object

Sets the state to indicate whether to check the availability of virtual servers.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



810
811
812
813
# File 'lib/icontrol/global_lb/globals.rb', line 810

def set_check_static_dependency_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_default_alternate_lb_method(opts) ⇒ Object

Sets the default alternate LB method.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



823
824
825
826
# File 'lib/icontrol/global_lb/globals.rb', line 823

def set_default_alternate_lb_method(opts)
  opts = check_params(opts,[:lb_method])
  super(opts)
end

#set_default_fallback_lb_method(opts) ⇒ Object

Sets the default fallback LB method.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



836
837
838
839
# File 'lib/icontrol/global_lb/globals.rb', line 836

def set_default_fallback_lb_method(opts)
  opts = check_params(opts,[:lb_method])
  super(opts)
end

#set_default_probe_limitObject

Sets the default probe limit, the number of times to probe a path.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



847
848
849
# File 'lib/icontrol/global_lb/globals.rb', line 847

def set_default_probe_limit
  super
end

#set_down_multipleObject

Sets the "down_multiple“ valu. If a host server or a host virtual server has been marked down for the last down_threshold probing cycles (timer_get_host_data or timer_get_vs_data respectively), then perform service checks every down_multiple

  • timer period instead.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



860
861
862
# File 'lib/icontrol/global_lb/globals.rb', line 860

def set_down_multiple
  super
end

#set_down_thresholdObject

Sets the "down_threshold“ valu. If a host server or a host virtual server has been marked down for the last down_threshold probing cycles (timer_get_host_data or timer_get_vs_data respectively), then perform service checks every down_multiple

  • timer period instead.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



873
874
875
# File 'lib/icontrol/global_lb/globals.rb', line 873

def set_down_threshold
  super
end

#set_drain_request_state(opts) ⇒ Object

Sets the state to indicate whether persistent connections are allowed to remain connected, until TTL expires, when disabling a pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



886
887
888
889
# File 'lib/icontrol/global_lb/globals.rb', line 886

def set_drain_request_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_dump_topology_state(opts) ⇒ Object

Sets the state to indicate whether to dump the topology.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



899
900
901
902
# File 'lib/icontrol/global_lb/globals.rb', line 899

def set_dump_topology_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_fb_respect_acl_state(opts) ⇒ Object

Sets the state to indicate whether to respect ACL.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



912
913
914
915
# File 'lib/icontrol/global_lb/globals.rb', line 912

def set_fb_respect_acl_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_fb_respect_dependency_state(opts) ⇒ Object

Sets the state to indicate whether to respect virtual server status when load balancing switches to the fallback mode.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



926
927
928
929
# File 'lib/icontrol/global_lb/globals.rb', line 926

def set_fb_respect_dependency_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_ldns_durationObject

Sets the number of seconds that an inactive LDNS remains cached.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



937
938
939
# File 'lib/icontrol/global_lb/globals.rb', line 937

def set_ldns_duration
  super
end

#set_ldns_probe_protocols(opts) ⇒ Object

Sets the LDNS probe protocols. The order of the protocols in the sequence will be used to indicate the preferred protocols, i.e. the first protocol in the sequence is the most preferred protocol. If you'd like to remove an item, get the LDNS probe protocols, remove the item, then do set.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



952
953
954
955
# File 'lib/icontrol/global_lb/globals.rb', line 952

def set_ldns_probe_protocols(opts)
  opts = check_params(opts,[:protocols])
  super(opts)
end

Sets the link compensate inbound state. If set, the link allotment calculation will take into account traffic which does not flow through the BIGIP, i.e. if more traffic is flowing through a link as measured by SNMP on the router than is flowing through the BIGIP. This applies to inbound traffic which the major volume will initiate from internal clients.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



969
970
971
972
# File 'lib/icontrol/global_lb/globals.rb', line 969

def set_link_compensate_inbound_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

Sets the link compensate outbound state. If set, the link allotment calculation will take into account traffic which does not flow through the BIGIP, i.e. if more traffic is flowing through a link as measured by SNMP on the router than is flowing through the BIGIP. This applies to outbound traffic which the major volume will initiate from internal clients.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



986
987
988
989
# File 'lib/icontrol/global_lb/globals.rb', line 986

def set_link_compensate_outbound_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

Sets the link compensation history.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



997
998
999
# File 'lib/icontrol/global_lb/globals.rb', line 997

def set_link_compensation_history
  super
end

Sets the link limit factor, which is used to set a target percentage for traffic. For example, if it is set to 90, the ratio cost based load-balancing will set a ratio with a maximum valu equal to 90% of the limit valu for the link. Default is 95%.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1009
1010
1011
# File 'lib/icontrol/global_lb/globals.rb', line 1009

def set_link_limit_factor
  super
end

Sets the link prepaid factor. Maximum percentage of traffic allocated to link which has a traffic allotment which has been prepaid. Default is 95%.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1020
1021
1022
# File 'lib/icontrol/global_lb/globals.rb', line 1020

def set_link_prepaid_factor
  super
end

#set_lnds_durationObject

Sets the number of seconds that an inactive LDNS remains cached. This function is deprecated (due to being misnamed); new applications should use set_ldns_duration.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1031
1032
1033
# File 'lib/icontrol/global_lb/globals.rb', line 1031

def set_lnds_duration
  super
end

#set_lower_bound_percentage_columnObject

Sets the lower bound percentage column options in Internet Weather Map.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1041
1042
1043
# File 'lib/icontrol/global_lb/globals.rb', line 1041

def set_lower_bound_percentage_column
  super
end

#set_lower_bound_percentage_rowObject

Sets the lower bound percentage row options in Internet Weather Map.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1051
1052
1053
# File 'lib/icontrol/global_lb/globals.rb', line 1051

def set_lower_bound_percentage_row
  super
end

Sets the maximum link over limit count. The count of how many times in a row traffic may be over the defined limit for the link before it is shut off entirely. Default is 1.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1063
1064
1065
# File 'lib/icontrol/global_lb/globals.rb', line 1063

def set_maximum_link_over_limit_count
  super
end

#set_maximum_synchronous_monitor_requestObject

Sets the maximum synchronous monitor request, which is used to control the maximum number of monitor requests being sent out at one time for a given probing interval. This will allow the user to smooth out monitor probe requests as much as they desire.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1075
1076
1077
# File 'lib/icontrol/global_lb/globals.rb', line 1075

def set_maximum_synchronous_monitor_request
  super
end

Sets the over-limit link limit factor. If traffic on a link exceeds the limit, this factor will be used instead of the link_limit_factor until the traffic is over limit for more than max_link_over_limit_count times. Once the limit has been exceeded too many times, all traffic is shut off for the link. The default for over_limit_link_limit_factor is 90%.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1089
1090
1091
# File 'lib/icontrol/global_lb/globals.rb', line 1089

def set_over_limit_link_limit_factor
  super
end

#set_path_durationObject

Sets the number of seconds that a path remains cached after its last access.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1099
1100
1101
# File 'lib/icontrol/global_lb/globals.rb', line 1099

def set_path_duration
  super
end

#set_path_ttlObject

Sets the TTL for the path information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1109
1110
1111
# File 'lib/icontrol/global_lb/globals.rb', line 1109

def set_path_ttl
  super
end

#set_paths_never_die_state(opts) ⇒ Object

Sets the state indicating whether the dynamic load balancing modes can use path data even after the TTL for the path data has expired.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1122
1123
1124
1125
# File 'lib/icontrol/global_lb/globals.rb', line 1122

def set_paths_never_die_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_persistence_maskObject

Sets the persistence mask. This function is deprecated and new applications should use set_static_persistence_cidr_mask.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1134
1135
1136
# File 'lib/icontrol/global_lb/globals.rb', line 1134

def set_persistence_mask
  super
end

#set_probe_disabled_object_state(opts) ⇒ Object

Sets the state that if enabled, GTM will still probe disabled object.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1146
1147
1148
1149
# File 'lib/icontrol/global_lb/globals.rb', line 1146

def set_probe_disabled_object_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_qos_factor_bpsObject

Sets the factor used to normalize bits per second when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1158
1159
1160
# File 'lib/icontrol/global_lb/globals.rb', line 1158

def set_qos_factor_bps
  super
end

#set_qos_factor_connection_rateObject

Sets the factor used to normalize connection rates when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1170
1171
1172
# File 'lib/icontrol/global_lb/globals.rb', line 1170

def set_qos_factor_connection_rate
  super
end

#set_qos_factor_hit_ratioObject

Sets the factor used to normalize ping packet completion rates when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1181
1182
1183
# File 'lib/icontrol/global_lb/globals.rb', line 1181

def set_qos_factor_hit_ratio
  super
end

#set_qos_factor_hopsObject

Sets the factor used to normalize hops when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1191
1192
1193
# File 'lib/icontrol/global_lb/globals.rb', line 1191

def set_qos_factor_hops
  super
end

#set_qos_factor_lcsObject

Sets the factor used to normalize link capacity valus when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1202
1203
1204
# File 'lib/icontrol/global_lb/globals.rb', line 1202

def set_qos_factor_lcs
  super
end

#set_qos_factor_packet_rateObject

Sets the factor used to normalize packet rates when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1213
1214
1215
# File 'lib/icontrol/global_lb/globals.rb', line 1213

def set_qos_factor_packet_rate
  super
end

#set_qos_factor_rttObject

Sets the factor used to normalize round-trip time valus when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1224
1225
1226
# File 'lib/icontrol/global_lb/globals.rb', line 1224

def set_qos_factor_rtt
  super
end

#set_qos_factor_topologyObject

Sets the factor used to normalize topology valus when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1235
1236
1237
# File 'lib/icontrol/global_lb/globals.rb', line 1235

def set_qos_factor_topology
  super
end

#set_qos_factor_vs_capacityObject

Sets the factor used to normalize virtual server capacity valus when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1246
1247
1248
# File 'lib/icontrol/global_lb/globals.rb', line 1246

def set_qos_factor_vs_capacity
  super
end

#set_qos_factor_vs_scoreObject

Sets the factor used to normalize virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1257
1258
1259
# File 'lib/icontrol/global_lb/globals.rb', line 1257

def set_qos_factor_vs_score
  super
end

#set_reset_ripeness_state(opts) ⇒ Object

Sets the state to indicate whether ripeness valu is allowed to be reset.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1269
1270
1271
1272
# File 'lib/icontrol/global_lb/globals.rb', line 1269

def set_reset_ripeness_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_rtt_packet_lengthObject

Sets the length of the packet sent out in a probe request to determine path information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1280
1281
1282
# File 'lib/icontrol/global_lb/globals.rb', line 1280

def set_rtt_packet_length
  super
end

#set_rtt_sample_countObject

Sets the number of packets to send out in a probe request to determine path information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1290
1291
1292
# File 'lib/icontrol/global_lb/globals.rb', line 1290

def set_rtt_sample_count
  super
end

#set_rtt_timeoutObject

Sets the timeout for RTT, in seconds.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1300
1301
1302
# File 'lib/icontrol/global_lb/globals.rb', line 1300

def set_rtt_timeout
  super
end

#set_static_persistence_cidr_mask(opts) ⇒ Object

Sets the CIDR mask (length) for the static persistence load balancing mode.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :v6 (boolean)

    A boolean indicating which CIDR mask to affect, the mask used for protocol IPv4 or IPv6 .

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1312
1313
1314
1315
# File 'lib/icontrol/global_lb/globals.rb', line 1312

def set_static_persistence_cidr_mask(opts)
  opts = check_params(opts,[:v6])
  super(opts)
end

#set_sync_group_name(opts) ⇒ Object

Sets the sync group name.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :sync_group_name (String)

    The sync group name to set.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1325
1326
1327
1328
# File 'lib/icontrol/global_lb/globals.rb', line 1325

def set_sync_group_name(opts)
  opts = check_params(opts,[:sync_group_name])
  super(opts)
end

#set_sync_named_configuration_state(opts) ⇒ Object

Sets the state to indicate whether to auto-synchronize named configuration. Allows automatic updates of named.conf to/from other 3-DNSes.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1339
1340
1341
1342
# File 'lib/icontrol/global_lb/globals.rb', line 1339

def set_sync_named_configuration_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_sync_timeoutObject

Sets the sync timeout. If synch'ing from a remote 3-DNS takes longer than this timeout, then abort the connection.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1351
1352
1353
# File 'lib/icontrol/global_lb/globals.rb', line 1351

def set_sync_timeout
  super
end

#set_sync_zone_timeoutObject

Sets the sync zones timeout. If synch'ing named and zone configuration takes this timeout, then abort the connection.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1362
1363
1364
# File 'lib/icontrol/global_lb/globals.rb', line 1362

def set_sync_zone_timeout
  super
end

#set_time_toleranceObject

Sets the allowable time difference for data to be out of sync between members of a sync group.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1373
1374
1375
# File 'lib/icontrol/global_lb/globals.rb', line 1373

def set_time_tolerance
  super
end

#set_timer_auto_configuration_dataObject

Sets the frequency at which to retrieve auto-configuration data.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1383
1384
1385
# File 'lib/icontrol/global_lb/globals.rb', line 1383

def set_timer_auto_configuration_data
  super
end

#set_timer_persistence_cacheObject

Sets the frequency at which to retrieve path and metrics data from the system cache.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1393
1394
1395
# File 'lib/icontrol/global_lb/globals.rb', line 1393

def set_timer_persistence_cache
  super
end

#set_timer_retry_path_dataObject

Sets the frequency at which to retry path data.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1403
1404
1405
# File 'lib/icontrol/global_lb/globals.rb', line 1403

def set_timer_retry_path_data
  super
end

#set_topology_acl_thresholdObject

Sets the threshold for the topology ACL.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1413
1414
1415
# File 'lib/icontrol/global_lb/globals.rb', line 1413

def set_topology_acl_threshold
  super
end

#set_topology_longest_match_state(opts) ⇒ Object

Sets the state to indicate whether the 3-DNS Controller selects the topology record that is most specific and, thus, has the longest match, in cases where there are several IP/netmask items that match a particular IP address. If you select No, the 3-DNS Controller uses the first topology record that matches (according to the order of entry) in the topology statement.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1429
1430
1431
1432
# File 'lib/icontrol/global_lb/globals.rb', line 1429

def set_topology_longest_match_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#set_traceroute_portObject

Sets the port to use to collect traceroute (hops) data.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1440
1441
1442
# File 'lib/icontrol/global_lb/globals.rb', line 1440

def set_traceroute_port
  super
end

#set_traceroute_ttlObject

Sets the TTL for the traceroute information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1450
1451
1452
# File 'lib/icontrol/global_lb/globals.rb', line 1450

def set_traceroute_ttl
  super
end

#set_use_recursion_bit_state(opts) ⇒ Object

Sets the state that if enabled, it will set the recursion bit in all DNS responses from GTM.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1463
1464
1465
1466
# File 'lib/icontrol/global_lb/globals.rb', line 1463

def set_use_recursion_bit_state(opts)
  opts = check_params(opts,[:state])
  super(opts)
end

#static_persistence_cidr_mask(opts) ⇒ long

Gets the CIDR mask (length) for the static persistence load balancing mode.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :v6 (boolean)

    A boolean indicating which CIDR mask to get, the mask used for protocol IPv4 or IPv6 .

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



568
569
570
571
# File 'lib/icontrol/global_lb/globals.rb', line 568

def static_persistence_cidr_mask(opts)
  opts = check_params(opts,[:v6])
  super(opts)
end

#sync_group_nameString

Gets the sync group name.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



580
581
582
# File 'lib/icontrol/global_lb/globals.rb', line 580

def sync_group_name
  super
end

#sync_named_configuration_stateEnabledState

Gets the state to indicate whether to auto_synchronize named configuration. Allows automatic updates of named.conf to/from other 3-DNSes.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



592
593
594
# File 'lib/icontrol/global_lb/globals.rb', line 592

def sync_named_configuration_state
  super
end

#sync_timeoutlong

Gets the sync timeout. If synch'ing from a remote 3-DNS takes longer than this timeout, then abort the connection.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



604
605
606
# File 'lib/icontrol/global_lb/globals.rb', line 604

def sync_timeout
  super
end

#sync_zone_timeoutlong

Gets the sync zones timeout. If synch'ing named and zone configuration takes this timeout, then abort the connection.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



616
617
618
# File 'lib/icontrol/global_lb/globals.rb', line 616

def sync_zone_timeout
  super
end

#time_tolerancelong

Gets the allowable time difference for data to be out of sync between members of a sync group.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



628
629
630
# File 'lib/icontrol/global_lb/globals.rb', line 628

def time_tolerance
  super
end

#timer_auto_configuration_datalong

Gets the frequency at which to retrieve auto-configuration data.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



639
640
641
# File 'lib/icontrol/global_lb/globals.rb', line 639

def timer_auto_configuration_data
  super
end

#timer_persistence_cachelong

Gets the frequency at which to retrieve path and metrics data from the system cache.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



650
651
652
# File 'lib/icontrol/global_lb/globals.rb', line 650

def timer_persistence_cache
  super
end

#timer_retry_path_datalong

Gets the frequency at which to retry path data.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



661
662
663
# File 'lib/icontrol/global_lb/globals.rb', line 661

def timer_retry_path_data
  super
end

#topology_acl_thresholdlong

Gets the threshold for the topology ACL.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



672
673
674
# File 'lib/icontrol/global_lb/globals.rb', line 672

def topology_acl_threshold
  super
end

#topology_longest_match_stateEnabledState

Gets the state to indicate whether the 3-DNS Controller selects the topology record that is most specific and, thus, has the longest match, in cases where there are several IP/netmask items that match a particular IP address. If you select No, the 3-DNS Controller uses the first topology record that matches (according to the order of entry) in the topology statement.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



687
688
689
# File 'lib/icontrol/global_lb/globals.rb', line 687

def topology_longest_match_state
  super
end

#traceroute_portlong

Gets the port to use to collect traceroute (hops) data.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



698
699
700
# File 'lib/icontrol/global_lb/globals.rb', line 698

def traceroute_port
  super
end

#traceroute_ttllong

Gets the TTL for the traceroute information.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



709
710
711
# File 'lib/icontrol/global_lb/globals.rb', line 709

def traceroute_ttl
  super
end

#use_recursion_bit_stateEnabledState

Gets the state that if enabled, it will set the recursion bit in all DNS responses from GTM.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



721
722
723
# File 'lib/icontrol/global_lb/globals.rb', line 721

def use_recursion_bit_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


729
730
731
# File 'lib/icontrol/global_lb/globals.rb', line 729

def version
  super
end