icontrol 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/lib/icontrol/arx.rb +38 -8
- data/lib/icontrol/arx/api.rb +1 -0
- data/lib/icontrol/arx/chassis.rb +11 -0
- data/lib/icontrol/arx/export.rb +4 -1
- data/lib/icontrol/arx/file_change_notification.rb +25 -4
- data/lib/icontrol/arx/file_server.rb +2 -0
- data/lib/icontrol/arx/namespace.rb +2 -0
- data/lib/icontrol/arx/network.rb +3 -0
- data/lib/icontrol/arx/policy.rb +3 -0
- data/lib/icontrol/arx/share.rb +2 -0
- data/lib/icontrol/arx/virtual_service.rb +3 -0
- data/lib/icontrol/arx/volume.rb +2 -0
- data/lib/icontrol/asm.rb +18 -3
- data/lib/icontrol/asm/object_params.rb +12 -6
- data/lib/icontrol/asm/policy.rb +118 -79
- data/lib/icontrol/asm/system_configuration.rb +27 -19
- data/lib/icontrol/asm/web_application.rb +74 -52
- data/lib/icontrol/asm/web_application_group.rb +33 -24
- data/lib/icontrol/base.rb +1 -0
- data/lib/icontrol/base/exception.rb +1 -0
- data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
- data/lib/icontrol/base/icontrol_overlay.rb +6 -0
- data/lib/icontrol/base/predeclarations.rb +5 -4
- data/lib/icontrol/base/struct.rb +6 -2
- data/lib/icontrol/common.rb +55 -4
- data/lib/icontrol/global_lb.rb +22 -3
- data/lib/icontrol/global_lb/application.rb +63 -44
- data/lib/icontrol/global_lb/data_center.rb +82 -58
- data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
- data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
- data/lib/icontrol/global_lb/globals.rb +662 -430
- data/lib/icontrol/global_lb/link.rb +181 -131
- data/lib/icontrol/global_lb/monitor.rb +174 -104
- data/lib/icontrol/global_lb/pool.rb +290 -203
- data/lib/icontrol/global_lb/pool_member.rb +118 -71
- data/lib/icontrol/global_lb/region.rb +37 -25
- data/lib/icontrol/global_lb/rule.rb +53 -37
- data/lib/icontrol/global_lb/server.rb +176 -124
- data/lib/icontrol/global_lb/topology.rb +41 -27
- data/lib/icontrol/global_lb/virtual_server.rb +118 -84
- data/lib/icontrol/global_lb/wide_ip.rb +168 -117
- data/lib/icontrol/local_lb.rb +81 -10
- data/lib/icontrol/local_lb/klass.rb +233 -153
- data/lib/icontrol/local_lb/monitor.rb +158 -96
- data/lib/icontrol/local_lb/nat.rb +74 -52
- data/lib/icontrol/local_lb/node_address.rb +123 -86
- data/lib/icontrol/local_lb/pool.rb +229 -164
- data/lib/icontrol/local_lb/pool_member.rb +134 -76
- data/lib/icontrol/local_lb/profile_auth.rb +103 -75
- data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
- data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
- data/lib/icontrol/local_lb/profile_dns.rb +65 -46
- data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
- data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
- data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
- data/lib/icontrol/local_lb/profile_http.rb +701 -433
- data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
- data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
- data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
- data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
- data/lib/icontrol/local_lb/profile_radius.rb +94 -62
- data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
- data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
- data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
- data/lib/icontrol/local_lb/profile_sip.rb +145 -99
- data/lib/icontrol/local_lb/profile_stream.rb +71 -51
- data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
- data/lib/icontrol/local_lb/profile_udp.rb +109 -78
- data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
- data/lib/icontrol/local_lb/profile_xml.rb +116 -79
- data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
- data/lib/icontrol/local_lb/rate_class.rb +523 -318
- data/lib/icontrol/local_lb/rule.rb +53 -37
- data/lib/icontrol/local_lb/snat.rb +96 -65
- data/lib/icontrol/local_lb/snat_pool.rb +54 -39
- data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
- data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
- data/lib/icontrol/local_lb/virtual_address.rb +99 -70
- data/lib/icontrol/local_lb/virtual_server.rb +358 -243
- data/lib/icontrol/lt_config.rb +8 -1
- data/lib/icontrol/lt_config/field.rb +87 -53
- data/lib/icontrol/lt_config/klass.rb +59 -43
- data/lib/icontrol/management.rb +80 -38
- data/lib/icontrol/management/ccldap_configuration.rb +218 -144
- data/lib/icontrol/management/change_control.rb +67 -41
- data/lib/icontrol/management/crldp_configuration.rb +73 -52
- data/lib/icontrol/management/crldp_server.rb +55 -39
- data/lib/icontrol/management/db_variable.rb +32 -21
- data/lib/icontrol/management/event_notification.rb +19 -8
- data/lib/icontrol/management/event_subscription.rb +121 -74
- data/lib/icontrol/management/key_certificate.rb +235 -138
- data/lib/icontrol/management/ldap_configuration.rb +249 -179
- data/lib/icontrol/management/license_administration.rb +97 -56
- data/lib/icontrol/management/named.rb +103 -67
- data/lib/icontrol/management/ocsp_configuration.rb +33 -24
- data/lib/icontrol/management/ocsp_responder.rb +294 -165
- data/lib/icontrol/management/partition.rb +42 -23
- data/lib/icontrol/management/provision.rb +73 -39
- data/lib/icontrol/management/radius_configuration.rb +85 -57
- data/lib/icontrol/management/radius_server.rb +51 -37
- data/lib/icontrol/management/resource_record.rb +163 -121
- data/lib/icontrol/management/snmp_configuration.rb +675 -390
- data/lib/icontrol/management/tacacs_configuration.rb +99 -67
- data/lib/icontrol/management/tmos_module.rb +20 -8
- data/lib/icontrol/management/user_management.rb +198 -124
- data/lib/icontrol/management/view.rb +33 -24
- data/lib/icontrol/management/zone.rb +49 -34
- data/lib/icontrol/management/zone_runner.rb +11 -7
- data/lib/icontrol/networking.rb +31 -4
- data/lib/icontrol/networking/admin_ip.rb +92 -71
- data/lib/icontrol/networking/arp.rb +41 -28
- data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
- data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
- data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
- data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
- data/lib/icontrol/networking/interfaces.rb +241 -142
- data/lib/icontrol/networking/packet_filter.rb +111 -69
- data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
- data/lib/icontrol/networking/port_mirror.rb +39 -27
- data/lib/icontrol/networking/profile_gre.rb +63 -41
- data/lib/icontrol/networking/profile_ipip.rb +38 -25
- data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
- data/lib/icontrol/networking/route_domain.rb +70 -44
- data/lib/icontrol/networking/route_table.rb +128 -91
- data/lib/icontrol/networking/self_ip.rb +57 -39
- data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
- data/lib/icontrol/networking/stp_globals.rb +115 -63
- data/lib/icontrol/networking/stp_instance.rb +166 -68
- data/lib/icontrol/networking/trunk.rb +165 -101
- data/lib/icontrol/networking/tunnel.rb +77 -52
- data/lib/icontrol/networking/vlan.rb +140 -98
- data/lib/icontrol/networking/vlan_group.rb +145 -101
- data/lib/icontrol/system.rb +70 -33
- data/lib/icontrol/system/cluster.rb +103 -81
- data/lib/icontrol/system/config_sync.rb +128 -72
- data/lib/icontrol/system/connections.rb +27 -17
- data/lib/icontrol/system/disk.rb +134 -67
- data/lib/icontrol/system/failover.rb +44 -27
- data/lib/icontrol/system/geo_ip.rb +16 -5
- data/lib/icontrol/system/inet.rb +47 -30
- data/lib/icontrol/system/internal.rb +13 -9
- data/lib/icontrol/system/services.rb +75 -42
- data/lib/icontrol/system/software_management.rb +132 -83
- data/lib/icontrol/system/statistics.rb +443 -298
- data/lib/icontrol/system/system_info.rb +137 -95
- data/lib/icontrol/web_accelerator/applications.rb +17 -10
- data/lib/icontrol/web_accelerator/policies.rb +13 -9
- data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
- data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
- data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
- metadata +10 -4
|
@@ -6,471 +6,563 @@ module IControl::GlobalLB
|
|
|
6
6
|
set_id_name "value"
|
|
7
7
|
|
|
8
8
|
##
|
|
9
|
-
# Gets the state to indicate whether local DNS servers that belong to AOL (America
|
|
9
|
+
# Gets the state to indicate whether local DNS servers that belong to AOL (America
|
|
10
|
+
# Online) are recognized.
|
|
11
|
+
# @rspec_example
|
|
10
12
|
# @return [EnabledState]
|
|
11
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
12
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
13
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
13
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
14
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
15
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
14
16
|
def aol_aware_state
|
|
15
17
|
super
|
|
16
18
|
end
|
|
17
19
|
|
|
18
20
|
##
|
|
19
|
-
# Gets the state indicating whether to auto configure BIGIP/3DNS servers (automatic
|
|
21
|
+
# Gets the state indicating whether to auto configure BIGIP/3DNS servers (automatic
|
|
22
|
+
# addition and deletion of self IPs and virtual servers.
|
|
23
|
+
# @rspec_example
|
|
20
24
|
# @return [EnabledState]
|
|
21
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
22
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
23
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
25
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
26
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
27
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
24
28
|
def auto_configure_state
|
|
25
29
|
super
|
|
26
30
|
end
|
|
27
31
|
|
|
28
32
|
##
|
|
29
|
-
# Gets the state to indicate whether to autosync. Allows automatic updates of wideip.conf
|
|
33
|
+
# Gets the state to indicate whether to autosync. Allows automatic updates of wideip.conf
|
|
34
|
+
# to/from other 3-DNSes.
|
|
35
|
+
# @rspec_example
|
|
30
36
|
# @return [EnabledState]
|
|
31
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
32
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
33
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
37
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
38
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
39
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
34
40
|
def auto_sync_state
|
|
35
41
|
super
|
|
36
42
|
end
|
|
37
43
|
|
|
38
44
|
##
|
|
39
45
|
# Gets the state to indicate whether to cache LDNSes.
|
|
46
|
+
# @rspec_example
|
|
40
47
|
# @return [EnabledState]
|
|
41
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
42
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
43
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
48
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
49
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
50
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
44
51
|
def cache_ldns_state
|
|
45
52
|
super
|
|
46
53
|
end
|
|
47
54
|
|
|
48
55
|
##
|
|
49
|
-
# Gets the state to indicate whether to check availability of a path before it uses
|
|
56
|
+
# Gets the state to indicate whether to check availability of a path before it uses
|
|
57
|
+
# the path for load balancing.
|
|
58
|
+
# @rspec_example
|
|
50
59
|
# @return [EnabledState]
|
|
51
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
52
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
53
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
60
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
61
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
62
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
54
63
|
def check_dynamic_dependency_state
|
|
55
64
|
super
|
|
56
65
|
end
|
|
57
66
|
|
|
58
67
|
##
|
|
59
68
|
# Gets the state to indicate whether to check the availability of virtual servers.
|
|
69
|
+
# @rspec_example
|
|
60
70
|
# @return [EnabledState]
|
|
61
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
62
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
63
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
71
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
72
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
73
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
64
74
|
def check_static_dependency_state
|
|
65
75
|
super
|
|
66
76
|
end
|
|
67
77
|
|
|
68
78
|
##
|
|
69
79
|
# Gets the default alternate LB method.
|
|
80
|
+
# @rspec_example
|
|
70
81
|
# @return [LBMethod]
|
|
71
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
72
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
73
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
82
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
83
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
84
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
74
85
|
def default_alternate_lb_method
|
|
75
86
|
super
|
|
76
87
|
end
|
|
77
88
|
|
|
78
89
|
##
|
|
79
90
|
# Gets the default fallback LB method.
|
|
91
|
+
# @rspec_example
|
|
80
92
|
# @return [LBMethod]
|
|
81
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
82
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
83
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
93
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
94
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
95
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
84
96
|
def default_fallback_lb_method
|
|
85
97
|
super
|
|
86
98
|
end
|
|
87
99
|
|
|
88
100
|
##
|
|
89
101
|
# Gets the default probe limit, the number of times to probe a path.
|
|
102
|
+
# @rspec_example
|
|
90
103
|
# @return [long]
|
|
91
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
92
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
93
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
104
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
105
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
106
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
94
107
|
def default_probe_limit
|
|
95
108
|
super
|
|
96
109
|
end
|
|
97
110
|
|
|
98
111
|
##
|
|
99
|
-
# Gets the "down_multiple" valu. If a host server or a host virtual server
|
|
112
|
+
# Gets the "down_multiple" valu. If a host server or a host virtual server
|
|
113
|
+
# has been marked down for the last down_threshold probing cycles (timer_get_host_data
|
|
114
|
+
# or timer_get_vs_data respectively), then perform service checks every down_multiple
|
|
115
|
+
# * timer period instead.
|
|
116
|
+
# @rspec_example
|
|
100
117
|
# @return [long]
|
|
101
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
102
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
103
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
118
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
119
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
120
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
104
121
|
def down_multiple
|
|
105
122
|
super
|
|
106
123
|
end
|
|
107
124
|
|
|
108
125
|
##
|
|
109
|
-
# Gets the "down_threshold" valu. If a host server or a host virtual server
|
|
126
|
+
# Gets the "down_threshold" valu. If a host server or a host virtual server
|
|
127
|
+
# has been marked down for the last down_threshold probing cycles (timer_get_host_data
|
|
128
|
+
# or timer_get_vs_data respectively), then perform service checks every down_multiple
|
|
129
|
+
# * timer period instead.
|
|
130
|
+
# @rspec_example
|
|
110
131
|
# @return [long]
|
|
111
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
112
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
113
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
132
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
133
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
134
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
114
135
|
def down_threshold
|
|
115
136
|
super
|
|
116
137
|
end
|
|
117
138
|
|
|
118
139
|
##
|
|
119
|
-
# Gets the state to indicate whether persistent connections are allowed to remain connected,
|
|
140
|
+
# Gets the state to indicate whether persistent connections are allowed to remain connected,
|
|
141
|
+
# until TTL expires, when disabling a pool.
|
|
142
|
+
# @rspec_example
|
|
120
143
|
# @return [EnabledState]
|
|
121
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
122
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
123
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
144
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
145
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
146
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
124
147
|
def drain_request_state
|
|
125
148
|
super
|
|
126
149
|
end
|
|
127
150
|
|
|
128
151
|
##
|
|
129
152
|
# Gets the state to indicate whether to dump the topology.
|
|
153
|
+
# @rspec_example
|
|
130
154
|
# @return [EnabledState]
|
|
131
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
132
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
133
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
155
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
156
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
157
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
134
158
|
def dump_topology_state
|
|
135
159
|
super
|
|
136
160
|
end
|
|
137
161
|
|
|
138
162
|
##
|
|
139
163
|
# Gets the state to indicate whether to respect ACL.
|
|
164
|
+
# @rspec_example
|
|
140
165
|
# @return [EnabledState]
|
|
141
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
142
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
143
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
166
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
167
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
168
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
144
169
|
def fb_respect_acl_state
|
|
145
170
|
super
|
|
146
171
|
end
|
|
147
172
|
|
|
148
173
|
##
|
|
149
|
-
# Gets the state to indicate whether to respect virtual server status when load balancing
|
|
174
|
+
# Gets the state to indicate whether to respect virtual server status when load balancing
|
|
175
|
+
# switches to the fallback mode.
|
|
176
|
+
# @rspec_example
|
|
150
177
|
# @return [EnabledState]
|
|
151
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
152
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
153
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
178
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
179
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
180
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
154
181
|
def fb_respect_dependency_state
|
|
155
182
|
super
|
|
156
183
|
end
|
|
157
184
|
|
|
158
185
|
##
|
|
159
186
|
# Gets the number of seconds that an inactive LDNS remains cached.
|
|
187
|
+
# @rspec_example
|
|
160
188
|
# @return [long]
|
|
161
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
162
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
163
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
189
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
190
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
191
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
164
192
|
def ldns_duration
|
|
165
193
|
super
|
|
166
194
|
end
|
|
167
195
|
|
|
168
196
|
##
|
|
169
|
-
# Gets the LDNS probe protocols. The order of the protocols in the sequence will be
|
|
197
|
+
# Gets the LDNS probe protocols. The order of the protocols in the sequence will be
|
|
198
|
+
# used to indicate the preferred protocols, i.e. the first protocol in the sequence
|
|
199
|
+
# is the most preferred protocol.
|
|
200
|
+
# @rspec_example
|
|
170
201
|
# @return [LDNSProbeProtocol]
|
|
171
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
172
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
173
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
202
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
203
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
204
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
174
205
|
def ldns_probe_protocols
|
|
175
206
|
super
|
|
176
207
|
end
|
|
177
208
|
|
|
178
209
|
##
|
|
179
|
-
# Gets the link compensate inbound state. If set, the link allotment calculation will
|
|
210
|
+
# Gets the link compensate inbound state. If set, the link allotment calculation will
|
|
211
|
+
# take into account traffic which does not flow through the BIGIP, i.e. if more traffic
|
|
212
|
+
# is flowing through a link as measured by SNMP on the router than is flowing through
|
|
213
|
+
# the BIGIP. This applies to inbound traffic which the major volume will initiate from
|
|
214
|
+
# internal clients.
|
|
215
|
+
# @rspec_example
|
|
180
216
|
# @return [EnabledState]
|
|
181
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
182
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
183
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
217
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
218
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
219
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
184
220
|
def link_compensate_inbound_state
|
|
185
221
|
super
|
|
186
222
|
end
|
|
187
223
|
|
|
188
224
|
##
|
|
189
|
-
# Gets the link compensate outbound state. If set, the link allotment calculation will
|
|
225
|
+
# Gets the link compensate outbound state. If set, the link allotment calculation will
|
|
226
|
+
# take into account traffic which does not flow through the BIGIP, i.e. if more traffic
|
|
227
|
+
# is flowing through a link as measured by SNMP on the router than is flowing through
|
|
228
|
+
# the BIGIP. This applies to outbound traffic which the major volume will initiate
|
|
229
|
+
# from internal clients.
|
|
230
|
+
# @rspec_example
|
|
190
231
|
# @return [EnabledState]
|
|
191
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
192
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
193
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
232
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
233
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
234
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
194
235
|
def link_compensate_outbound_state
|
|
195
236
|
super
|
|
196
237
|
end
|
|
197
238
|
|
|
198
239
|
##
|
|
199
240
|
# Gets the link compensation history.
|
|
241
|
+
# @rspec_example
|
|
200
242
|
# @return [long]
|
|
201
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
202
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
203
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
243
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
244
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
245
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
204
246
|
def link_compensation_history
|
|
205
247
|
super
|
|
206
248
|
end
|
|
207
249
|
|
|
208
250
|
##
|
|
209
|
-
# Gets the link limit factor, which is used to set a target percentage for traffic.
|
|
251
|
+
# Gets the link limit factor, which is used to set a target percentage for traffic.
|
|
252
|
+
# For example, if it is set to 90, the ratio cost based load-balancing will set a ratio
|
|
253
|
+
# with a maximum valu equal to 90% of the limit valu for the link. Default is 95%.
|
|
254
|
+
# @rspec_example
|
|
210
255
|
# @return [long]
|
|
211
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
212
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
213
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
256
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
257
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
258
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
214
259
|
def link_limit_factor
|
|
215
260
|
super
|
|
216
261
|
end
|
|
217
262
|
|
|
218
263
|
##
|
|
219
|
-
# Gets the link prepaid factor. Maximum percentage of traffic allocated to link which
|
|
264
|
+
# Gets the link prepaid factor. Maximum percentage of traffic allocated to link which
|
|
265
|
+
# has a traffic allotment which has been prepaid. Default is 95%.
|
|
266
|
+
# @rspec_example
|
|
220
267
|
# @return [long]
|
|
221
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
222
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
223
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
268
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
269
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
270
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
224
271
|
def link_prepaid_factor
|
|
225
272
|
super
|
|
226
273
|
end
|
|
227
274
|
|
|
228
275
|
##
|
|
229
276
|
# Gets the lower bound percentage column options in Internet Weather Map.
|
|
277
|
+
# @rspec_example
|
|
230
278
|
# @return [long]
|
|
231
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
232
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
233
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
279
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
280
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
281
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
234
282
|
def lower_bound_percentage_column
|
|
235
283
|
super
|
|
236
284
|
end
|
|
237
285
|
|
|
238
286
|
##
|
|
239
287
|
# Gets the lower bound percentage row options in Internet Weather Map.
|
|
288
|
+
# @rspec_example
|
|
240
289
|
# @return [long]
|
|
241
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
242
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
243
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
290
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
291
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
292
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
244
293
|
def lower_bound_percentage_row
|
|
245
294
|
super
|
|
246
295
|
end
|
|
247
296
|
|
|
248
297
|
##
|
|
249
|
-
# Gets the maximum link over limit count. The count of how many times in a row traffic
|
|
298
|
+
# Gets the maximum link over limit count. The count of how many times in a row traffic
|
|
299
|
+
# may be over the defined limit for the link before it is shut off entirely. Default
|
|
300
|
+
# is 1.
|
|
301
|
+
# @rspec_example
|
|
250
302
|
# @return [long]
|
|
251
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
252
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
253
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
303
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
304
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
305
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
254
306
|
def maximum_link_over_limit_count
|
|
255
307
|
super
|
|
256
308
|
end
|
|
257
309
|
|
|
258
310
|
##
|
|
259
|
-
# Gets the maximum synchronous monitor request, which is used to control the maximum
|
|
311
|
+
# Gets the maximum synchronous monitor request, which is used to control the maximum
|
|
312
|
+
# number of monitor requests being sent out at one time for a given probing interval.
|
|
313
|
+
# This will allow the user to smooth out monitor probe requests as much as they desire.
|
|
314
|
+
# @rspec_example
|
|
260
315
|
# @return [long]
|
|
261
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
262
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
263
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
316
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
317
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
318
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
264
319
|
def maximum_synchronous_monitor_request
|
|
265
320
|
super
|
|
266
321
|
end
|
|
267
322
|
|
|
268
323
|
##
|
|
269
|
-
# Gets the over-limit link limit factor. If traffic on a link exceeds the limit, this
|
|
324
|
+
# Gets the over-limit link limit factor. If traffic on a link exceeds the limit, this
|
|
325
|
+
# factor will be used instead of the link_limit_factor until the traffic is over limit
|
|
326
|
+
# for more than max_link_over_limit_count times. Once the limit has been exceeded too
|
|
327
|
+
# many times, all traffic is shut off for the link. The default for over_limit_link_limit_factor
|
|
328
|
+
# is 90%.
|
|
329
|
+
# @rspec_example
|
|
270
330
|
# @return [long]
|
|
271
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
272
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
273
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
331
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
332
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
333
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
274
334
|
def over_limit_link_limit_factor
|
|
275
335
|
super
|
|
276
336
|
end
|
|
277
337
|
|
|
278
338
|
##
|
|
279
339
|
# Gets the number of seconds that a path remains cached after its last access.
|
|
340
|
+
# @rspec_example
|
|
280
341
|
# @return [long]
|
|
281
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
282
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
283
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
342
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
343
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
344
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
284
345
|
def path_duration
|
|
285
346
|
super
|
|
286
347
|
end
|
|
287
348
|
|
|
288
349
|
##
|
|
289
350
|
# Gets the TTL for the path information.
|
|
351
|
+
# @rspec_example
|
|
290
352
|
# @return [long]
|
|
291
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
292
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
293
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
353
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
354
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
355
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
294
356
|
def path_ttl
|
|
295
357
|
super
|
|
296
358
|
end
|
|
297
359
|
|
|
298
360
|
##
|
|
299
|
-
# Gets the state indicating whether the dynamic load balancing modes can use path data
|
|
361
|
+
# Gets the state indicating whether the dynamic load balancing modes can use path data
|
|
362
|
+
# even after the TTL for the path data has expired..
|
|
363
|
+
# @rspec_example
|
|
300
364
|
# @return [EnabledState]
|
|
301
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
302
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
303
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
365
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
366
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
367
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
304
368
|
def paths_never_die_state
|
|
305
369
|
super
|
|
306
370
|
end
|
|
307
371
|
|
|
308
372
|
##
|
|
309
|
-
# Gets the persistence mask. This function is deprecated and new applications should
|
|
373
|
+
# Gets the persistence mask. This function is deprecated and new applications should
|
|
374
|
+
# use get_static_persistence_cidr_mask.
|
|
375
|
+
# @rspec_example
|
|
310
376
|
# @return [long]
|
|
311
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
312
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
313
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
377
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
378
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
379
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
314
380
|
def persistence_mask
|
|
315
381
|
super
|
|
316
382
|
end
|
|
317
383
|
|
|
318
384
|
##
|
|
319
385
|
# Gets the state that if enabled, GTM will still probe disabled object.
|
|
386
|
+
# @rspec_example
|
|
320
387
|
# @return [EnabledState]
|
|
321
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
322
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
323
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
388
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
389
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
390
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
324
391
|
def probe_disabled_object_state
|
|
325
392
|
super
|
|
326
393
|
end
|
|
327
394
|
|
|
328
395
|
##
|
|
329
|
-
# Gets the factor used to normalize bits per second when the load balancing mode is
|
|
396
|
+
# Gets the factor used to normalize bits per second when the load balancing mode is
|
|
397
|
+
# set to LB_METHOD_QOS.
|
|
398
|
+
# @rspec_example
|
|
330
399
|
# @return [long]
|
|
331
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
332
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
333
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
400
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
401
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
402
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
334
403
|
def qos_factor_bps
|
|
335
404
|
super
|
|
336
405
|
end
|
|
337
406
|
|
|
338
407
|
##
|
|
339
|
-
# Gets the factor used to normalize connection rates when the load balancing mode is
|
|
408
|
+
# Gets the factor used to normalize connection rates when the load balancing mode is
|
|
409
|
+
# set to LB_METHOD_QOS. This function is deprecated and new applications should use
|
|
410
|
+
# vs_score.
|
|
411
|
+
# @rspec_example
|
|
340
412
|
# @return [long]
|
|
341
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
342
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
343
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
413
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
414
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
415
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
344
416
|
def qos_factor_connection_rate
|
|
345
417
|
super
|
|
346
418
|
end
|
|
347
419
|
|
|
348
420
|
##
|
|
349
|
-
# Gets the factor used to normalize ping packet completion rates when the load balancing
|
|
421
|
+
# Gets the factor used to normalize ping packet completion rates when the load balancing
|
|
422
|
+
# mode is set to LB_METHOD_QOS.
|
|
423
|
+
# @rspec_example
|
|
350
424
|
# @return [long]
|
|
351
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
352
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
353
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
425
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
426
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
427
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
354
428
|
def qos_factor_hit_ratio
|
|
355
429
|
super
|
|
356
430
|
end
|
|
357
431
|
|
|
358
432
|
##
|
|
359
433
|
# Gets the factor used to normalize hops when the load balancing mode is set to LB_METHOD_QOS.
|
|
434
|
+
# @rspec_example
|
|
360
435
|
# @return [long]
|
|
361
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
362
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
363
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
436
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
437
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
438
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
364
439
|
def qos_factor_hops
|
|
365
440
|
super
|
|
366
441
|
end
|
|
367
442
|
|
|
368
443
|
##
|
|
369
|
-
# Gets the factor used to normalize link capacity valus when the load balancing mode
|
|
444
|
+
# Gets the factor used to normalize link capacity valus when the load balancing mode
|
|
445
|
+
# is set to LB_METHOD_QOS.
|
|
446
|
+
# @rspec_example
|
|
370
447
|
# @return [long]
|
|
371
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
372
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
373
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
448
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
449
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
450
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
374
451
|
def qos_factor_lcs
|
|
375
452
|
super
|
|
376
453
|
end
|
|
377
454
|
|
|
378
455
|
##
|
|
379
|
-
# Gets the factor used to normalize packet rates when the load balancing mode is set
|
|
456
|
+
# Gets the factor used to normalize packet rates when the load balancing mode is set
|
|
457
|
+
# to LB_METHOD_QOS.
|
|
458
|
+
# @rspec_example
|
|
380
459
|
# @return [long]
|
|
381
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
382
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
383
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
460
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
461
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
462
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
384
463
|
def qos_factor_packet_rate
|
|
385
464
|
super
|
|
386
465
|
end
|
|
387
466
|
|
|
388
467
|
##
|
|
389
|
-
# Gets the factor used to normalize round-trip time valus when the load balancing mode
|
|
468
|
+
# Gets the factor used to normalize round-trip time valus when the load balancing mode
|
|
469
|
+
# is set to LB_METHOD_QOS.
|
|
470
|
+
# @rspec_example
|
|
390
471
|
# @return [long]
|
|
391
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
392
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
393
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
472
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
473
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
474
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
394
475
|
def qos_factor_rtt
|
|
395
476
|
super
|
|
396
477
|
end
|
|
397
478
|
|
|
398
479
|
##
|
|
399
|
-
# Gets the factor used to normalize topology valus when the load balancing mode is
|
|
480
|
+
# Gets the factor used to normalize topology valus when the load balancing mode is
|
|
481
|
+
# set to LB_METHOD_QOS.
|
|
482
|
+
# @rspec_example
|
|
400
483
|
# @return [long]
|
|
401
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
402
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
403
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
484
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
485
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
486
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
404
487
|
def qos_factor_topology
|
|
405
488
|
super
|
|
406
489
|
end
|
|
407
490
|
|
|
408
491
|
##
|
|
409
|
-
# Gets the factor used to normalize virtual server capacity valus when the load balancing
|
|
492
|
+
# Gets the factor used to normalize virtual server capacity valus when the load balancing
|
|
493
|
+
# mode is set to LB_METHOD_QOS.
|
|
494
|
+
# @rspec_example
|
|
410
495
|
# @return [long]
|
|
411
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
412
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
413
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
496
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
497
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
498
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
414
499
|
def qos_factor_vs_capacity
|
|
415
500
|
super
|
|
416
501
|
end
|
|
417
502
|
|
|
418
503
|
##
|
|
419
|
-
# Gets the factor used to normalize virtual server (VS) score when the load balancing
|
|
504
|
+
# Gets the factor used to normalize virtual server (VS) score when the load balancing
|
|
505
|
+
# mode is set to LB_METHOD_QOS.
|
|
506
|
+
# @rspec_example
|
|
420
507
|
# @return [long]
|
|
421
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
422
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
423
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
508
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
509
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
510
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
424
511
|
def qos_factor_vs_score
|
|
425
512
|
super
|
|
426
513
|
end
|
|
427
514
|
|
|
428
515
|
##
|
|
429
516
|
# Gets the state to indicate whether ripeness valu is allowed to be reset.
|
|
517
|
+
# @rspec_example
|
|
430
518
|
# @return [EnabledState]
|
|
431
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
432
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
433
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
519
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
520
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
521
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
434
522
|
def reset_ripeness_state
|
|
435
523
|
super
|
|
436
524
|
end
|
|
437
525
|
|
|
438
526
|
##
|
|
439
527
|
# Gets the length of the packet sent out in a probe request to determine path information.
|
|
528
|
+
# @rspec_example
|
|
440
529
|
# @return [long]
|
|
441
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
442
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
443
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
530
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
531
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
532
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
444
533
|
def rtt_packet_length
|
|
445
534
|
super
|
|
446
535
|
end
|
|
447
536
|
|
|
448
537
|
##
|
|
449
538
|
# Gets the number of packets to send out in a probe request to determine path information.
|
|
539
|
+
# @rspec_example
|
|
450
540
|
# @return [long]
|
|
451
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
452
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
453
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
541
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
542
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
543
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
454
544
|
def rtt_sample_count
|
|
455
545
|
super
|
|
456
546
|
end
|
|
457
547
|
|
|
458
548
|
##
|
|
459
549
|
# Gets the timeout for RTT, in seconds.
|
|
550
|
+
# @rspec_example
|
|
460
551
|
# @return [long]
|
|
461
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
462
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
463
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
552
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
553
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
554
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
464
555
|
def rtt_timeout
|
|
465
556
|
super
|
|
466
557
|
end
|
|
467
558
|
|
|
468
559
|
##
|
|
469
560
|
# Gets the CIDR mask (length) for the static persistence load balancing mode.
|
|
561
|
+
# @rspec_example
|
|
470
562
|
# @return [long]
|
|
471
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
472
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
473
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
563
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
564
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
565
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
474
566
|
# @param [Hash] opts
|
|
475
567
|
# @option opts [boolean] :v6 A boolean indicating which CIDR mask to get, the mask used for protocol IPv4 or IPv6 .
|
|
476
568
|
def static_persistence_cidr_mask(opts)
|
|
@@ -480,146 +572,171 @@ module IControl::GlobalLB
|
|
|
480
572
|
|
|
481
573
|
##
|
|
482
574
|
# Gets the sync group name.
|
|
575
|
+
# @rspec_example
|
|
483
576
|
# @return [String]
|
|
484
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
485
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
486
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
577
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
578
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
579
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
487
580
|
def sync_group_name
|
|
488
581
|
super
|
|
489
582
|
end
|
|
490
583
|
|
|
491
584
|
##
|
|
492
|
-
# Gets the state to indicate whether to auto_synchronize named configuration. Allows
|
|
585
|
+
# Gets the state to indicate whether to auto_synchronize named configuration. Allows
|
|
586
|
+
# automatic updates of named.conf to/from other 3-DNSes.
|
|
587
|
+
# @rspec_example
|
|
493
588
|
# @return [EnabledState]
|
|
494
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
495
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
496
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
589
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
590
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
591
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
497
592
|
def sync_named_configuration_state
|
|
498
593
|
super
|
|
499
594
|
end
|
|
500
595
|
|
|
501
596
|
##
|
|
502
|
-
# Gets the sync timeout. If synch'ing from a remote 3-DNS takes longer than this timeout,
|
|
597
|
+
# Gets the sync timeout. If synch'ing from a remote 3-DNS takes longer than this timeout,
|
|
598
|
+
# then abort the connection.
|
|
599
|
+
# @rspec_example
|
|
503
600
|
# @return [long]
|
|
504
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
505
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
506
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
601
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
602
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
603
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
507
604
|
def sync_timeout
|
|
508
605
|
super
|
|
509
606
|
end
|
|
510
607
|
|
|
511
608
|
##
|
|
512
|
-
# Gets the sync zones timeout. If synch'ing named and zone configuration takes this
|
|
609
|
+
# Gets the sync zones timeout. If synch'ing named and zone configuration takes this
|
|
610
|
+
# timeout, then abort the connection.
|
|
611
|
+
# @rspec_example
|
|
513
612
|
# @return [long]
|
|
514
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
515
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
516
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
613
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
614
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
615
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
517
616
|
def sync_zone_timeout
|
|
518
617
|
super
|
|
519
618
|
end
|
|
520
619
|
|
|
521
620
|
##
|
|
522
|
-
# Gets the allowable time difference for data to be out of sync between members of
|
|
621
|
+
# Gets the allowable time difference for data to be out of sync between members of
|
|
622
|
+
# a sync group.
|
|
623
|
+
# @rspec_example
|
|
523
624
|
# @return [long]
|
|
524
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
525
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
526
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
625
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
626
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
627
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
527
628
|
def time_tolerance
|
|
528
629
|
super
|
|
529
630
|
end
|
|
530
631
|
|
|
531
632
|
##
|
|
532
633
|
# Gets the frequency at which to retrieve auto-configuration data.
|
|
634
|
+
# @rspec_example
|
|
533
635
|
# @return [long]
|
|
534
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
535
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
536
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
636
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
637
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
638
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
537
639
|
def timer_auto_configuration_data
|
|
538
640
|
super
|
|
539
641
|
end
|
|
540
642
|
|
|
541
643
|
##
|
|
542
644
|
# Gets the frequency at which to retrieve path and metrics data from the system cache.
|
|
645
|
+
# @rspec_example
|
|
543
646
|
# @return [long]
|
|
544
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
545
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
546
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
647
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
648
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
649
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
547
650
|
def timer_persistence_cache
|
|
548
651
|
super
|
|
549
652
|
end
|
|
550
653
|
|
|
551
654
|
##
|
|
552
655
|
# Gets the frequency at which to retry path data.
|
|
656
|
+
# @rspec_example
|
|
553
657
|
# @return [long]
|
|
554
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
555
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
556
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
658
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
659
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
660
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
557
661
|
def timer_retry_path_data
|
|
558
662
|
super
|
|
559
663
|
end
|
|
560
664
|
|
|
561
665
|
##
|
|
562
666
|
# Gets the threshold for the topology ACL.
|
|
667
|
+
# @rspec_example
|
|
563
668
|
# @return [long]
|
|
564
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
565
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
566
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
669
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
670
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
671
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
567
672
|
def topology_acl_threshold
|
|
568
673
|
super
|
|
569
674
|
end
|
|
570
675
|
|
|
571
676
|
##
|
|
572
|
-
# Gets the state to indicate whether the 3-DNS Controller selects the topology record
|
|
677
|
+
# Gets the state to indicate whether the 3-DNS Controller selects the topology record
|
|
678
|
+
# that is most specific and, thus, has the longest match, in cases where there are
|
|
679
|
+
# several IP/netmask items that match a particular IP address. If you select No, the
|
|
680
|
+
# 3-DNS Controller uses the first topology record that matches (according to the order
|
|
681
|
+
# of entry) in the topology statement.
|
|
682
|
+
# @rspec_example
|
|
573
683
|
# @return [EnabledState]
|
|
574
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
575
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
576
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
684
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
685
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
686
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
577
687
|
def topology_longest_match_state
|
|
578
688
|
super
|
|
579
689
|
end
|
|
580
690
|
|
|
581
691
|
##
|
|
582
692
|
# Gets the port to use to collect traceroute (hops) data.
|
|
693
|
+
# @rspec_example
|
|
583
694
|
# @return [long]
|
|
584
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
585
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
586
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
695
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
696
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
697
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
587
698
|
def traceroute_port
|
|
588
699
|
super
|
|
589
700
|
end
|
|
590
701
|
|
|
591
702
|
##
|
|
592
703
|
# Gets the TTL for the traceroute information.
|
|
704
|
+
# @rspec_example
|
|
593
705
|
# @return [long]
|
|
594
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
595
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
596
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
706
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
707
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
708
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
597
709
|
def traceroute_ttl
|
|
598
710
|
super
|
|
599
711
|
end
|
|
600
712
|
|
|
601
713
|
##
|
|
602
|
-
# Gets the state that if enabled, it will set the recursion bit in all DNS responses
|
|
714
|
+
# Gets the state that if enabled, it will set the recursion bit in all DNS responses
|
|
715
|
+
# from GTM.
|
|
716
|
+
# @rspec_example
|
|
603
717
|
# @return [EnabledState]
|
|
604
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
605
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
606
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
718
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
719
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
720
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
607
721
|
def use_recursion_bit_state
|
|
608
722
|
super
|
|
609
723
|
end
|
|
610
724
|
|
|
611
725
|
##
|
|
612
726
|
# Gets the version information for this interface.
|
|
727
|
+
# @rspec_example
|
|
613
728
|
# @return [String]
|
|
614
729
|
def version
|
|
615
730
|
super
|
|
616
731
|
end
|
|
617
732
|
|
|
618
733
|
##
|
|
619
|
-
# Sets the state to indicate whether local DNS servers that belong to AOL (America
|
|
620
|
-
#
|
|
621
|
-
# @
|
|
622
|
-
# @raise [IControl::Common::
|
|
734
|
+
# Sets the state to indicate whether local DNS servers that belong to AOL (America
|
|
735
|
+
# Online) are recognized.
|
|
736
|
+
# @rspec_example
|
|
737
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
738
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
739
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
623
740
|
# @param [Hash] opts
|
|
624
741
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
625
742
|
def set_aol_aware_state(opts)
|
|
@@ -628,10 +745,12 @@ module IControl::GlobalLB
|
|
|
628
745
|
end
|
|
629
746
|
|
|
630
747
|
##
|
|
631
|
-
# Sets the state indicating whether to auto configure BIGIP/3DNS servers (automatic
|
|
632
|
-
#
|
|
633
|
-
# @
|
|
634
|
-
# @raise [IControl::Common::
|
|
748
|
+
# Sets the state indicating whether to auto configure BIGIP/3DNS servers (automatic
|
|
749
|
+
# addition and deletion of self IPs and virtual servers.
|
|
750
|
+
# @rspec_example
|
|
751
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
752
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
753
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
635
754
|
# @param [Hash] opts
|
|
636
755
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
637
756
|
def set_auto_configure_state(opts)
|
|
@@ -640,10 +759,12 @@ module IControl::GlobalLB
|
|
|
640
759
|
end
|
|
641
760
|
|
|
642
761
|
##
|
|
643
|
-
# Sets the state to indicate whether to autosync. Allows automatic updates of wideip.conf
|
|
644
|
-
#
|
|
645
|
-
# @
|
|
646
|
-
# @raise [IControl::Common::
|
|
762
|
+
# Sets the state to indicate whether to autosync. Allows automatic updates of wideip.conf
|
|
763
|
+
# to/from other 3-DNSes.
|
|
764
|
+
# @rspec_example
|
|
765
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
766
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
767
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
647
768
|
# @param [Hash] opts
|
|
648
769
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
649
770
|
def set_auto_sync_state(opts)
|
|
@@ -653,9 +774,10 @@ module IControl::GlobalLB
|
|
|
653
774
|
|
|
654
775
|
##
|
|
655
776
|
# Sets the state to indicate whether to cache LDNSes.
|
|
656
|
-
# @
|
|
657
|
-
# @raise [IControl::Common::
|
|
658
|
-
# @raise [IControl::Common::
|
|
777
|
+
# @rspec_example
|
|
778
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
779
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
780
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
659
781
|
# @param [Hash] opts
|
|
660
782
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
661
783
|
def set_cache_ldns_state(opts)
|
|
@@ -664,10 +786,12 @@ module IControl::GlobalLB
|
|
|
664
786
|
end
|
|
665
787
|
|
|
666
788
|
##
|
|
667
|
-
# Sets the state to indicate whether to check availability of a path before it uses
|
|
668
|
-
#
|
|
669
|
-
# @
|
|
670
|
-
# @raise [IControl::Common::
|
|
789
|
+
# Sets the state to indicate whether to check availability of a path before it uses
|
|
790
|
+
# the path for load balancing.
|
|
791
|
+
# @rspec_example
|
|
792
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
793
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
794
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
671
795
|
# @param [Hash] opts
|
|
672
796
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
673
797
|
def set_check_dynamic_dependency_state(opts)
|
|
@@ -677,9 +801,10 @@ module IControl::GlobalLB
|
|
|
677
801
|
|
|
678
802
|
##
|
|
679
803
|
# Sets the state to indicate whether to check the availability of virtual servers.
|
|
680
|
-
# @
|
|
681
|
-
# @raise [IControl::Common::
|
|
682
|
-
# @raise [IControl::Common::
|
|
804
|
+
# @rspec_example
|
|
805
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
806
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
807
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
683
808
|
# @param [Hash] opts
|
|
684
809
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
685
810
|
def set_check_static_dependency_state(opts)
|
|
@@ -689,9 +814,10 @@ module IControl::GlobalLB
|
|
|
689
814
|
|
|
690
815
|
##
|
|
691
816
|
# Sets the default alternate LB method.
|
|
692
|
-
# @
|
|
693
|
-
# @raise [IControl::Common::
|
|
694
|
-
# @raise [IControl::Common::
|
|
817
|
+
# @rspec_example
|
|
818
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
819
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
820
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
695
821
|
# @param [Hash] opts
|
|
696
822
|
# @option opts [IControl::GlobalLB::LBMethod] :lb_method The LB method to set.
|
|
697
823
|
def set_default_alternate_lb_method(opts)
|
|
@@ -701,9 +827,10 @@ module IControl::GlobalLB
|
|
|
701
827
|
|
|
702
828
|
##
|
|
703
829
|
# Sets the default fallback LB method.
|
|
704
|
-
# @
|
|
705
|
-
# @raise [IControl::Common::
|
|
706
|
-
# @raise [IControl::Common::
|
|
830
|
+
# @rspec_example
|
|
831
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
832
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
833
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
707
834
|
# @param [Hash] opts
|
|
708
835
|
# @option opts [IControl::GlobalLB::LBMethod] :lb_method The LB method to set.
|
|
709
836
|
def set_default_fallback_lb_method(opts)
|
|
@@ -713,36 +840,47 @@ module IControl::GlobalLB
|
|
|
713
840
|
|
|
714
841
|
##
|
|
715
842
|
# Sets the default probe limit, the number of times to probe a path.
|
|
716
|
-
# @
|
|
717
|
-
# @raise [IControl::Common::
|
|
718
|
-
# @raise [IControl::Common::
|
|
843
|
+
# @rspec_example
|
|
844
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
845
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
846
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
719
847
|
def set_default_probe_limit
|
|
720
848
|
super
|
|
721
849
|
end
|
|
722
850
|
|
|
723
851
|
##
|
|
724
|
-
# Sets the "down_multiple" valu. If a host server or a host virtual server
|
|
725
|
-
#
|
|
726
|
-
#
|
|
727
|
-
#
|
|
852
|
+
# Sets the "down_multiple" valu. If a host server or a host virtual server
|
|
853
|
+
# has been marked down for the last down_threshold probing cycles (timer_get_host_data
|
|
854
|
+
# or timer_get_vs_data respectively), then perform service checks every down_multiple
|
|
855
|
+
# * timer period instead.
|
|
856
|
+
# @rspec_example
|
|
857
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
858
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
859
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
728
860
|
def set_down_multiple
|
|
729
861
|
super
|
|
730
862
|
end
|
|
731
863
|
|
|
732
864
|
##
|
|
733
|
-
# Sets the "down_threshold" valu. If a host server or a host virtual server
|
|
734
|
-
#
|
|
735
|
-
#
|
|
736
|
-
#
|
|
865
|
+
# Sets the "down_threshold" valu. If a host server or a host virtual server
|
|
866
|
+
# has been marked down for the last down_threshold probing cycles (timer_get_host_data
|
|
867
|
+
# or timer_get_vs_data respectively), then perform service checks every down_multiple
|
|
868
|
+
# * timer period instead.
|
|
869
|
+
# @rspec_example
|
|
870
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
871
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
872
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
737
873
|
def set_down_threshold
|
|
738
874
|
super
|
|
739
875
|
end
|
|
740
876
|
|
|
741
877
|
##
|
|
742
|
-
# Sets the state to indicate whether persistent connections are allowed to remain connected,
|
|
743
|
-
#
|
|
744
|
-
# @
|
|
745
|
-
# @raise [IControl::Common::
|
|
878
|
+
# Sets the state to indicate whether persistent connections are allowed to remain connected,
|
|
879
|
+
# until TTL expires, when disabling a pool.
|
|
880
|
+
# @rspec_example
|
|
881
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
882
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
883
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
746
884
|
# @param [Hash] opts
|
|
747
885
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
748
886
|
def set_drain_request_state(opts)
|
|
@@ -752,9 +890,10 @@ module IControl::GlobalLB
|
|
|
752
890
|
|
|
753
891
|
##
|
|
754
892
|
# Sets the state to indicate whether to dump the topology.
|
|
755
|
-
# @
|
|
756
|
-
# @raise [IControl::Common::
|
|
757
|
-
# @raise [IControl::Common::
|
|
893
|
+
# @rspec_example
|
|
894
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
895
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
896
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
758
897
|
# @param [Hash] opts
|
|
759
898
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
760
899
|
def set_dump_topology_state(opts)
|
|
@@ -764,9 +903,10 @@ module IControl::GlobalLB
|
|
|
764
903
|
|
|
765
904
|
##
|
|
766
905
|
# Sets the state to indicate whether to respect ACL.
|
|
767
|
-
# @
|
|
768
|
-
# @raise [IControl::Common::
|
|
769
|
-
# @raise [IControl::Common::
|
|
906
|
+
# @rspec_example
|
|
907
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
908
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
909
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
770
910
|
# @param [Hash] opts
|
|
771
911
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
772
912
|
def set_fb_respect_acl_state(opts)
|
|
@@ -775,10 +915,12 @@ module IControl::GlobalLB
|
|
|
775
915
|
end
|
|
776
916
|
|
|
777
917
|
##
|
|
778
|
-
# Sets the state to indicate whether to respect virtual server status when load balancing
|
|
779
|
-
#
|
|
780
|
-
# @
|
|
781
|
-
# @raise [IControl::Common::
|
|
918
|
+
# Sets the state to indicate whether to respect virtual server status when load balancing
|
|
919
|
+
# switches to the fallback mode.
|
|
920
|
+
# @rspec_example
|
|
921
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
922
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
923
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
782
924
|
# @param [Hash] opts
|
|
783
925
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
784
926
|
def set_fb_respect_dependency_state(opts)
|
|
@@ -788,18 +930,23 @@ module IControl::GlobalLB
|
|
|
788
930
|
|
|
789
931
|
##
|
|
790
932
|
# Sets the number of seconds that an inactive LDNS remains cached.
|
|
791
|
-
# @
|
|
792
|
-
# @raise [IControl::Common::
|
|
793
|
-
# @raise [IControl::Common::
|
|
933
|
+
# @rspec_example
|
|
934
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
935
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
936
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
794
937
|
def set_ldns_duration
|
|
795
938
|
super
|
|
796
939
|
end
|
|
797
940
|
|
|
798
941
|
##
|
|
799
|
-
# Sets the LDNS probe protocols. The order of the protocols in the sequence will be
|
|
800
|
-
#
|
|
801
|
-
#
|
|
802
|
-
#
|
|
942
|
+
# Sets the LDNS probe protocols. The order of the protocols in the sequence will be
|
|
943
|
+
# used to indicate the preferred protocols, i.e. the first protocol in the sequence
|
|
944
|
+
# is the most preferred protocol. If you'd like to remove an item, get the LDNS probe
|
|
945
|
+
# protocols, remove the item, then do set.
|
|
946
|
+
# @rspec_example
|
|
947
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
948
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
949
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
803
950
|
# @param [Hash] opts
|
|
804
951
|
# @option opts [IControl::GlobalLB::LDNSProbeProtocol] :protocols The probe protocols to set.
|
|
805
952
|
def set_ldns_probe_protocols(opts)
|
|
@@ -808,10 +955,15 @@ module IControl::GlobalLB
|
|
|
808
955
|
end
|
|
809
956
|
|
|
810
957
|
##
|
|
811
|
-
# Sets the link compensate inbound state. If set, the link allotment calculation will
|
|
812
|
-
#
|
|
813
|
-
#
|
|
814
|
-
#
|
|
958
|
+
# Sets the link compensate inbound state. If set, the link allotment calculation will
|
|
959
|
+
# take into account traffic which does not flow through the BIGIP, i.e. if more traffic
|
|
960
|
+
# is flowing through a link as measured by SNMP on the router than is flowing through
|
|
961
|
+
# the BIGIP. This applies to inbound traffic which the major volume will initiate from
|
|
962
|
+
# internal clients.
|
|
963
|
+
# @rspec_example
|
|
964
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
965
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
966
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
815
967
|
# @param [Hash] opts
|
|
816
968
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
817
969
|
def set_link_compensate_inbound_state(opts)
|
|
@@ -820,10 +972,15 @@ module IControl::GlobalLB
|
|
|
820
972
|
end
|
|
821
973
|
|
|
822
974
|
##
|
|
823
|
-
# Sets the link compensate outbound state. If set, the link allotment calculation will
|
|
824
|
-
#
|
|
825
|
-
#
|
|
826
|
-
#
|
|
975
|
+
# Sets the link compensate outbound state. If set, the link allotment calculation will
|
|
976
|
+
# take into account traffic which does not flow through the BIGIP, i.e. if more traffic
|
|
977
|
+
# is flowing through a link as measured by SNMP on the router than is flowing through
|
|
978
|
+
# the BIGIP. This applies to outbound traffic which the major volume will initiate
|
|
979
|
+
# from internal clients.
|
|
980
|
+
# @rspec_example
|
|
981
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
982
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
983
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
827
984
|
# @param [Hash] opts
|
|
828
985
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
829
986
|
def set_link_compensate_outbound_state(opts)
|
|
@@ -833,108 +990,133 @@ module IControl::GlobalLB
|
|
|
833
990
|
|
|
834
991
|
##
|
|
835
992
|
# Sets the link compensation history.
|
|
836
|
-
# @
|
|
837
|
-
# @raise [IControl::Common::
|
|
838
|
-
# @raise [IControl::Common::
|
|
993
|
+
# @rspec_example
|
|
994
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
995
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
996
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
839
997
|
def set_link_compensation_history
|
|
840
998
|
super
|
|
841
999
|
end
|
|
842
1000
|
|
|
843
1001
|
##
|
|
844
|
-
# Sets the link limit factor, which is used to set a target percentage for traffic.
|
|
845
|
-
#
|
|
846
|
-
#
|
|
847
|
-
# @
|
|
1002
|
+
# Sets the link limit factor, which is used to set a target percentage for traffic.
|
|
1003
|
+
# For example, if it is set to 90, the ratio cost based load-balancing will set a ratio
|
|
1004
|
+
# with a maximum valu equal to 90% of the limit valu for the link. Default is 95%.
|
|
1005
|
+
# @rspec_example
|
|
1006
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1007
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1008
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
848
1009
|
def set_link_limit_factor
|
|
849
1010
|
super
|
|
850
1011
|
end
|
|
851
1012
|
|
|
852
1013
|
##
|
|
853
|
-
# Sets the link prepaid factor. Maximum percentage of traffic allocated to link which
|
|
854
|
-
#
|
|
855
|
-
# @
|
|
856
|
-
# @raise [IControl::Common::
|
|
1014
|
+
# Sets the link prepaid factor. Maximum percentage of traffic allocated to link which
|
|
1015
|
+
# has a traffic allotment which has been prepaid. Default is 95%.
|
|
1016
|
+
# @rspec_example
|
|
1017
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1018
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1019
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
857
1020
|
def set_link_prepaid_factor
|
|
858
1021
|
super
|
|
859
1022
|
end
|
|
860
1023
|
|
|
861
1024
|
##
|
|
862
|
-
# Sets the number of seconds that an inactive LDNS remains cached. This function is
|
|
863
|
-
#
|
|
864
|
-
# @
|
|
865
|
-
# @raise [IControl::Common::
|
|
1025
|
+
# Sets the number of seconds that an inactive LDNS remains cached. This function is
|
|
1026
|
+
# deprecated (due to being misnamed); new applications should use set_ldns_duration.
|
|
1027
|
+
# @rspec_example
|
|
1028
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1029
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1030
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
866
1031
|
def set_lnds_duration
|
|
867
1032
|
super
|
|
868
1033
|
end
|
|
869
1034
|
|
|
870
1035
|
##
|
|
871
1036
|
# Sets the lower bound percentage column options in Internet Weather Map.
|
|
872
|
-
# @
|
|
873
|
-
# @raise [IControl::Common::
|
|
874
|
-
# @raise [IControl::Common::
|
|
1037
|
+
# @rspec_example
|
|
1038
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1039
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1040
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
875
1041
|
def set_lower_bound_percentage_column
|
|
876
1042
|
super
|
|
877
1043
|
end
|
|
878
1044
|
|
|
879
1045
|
##
|
|
880
1046
|
# Sets the lower bound percentage row options in Internet Weather Map.
|
|
881
|
-
# @
|
|
882
|
-
# @raise [IControl::Common::
|
|
883
|
-
# @raise [IControl::Common::
|
|
1047
|
+
# @rspec_example
|
|
1048
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1049
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1050
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
884
1051
|
def set_lower_bound_percentage_row
|
|
885
1052
|
super
|
|
886
1053
|
end
|
|
887
1054
|
|
|
888
1055
|
##
|
|
889
|
-
# Sets the maximum link over limit count. The count of how many times in a row traffic
|
|
890
|
-
#
|
|
891
|
-
#
|
|
892
|
-
# @
|
|
1056
|
+
# Sets the maximum link over limit count. The count of how many times in a row traffic
|
|
1057
|
+
# may be over the defined limit for the link before it is shut off entirely. Default
|
|
1058
|
+
# is 1.
|
|
1059
|
+
# @rspec_example
|
|
1060
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1061
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1062
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
893
1063
|
def set_maximum_link_over_limit_count
|
|
894
1064
|
super
|
|
895
1065
|
end
|
|
896
1066
|
|
|
897
1067
|
##
|
|
898
|
-
# Sets the maximum synchronous monitor request, which is used to control the maximum
|
|
899
|
-
#
|
|
900
|
-
#
|
|
901
|
-
# @
|
|
1068
|
+
# Sets the maximum synchronous monitor request, which is used to control the maximum
|
|
1069
|
+
# number of monitor requests being sent out at one time for a given probing interval.
|
|
1070
|
+
# This will allow the user to smooth out monitor probe requests as much as they desire.
|
|
1071
|
+
# @rspec_example
|
|
1072
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1073
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1074
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
902
1075
|
def set_maximum_synchronous_monitor_request
|
|
903
1076
|
super
|
|
904
1077
|
end
|
|
905
1078
|
|
|
906
1079
|
##
|
|
907
|
-
# Sets the over-limit link limit factor. If traffic on a link exceeds the limit, this
|
|
908
|
-
#
|
|
909
|
-
#
|
|
910
|
-
#
|
|
1080
|
+
# Sets the over-limit link limit factor. If traffic on a link exceeds the limit, this
|
|
1081
|
+
# factor will be used instead of the link_limit_factor until the traffic is over limit
|
|
1082
|
+
# for more than max_link_over_limit_count times. Once the limit has been exceeded too
|
|
1083
|
+
# many times, all traffic is shut off for the link. The default for over_limit_link_limit_factor
|
|
1084
|
+
# is 90%.
|
|
1085
|
+
# @rspec_example
|
|
1086
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1087
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1088
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
911
1089
|
def set_over_limit_link_limit_factor
|
|
912
1090
|
super
|
|
913
1091
|
end
|
|
914
1092
|
|
|
915
1093
|
##
|
|
916
1094
|
# Sets the number of seconds that a path remains cached after its last access.
|
|
917
|
-
# @
|
|
918
|
-
# @raise [IControl::Common::
|
|
919
|
-
# @raise [IControl::Common::
|
|
1095
|
+
# @rspec_example
|
|
1096
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1097
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1098
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
920
1099
|
def set_path_duration
|
|
921
1100
|
super
|
|
922
1101
|
end
|
|
923
1102
|
|
|
924
1103
|
##
|
|
925
1104
|
# Sets the TTL for the path information.
|
|
926
|
-
# @
|
|
927
|
-
# @raise [IControl::Common::
|
|
928
|
-
# @raise [IControl::Common::
|
|
1105
|
+
# @rspec_example
|
|
1106
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1107
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1108
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
929
1109
|
def set_path_ttl
|
|
930
1110
|
super
|
|
931
1111
|
end
|
|
932
1112
|
|
|
933
1113
|
##
|
|
934
|
-
# Sets the state indicating whether the dynamic load balancing modes can use path data
|
|
935
|
-
#
|
|
936
|
-
# @
|
|
937
|
-
# @raise [IControl::Common::
|
|
1114
|
+
# Sets the state indicating whether the dynamic load balancing modes can use path data
|
|
1115
|
+
# even after the TTL for the path data has expired.
|
|
1116
|
+
# @rspec_example
|
|
1117
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1118
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1119
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
938
1120
|
# @param [Hash] opts
|
|
939
1121
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
940
1122
|
def set_paths_never_die_state(opts)
|
|
@@ -943,19 +1125,22 @@ module IControl::GlobalLB
|
|
|
943
1125
|
end
|
|
944
1126
|
|
|
945
1127
|
##
|
|
946
|
-
# Sets the persistence mask. This function is deprecated and new applications should
|
|
947
|
-
#
|
|
948
|
-
# @
|
|
949
|
-
# @raise [IControl::Common::
|
|
1128
|
+
# Sets the persistence mask. This function is deprecated and new applications should
|
|
1129
|
+
# use set_static_persistence_cidr_mask.
|
|
1130
|
+
# @rspec_example
|
|
1131
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1132
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1133
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
950
1134
|
def set_persistence_mask
|
|
951
1135
|
super
|
|
952
1136
|
end
|
|
953
1137
|
|
|
954
1138
|
##
|
|
955
1139
|
# Sets the state that if enabled, GTM will still probe disabled object.
|
|
956
|
-
# @
|
|
957
|
-
# @raise [IControl::Common::
|
|
958
|
-
# @raise [IControl::Common::
|
|
1140
|
+
# @rspec_example
|
|
1141
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1142
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1143
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
959
1144
|
# @param [Hash] opts
|
|
960
1145
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
961
1146
|
def set_probe_disabled_object_state(opts)
|
|
@@ -964,100 +1149,121 @@ module IControl::GlobalLB
|
|
|
964
1149
|
end
|
|
965
1150
|
|
|
966
1151
|
##
|
|
967
|
-
# Sets the factor used to normalize bits per second when the load balancing mode is
|
|
968
|
-
#
|
|
969
|
-
# @
|
|
970
|
-
# @raise [IControl::Common::
|
|
1152
|
+
# Sets the factor used to normalize bits per second when the load balancing mode is
|
|
1153
|
+
# set to LB_METHOD_QOS.
|
|
1154
|
+
# @rspec_example
|
|
1155
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1156
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1157
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
971
1158
|
def set_qos_factor_bps
|
|
972
1159
|
super
|
|
973
1160
|
end
|
|
974
1161
|
|
|
975
1162
|
##
|
|
976
|
-
# Sets the factor used to normalize connection rates when the load balancing mode is
|
|
977
|
-
#
|
|
978
|
-
#
|
|
979
|
-
# @
|
|
1163
|
+
# Sets the factor used to normalize connection rates when the load balancing mode is
|
|
1164
|
+
# set to LB_METHOD_QOS. This function is deprecated and new applications should use
|
|
1165
|
+
# vs_score.
|
|
1166
|
+
# @rspec_example
|
|
1167
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1168
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1169
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
980
1170
|
def set_qos_factor_connection_rate
|
|
981
1171
|
super
|
|
982
1172
|
end
|
|
983
1173
|
|
|
984
1174
|
##
|
|
985
|
-
# Sets the factor used to normalize ping packet completion rates when the load balancing
|
|
986
|
-
#
|
|
987
|
-
# @
|
|
988
|
-
# @raise [IControl::Common::
|
|
1175
|
+
# Sets the factor used to normalize ping packet completion rates when the load balancing
|
|
1176
|
+
# mode is set to LB_METHOD_QOS.
|
|
1177
|
+
# @rspec_example
|
|
1178
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1179
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1180
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
989
1181
|
def set_qos_factor_hit_ratio
|
|
990
1182
|
super
|
|
991
1183
|
end
|
|
992
1184
|
|
|
993
1185
|
##
|
|
994
1186
|
# Sets the factor used to normalize hops when the load balancing mode is set to LB_METHOD_QOS.
|
|
995
|
-
# @
|
|
996
|
-
# @raise [IControl::Common::
|
|
997
|
-
# @raise [IControl::Common::
|
|
1187
|
+
# @rspec_example
|
|
1188
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1189
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1190
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
998
1191
|
def set_qos_factor_hops
|
|
999
1192
|
super
|
|
1000
1193
|
end
|
|
1001
1194
|
|
|
1002
1195
|
##
|
|
1003
|
-
# Sets the factor used to normalize link capacity valus when the load balancing mode
|
|
1004
|
-
#
|
|
1005
|
-
# @
|
|
1006
|
-
# @raise [IControl::Common::
|
|
1196
|
+
# Sets the factor used to normalize link capacity valus when the load balancing mode
|
|
1197
|
+
# is set to LB_METHOD_QOS.
|
|
1198
|
+
# @rspec_example
|
|
1199
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1200
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1201
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1007
1202
|
def set_qos_factor_lcs
|
|
1008
1203
|
super
|
|
1009
1204
|
end
|
|
1010
1205
|
|
|
1011
1206
|
##
|
|
1012
|
-
# Sets the factor used to normalize packet rates when the load balancing mode is set
|
|
1013
|
-
#
|
|
1014
|
-
# @
|
|
1015
|
-
# @raise [IControl::Common::
|
|
1207
|
+
# Sets the factor used to normalize packet rates when the load balancing mode is set
|
|
1208
|
+
# to LB_METHOD_QOS.
|
|
1209
|
+
# @rspec_example
|
|
1210
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1211
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1212
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1016
1213
|
def set_qos_factor_packet_rate
|
|
1017
1214
|
super
|
|
1018
1215
|
end
|
|
1019
1216
|
|
|
1020
1217
|
##
|
|
1021
|
-
# Sets the factor used to normalize round-trip time valus when the load balancing mode
|
|
1022
|
-
#
|
|
1023
|
-
# @
|
|
1024
|
-
# @raise [IControl::Common::
|
|
1218
|
+
# Sets the factor used to normalize round-trip time valus when the load balancing mode
|
|
1219
|
+
# is set to LB_METHOD_QOS.
|
|
1220
|
+
# @rspec_example
|
|
1221
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1222
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1223
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1025
1224
|
def set_qos_factor_rtt
|
|
1026
1225
|
super
|
|
1027
1226
|
end
|
|
1028
1227
|
|
|
1029
1228
|
##
|
|
1030
|
-
# Sets the factor used to normalize topology valus when the load balancing mode is
|
|
1031
|
-
#
|
|
1032
|
-
# @
|
|
1033
|
-
# @raise [IControl::Common::
|
|
1229
|
+
# Sets the factor used to normalize topology valus when the load balancing mode is
|
|
1230
|
+
# set to LB_METHOD_QOS.
|
|
1231
|
+
# @rspec_example
|
|
1232
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1233
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1234
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1034
1235
|
def set_qos_factor_topology
|
|
1035
1236
|
super
|
|
1036
1237
|
end
|
|
1037
1238
|
|
|
1038
1239
|
##
|
|
1039
|
-
# Sets the factor used to normalize virtual server capacity valus when the load balancing
|
|
1040
|
-
#
|
|
1041
|
-
# @
|
|
1042
|
-
# @raise [IControl::Common::
|
|
1240
|
+
# Sets the factor used to normalize virtual server capacity valus when the load balancing
|
|
1241
|
+
# mode is set to LB_METHOD_QOS.
|
|
1242
|
+
# @rspec_example
|
|
1243
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1244
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1245
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1043
1246
|
def set_qos_factor_vs_capacity
|
|
1044
1247
|
super
|
|
1045
1248
|
end
|
|
1046
1249
|
|
|
1047
1250
|
##
|
|
1048
|
-
# Sets the factor used to normalize virtual server (VS) score when the load balancing
|
|
1049
|
-
#
|
|
1050
|
-
# @
|
|
1051
|
-
# @raise [IControl::Common::
|
|
1251
|
+
# Sets the factor used to normalize virtual server (VS) score when the load balancing
|
|
1252
|
+
# mode is set to LB_METHOD_QOS.
|
|
1253
|
+
# @rspec_example
|
|
1254
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1255
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1256
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1052
1257
|
def set_qos_factor_vs_score
|
|
1053
1258
|
super
|
|
1054
1259
|
end
|
|
1055
1260
|
|
|
1056
1261
|
##
|
|
1057
1262
|
# Sets the state to indicate whether ripeness valu is allowed to be reset.
|
|
1058
|
-
# @
|
|
1059
|
-
# @raise [IControl::Common::
|
|
1060
|
-
# @raise [IControl::Common::
|
|
1263
|
+
# @rspec_example
|
|
1264
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1265
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1266
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1061
1267
|
# @param [Hash] opts
|
|
1062
1268
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
1063
1269
|
def set_reset_ripeness_state(opts)
|
|
@@ -1067,36 +1273,40 @@ module IControl::GlobalLB
|
|
|
1067
1273
|
|
|
1068
1274
|
##
|
|
1069
1275
|
# Sets the length of the packet sent out in a probe request to determine path information.
|
|
1070
|
-
# @
|
|
1071
|
-
# @raise [IControl::Common::
|
|
1072
|
-
# @raise [IControl::Common::
|
|
1276
|
+
# @rspec_example
|
|
1277
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1278
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1279
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1073
1280
|
def set_rtt_packet_length
|
|
1074
1281
|
super
|
|
1075
1282
|
end
|
|
1076
1283
|
|
|
1077
1284
|
##
|
|
1078
1285
|
# Sets the number of packets to send out in a probe request to determine path information.
|
|
1079
|
-
# @
|
|
1080
|
-
# @raise [IControl::Common::
|
|
1081
|
-
# @raise [IControl::Common::
|
|
1286
|
+
# @rspec_example
|
|
1287
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1288
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1289
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1082
1290
|
def set_rtt_sample_count
|
|
1083
1291
|
super
|
|
1084
1292
|
end
|
|
1085
1293
|
|
|
1086
1294
|
##
|
|
1087
1295
|
# Sets the timeout for RTT, in seconds.
|
|
1088
|
-
# @
|
|
1089
|
-
# @raise [IControl::Common::
|
|
1090
|
-
# @raise [IControl::Common::
|
|
1296
|
+
# @rspec_example
|
|
1297
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1298
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1299
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1091
1300
|
def set_rtt_timeout
|
|
1092
1301
|
super
|
|
1093
1302
|
end
|
|
1094
1303
|
|
|
1095
1304
|
##
|
|
1096
1305
|
# Sets the CIDR mask (length) for the static persistence load balancing mode.
|
|
1097
|
-
# @
|
|
1098
|
-
# @raise [IControl::Common::
|
|
1099
|
-
# @raise [IControl::Common::
|
|
1306
|
+
# @rspec_example
|
|
1307
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1308
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1309
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1100
1310
|
# @param [Hash] opts
|
|
1101
1311
|
# @option opts [boolean] :v6 A boolean indicating which CIDR mask to affect, the mask used for protocol IPv4 or IPv6 .
|
|
1102
1312
|
def set_static_persistence_cidr_mask(opts)
|
|
@@ -1106,9 +1316,10 @@ module IControl::GlobalLB
|
|
|
1106
1316
|
|
|
1107
1317
|
##
|
|
1108
1318
|
# Sets the sync group name.
|
|
1109
|
-
# @
|
|
1110
|
-
# @raise [IControl::Common::
|
|
1111
|
-
# @raise [IControl::Common::
|
|
1319
|
+
# @rspec_example
|
|
1320
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1321
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1322
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1112
1323
|
# @param [Hash] opts
|
|
1113
1324
|
# @option opts [String] :sync_group_name The sync group name to set.
|
|
1114
1325
|
def set_sync_group_name(opts)
|
|
@@ -1117,10 +1328,12 @@ module IControl::GlobalLB
|
|
|
1117
1328
|
end
|
|
1118
1329
|
|
|
1119
1330
|
##
|
|
1120
|
-
# Sets the state to indicate whether to auto-synchronize named configuration. Allows
|
|
1121
|
-
#
|
|
1122
|
-
# @
|
|
1123
|
-
# @raise [IControl::Common::
|
|
1331
|
+
# Sets the state to indicate whether to auto-synchronize named configuration. Allows
|
|
1332
|
+
# automatic updates of named.conf to/from other 3-DNSes.
|
|
1333
|
+
# @rspec_example
|
|
1334
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1335
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1336
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1124
1337
|
# @param [Hash] opts
|
|
1125
1338
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
1126
1339
|
def set_sync_named_configuration_state(opts)
|
|
@@ -1129,73 +1342,88 @@ module IControl::GlobalLB
|
|
|
1129
1342
|
end
|
|
1130
1343
|
|
|
1131
1344
|
##
|
|
1132
|
-
# Sets the sync timeout. If synch'ing from a remote 3-DNS takes longer than this timeout,
|
|
1133
|
-
#
|
|
1134
|
-
# @
|
|
1135
|
-
# @raise [IControl::Common::
|
|
1345
|
+
# Sets the sync timeout. If synch'ing from a remote 3-DNS takes longer than this timeout,
|
|
1346
|
+
# then abort the connection.
|
|
1347
|
+
# @rspec_example
|
|
1348
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1349
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1350
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1136
1351
|
def set_sync_timeout
|
|
1137
1352
|
super
|
|
1138
1353
|
end
|
|
1139
1354
|
|
|
1140
1355
|
##
|
|
1141
|
-
# Sets the sync zones timeout. If synch'ing named and zone configuration takes this
|
|
1142
|
-
#
|
|
1143
|
-
# @
|
|
1144
|
-
# @raise [IControl::Common::
|
|
1356
|
+
# Sets the sync zones timeout. If synch'ing named and zone configuration takes this
|
|
1357
|
+
# timeout, then abort the connection.
|
|
1358
|
+
# @rspec_example
|
|
1359
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1360
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1361
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1145
1362
|
def set_sync_zone_timeout
|
|
1146
1363
|
super
|
|
1147
1364
|
end
|
|
1148
1365
|
|
|
1149
1366
|
##
|
|
1150
|
-
# Sets the allowable time difference for data to be out of sync between members of
|
|
1151
|
-
#
|
|
1152
|
-
# @
|
|
1153
|
-
# @raise [IControl::Common::
|
|
1367
|
+
# Sets the allowable time difference for data to be out of sync between members of
|
|
1368
|
+
# a sync group.
|
|
1369
|
+
# @rspec_example
|
|
1370
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1371
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1372
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1154
1373
|
def set_time_tolerance
|
|
1155
1374
|
super
|
|
1156
1375
|
end
|
|
1157
1376
|
|
|
1158
1377
|
##
|
|
1159
1378
|
# Sets the frequency at which to retrieve auto-configuration data.
|
|
1160
|
-
# @
|
|
1161
|
-
# @raise [IControl::Common::
|
|
1162
|
-
# @raise [IControl::Common::
|
|
1379
|
+
# @rspec_example
|
|
1380
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1381
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1382
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1163
1383
|
def set_timer_auto_configuration_data
|
|
1164
1384
|
super
|
|
1165
1385
|
end
|
|
1166
1386
|
|
|
1167
1387
|
##
|
|
1168
1388
|
# Sets the frequency at which to retrieve path and metrics data from the system cache.
|
|
1169
|
-
# @
|
|
1170
|
-
# @raise [IControl::Common::
|
|
1171
|
-
# @raise [IControl::Common::
|
|
1389
|
+
# @rspec_example
|
|
1390
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1391
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1392
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1172
1393
|
def set_timer_persistence_cache
|
|
1173
1394
|
super
|
|
1174
1395
|
end
|
|
1175
1396
|
|
|
1176
1397
|
##
|
|
1177
1398
|
# Sets the frequency at which to retry path data.
|
|
1178
|
-
# @
|
|
1179
|
-
# @raise [IControl::Common::
|
|
1180
|
-
# @raise [IControl::Common::
|
|
1399
|
+
# @rspec_example
|
|
1400
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1401
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1402
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1181
1403
|
def set_timer_retry_path_data
|
|
1182
1404
|
super
|
|
1183
1405
|
end
|
|
1184
1406
|
|
|
1185
1407
|
##
|
|
1186
1408
|
# Sets the threshold for the topology ACL.
|
|
1187
|
-
# @
|
|
1188
|
-
# @raise [IControl::Common::
|
|
1189
|
-
# @raise [IControl::Common::
|
|
1409
|
+
# @rspec_example
|
|
1410
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1411
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1412
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1190
1413
|
def set_topology_acl_threshold
|
|
1191
1414
|
super
|
|
1192
1415
|
end
|
|
1193
1416
|
|
|
1194
1417
|
##
|
|
1195
|
-
# Sets the state to indicate whether the 3-DNS Controller selects the topology record
|
|
1196
|
-
#
|
|
1197
|
-
#
|
|
1198
|
-
#
|
|
1418
|
+
# Sets the state to indicate whether the 3-DNS Controller selects the topology record
|
|
1419
|
+
# that is most specific and, thus, has the longest match, in cases where there are
|
|
1420
|
+
# several IP/netmask items that match a particular IP address. If you select No, the
|
|
1421
|
+
# 3-DNS Controller uses the first topology record that matches (according to the order
|
|
1422
|
+
# of entry) in the topology statement.
|
|
1423
|
+
# @rspec_example
|
|
1424
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1425
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1426
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1199
1427
|
# @param [Hash] opts
|
|
1200
1428
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
1201
1429
|
def set_topology_longest_match_state(opts)
|
|
@@ -1205,27 +1433,31 @@ module IControl::GlobalLB
|
|
|
1205
1433
|
|
|
1206
1434
|
##
|
|
1207
1435
|
# Sets the port to use to collect traceroute (hops) data.
|
|
1208
|
-
# @
|
|
1209
|
-
# @raise [IControl::Common::
|
|
1210
|
-
# @raise [IControl::Common::
|
|
1436
|
+
# @rspec_example
|
|
1437
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1438
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1439
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1211
1440
|
def set_traceroute_port
|
|
1212
1441
|
super
|
|
1213
1442
|
end
|
|
1214
1443
|
|
|
1215
1444
|
##
|
|
1216
1445
|
# Sets the TTL for the traceroute information.
|
|
1217
|
-
# @
|
|
1218
|
-
# @raise [IControl::Common::
|
|
1219
|
-
# @raise [IControl::Common::
|
|
1446
|
+
# @rspec_example
|
|
1447
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1448
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1449
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1220
1450
|
def set_traceroute_ttl
|
|
1221
1451
|
super
|
|
1222
1452
|
end
|
|
1223
1453
|
|
|
1224
1454
|
##
|
|
1225
|
-
# Sets the state that if enabled, it will set the recursion bit in all DNS responses
|
|
1226
|
-
#
|
|
1227
|
-
# @
|
|
1228
|
-
# @raise [IControl::Common::
|
|
1455
|
+
# Sets the state that if enabled, it will set the recursion bit in all DNS responses
|
|
1456
|
+
# from GTM.
|
|
1457
|
+
# @rspec_example
|
|
1458
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1459
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1460
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1229
1461
|
# @param [Hash] opts
|
|
1230
1462
|
# @option opts [IControl::Common::EnabledState] :state The state to set.
|
|
1231
1463
|
def set_use_recursion_bit_state(opts)
|