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
|
@@ -1,17 +1,23 @@
|
|
|
1
1
|
module IControl::LocalLB
|
|
2
2
|
##
|
|
3
|
-
# The Pool interface enables you to work with attributes, and statistics for pools.
|
|
3
|
+
# The Pool interface enables you to work with attributes, and statistics for pools.
|
|
4
|
+
# You can also use this interface to create pools, add members to a pool, delete members
|
|
5
|
+
# from a pool, find out the load balancing mode for a pool, and set the load balancing
|
|
6
|
+
# mode for a pool.
|
|
4
7
|
class Pool < IControl::Base
|
|
5
8
|
|
|
6
9
|
set_id_name "pool_names"
|
|
7
10
|
|
|
8
11
|
class MonitorAssociation < IControl::Base::Struct; end
|
|
9
12
|
class PoolStatisticEntry < IControl::Base::Struct; end
|
|
10
|
-
class PoolStatistics < IControl::Base::Struct; end
|
|
13
|
+
class PoolStatistics < IControl::Base::Struct; end
|
|
14
|
+
class MonitorAssociationSequence < IControl::Base::Sequence ; end
|
|
15
|
+
class PoolStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
|
11
16
|
# Adds members to this pool.
|
|
12
|
-
# @
|
|
13
|
-
# @raise [IControl::Common::
|
|
14
|
-
# @raise [IControl::Common::
|
|
17
|
+
# @rspec_example
|
|
18
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
19
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
20
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
15
21
|
# @param [Hash] opts
|
|
16
22
|
# @option opts [IControl::Common::IPPortDefinition[]] :members The members to add to the pools.
|
|
17
23
|
def add_member(opts)
|
|
@@ -21,9 +27,10 @@ module IControl::LocalLB
|
|
|
21
27
|
|
|
22
28
|
##
|
|
23
29
|
# Creates a new pool.
|
|
24
|
-
# @
|
|
25
|
-
# @raise [IControl::Common::
|
|
26
|
-
# @raise [IControl::Common::
|
|
30
|
+
# @rspec_example
|
|
31
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
32
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
33
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
27
34
|
# @param [Hash] opts
|
|
28
35
|
# @option opts [IControl::LocalLB::LBMethod] :lb_methods The load balancing methods to use for the pools.
|
|
29
36
|
# @option opts [IControl::Common::IPPortDefinition[]] :members The lists of initial members of the pools.
|
|
@@ -34,18 +41,20 @@ module IControl::LocalLB
|
|
|
34
41
|
|
|
35
42
|
##
|
|
36
43
|
# Deletes all pool.
|
|
37
|
-
# @
|
|
38
|
-
# @raise [IControl::Common::
|
|
39
|
-
# @raise [IControl::Common::
|
|
44
|
+
# @rspec_example
|
|
45
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
46
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
47
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
40
48
|
def delete_all_pools
|
|
41
49
|
super
|
|
42
50
|
end
|
|
43
51
|
|
|
44
52
|
##
|
|
45
53
|
# Deletes the persistence records based on this persistent modes for this pool.
|
|
46
|
-
# @
|
|
47
|
-
# @raise [IControl::Common::
|
|
48
|
-
# @raise [IControl::Common::
|
|
54
|
+
# @rspec_example
|
|
55
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
56
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
57
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
49
58
|
# @param [Hash] opts
|
|
50
59
|
# @option opts [IControl::LocalLB::PersistenceMode] :persistence_modes The persistence modes from which we delete the persistence records. If the specified persistence mode is PERSIST_MODE_NONE, then all persistence records regardless of persistence mode will be deleted for that pool.
|
|
51
60
|
def delete_persistence_record(opts)
|
|
@@ -55,209 +64,233 @@ module IControl::LocalLB
|
|
|
55
64
|
|
|
56
65
|
##
|
|
57
66
|
# Deletes this pool.
|
|
58
|
-
# @
|
|
59
|
-
# @raise [IControl::Common::
|
|
60
|
-
# @raise [IControl::Common::
|
|
67
|
+
# @rspec_example
|
|
68
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
69
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
70
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
61
71
|
def delete_pool
|
|
62
72
|
super
|
|
63
73
|
end
|
|
64
74
|
|
|
65
75
|
##
|
|
66
76
|
# Gets the action to take when the node goes down for this pool.
|
|
77
|
+
# @rspec_example
|
|
67
78
|
# @return [ServiceDownAction]
|
|
68
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
69
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
70
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
79
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
80
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
81
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
71
82
|
def action_on_service_down
|
|
72
83
|
super
|
|
73
84
|
end
|
|
74
85
|
|
|
75
86
|
##
|
|
76
87
|
# Gets the current active member counts for this pool.
|
|
88
|
+
# @rspec_example
|
|
77
89
|
# @return [long]
|
|
78
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
79
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
80
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
90
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
91
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
92
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
81
93
|
def active_member_count
|
|
82
94
|
super
|
|
83
95
|
end
|
|
84
96
|
|
|
85
97
|
##
|
|
86
98
|
# Gets the aggregate dynamic ratio values from all the members of the pool.
|
|
99
|
+
# @rspec_example
|
|
87
100
|
# @return [long]
|
|
88
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
89
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
90
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
101
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
102
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
103
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
91
104
|
def aggregate_dynamic_ratio
|
|
92
105
|
super
|
|
93
106
|
end
|
|
94
107
|
|
|
95
108
|
##
|
|
96
109
|
# Gets the statistics for all the pool.
|
|
110
|
+
# @rspec_example
|
|
97
111
|
# @return [PoolStatistics]
|
|
98
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
99
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
100
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
112
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
113
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
114
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
101
115
|
def all_statistics
|
|
102
116
|
super
|
|
103
117
|
end
|
|
104
118
|
|
|
105
119
|
##
|
|
106
120
|
# Gets the states indicating whether NATs are allowed for this pool.
|
|
121
|
+
# @rspec_example
|
|
107
122
|
# @return [EnabledState]
|
|
108
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
109
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
110
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
123
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
124
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
125
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
111
126
|
def allow_nat_state
|
|
112
127
|
super
|
|
113
128
|
end
|
|
114
129
|
|
|
115
130
|
##
|
|
116
131
|
# Gets the states indicating whether SNATs are allowed for this pool.
|
|
132
|
+
# @rspec_example
|
|
117
133
|
# @return [EnabledState]
|
|
118
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
119
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
120
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
134
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
135
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
136
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
121
137
|
def allow_snat_state
|
|
122
138
|
super
|
|
123
139
|
end
|
|
124
140
|
|
|
125
141
|
##
|
|
126
142
|
# Gets the IP ToS values for client traffic for this pool.
|
|
143
|
+
# @rspec_example
|
|
127
144
|
# @return [long]
|
|
128
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
129
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
130
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
145
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
146
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
147
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
131
148
|
def client_ip_tos
|
|
132
149
|
super
|
|
133
150
|
end
|
|
134
151
|
|
|
135
152
|
##
|
|
136
153
|
# Gets the link QoS values for client traffic for this pool.
|
|
154
|
+
# @rspec_example
|
|
137
155
|
# @return [long]
|
|
138
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
139
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
140
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
156
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
157
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
158
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
141
159
|
def client_link_qos
|
|
142
160
|
super
|
|
143
161
|
end
|
|
144
162
|
|
|
145
163
|
##
|
|
146
164
|
# Gets the gateway failsafe unit IDs for this pool.
|
|
165
|
+
# @rspec_example
|
|
147
166
|
# @return [long]
|
|
148
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
149
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
150
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
167
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
168
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
169
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
151
170
|
def gateway_failsafe_unit_id
|
|
152
171
|
super
|
|
153
172
|
end
|
|
154
173
|
|
|
155
174
|
##
|
|
156
175
|
# Gets the load balancing methods for this pool.
|
|
176
|
+
# @rspec_example
|
|
157
177
|
# @return [LBMethod]
|
|
158
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
159
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
160
|
-
# @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.
|
|
161
181
|
def lb_method
|
|
162
182
|
super
|
|
163
183
|
end
|
|
164
184
|
|
|
165
185
|
##
|
|
166
186
|
# Gets a list of all pool.
|
|
187
|
+
# @rspec_example
|
|
167
188
|
# @return [String]
|
|
168
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
169
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
170
|
-
# @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.
|
|
171
192
|
def list
|
|
172
193
|
super
|
|
173
194
|
end
|
|
174
195
|
|
|
175
196
|
##
|
|
176
197
|
# Gets a list of pool members.
|
|
198
|
+
# @rspec_example
|
|
177
199
|
# @return [IPPortDefinition[]]
|
|
178
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
179
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
180
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
200
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
201
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
202
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
181
203
|
def member
|
|
182
204
|
super
|
|
183
205
|
end
|
|
184
206
|
|
|
185
207
|
##
|
|
186
208
|
# Gets the minimum active member counts for this pool.
|
|
209
|
+
# @rspec_example
|
|
187
210
|
# @return [long]
|
|
188
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
189
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
190
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
211
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
212
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
213
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
191
214
|
def minimum_active_member
|
|
192
215
|
super
|
|
193
216
|
end
|
|
194
217
|
|
|
195
218
|
##
|
|
196
219
|
# Gets the minimum member counts that are required to be UP for this pool.
|
|
220
|
+
# @rspec_example
|
|
197
221
|
# @return [long]
|
|
198
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
199
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
200
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
222
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
223
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
224
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
201
225
|
def minimum_up_member
|
|
202
226
|
super
|
|
203
227
|
end
|
|
204
228
|
|
|
205
229
|
##
|
|
206
|
-
# Gets the actions to be taken if the minimum number of members required to be UP for
|
|
230
|
+
# Gets the actions to be taken if the minimum number of members required to be UP for
|
|
231
|
+
# this pool is not met.
|
|
232
|
+
# @rspec_example
|
|
207
233
|
# @return [HAAction]
|
|
208
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
209
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
210
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
234
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
235
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
236
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
211
237
|
def minimum_up_member_action
|
|
212
238
|
super
|
|
213
239
|
end
|
|
214
240
|
|
|
215
241
|
##
|
|
216
|
-
# Gets the states indicating that the feature that requires a minimum number of members
|
|
242
|
+
# Gets the states indicating that the feature that requires a minimum number of members
|
|
243
|
+
# to be UP is enabled/disabled for this pool.
|
|
244
|
+
# @rspec_example
|
|
217
245
|
# @return [EnabledState]
|
|
218
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
219
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
220
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
246
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
247
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
248
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
221
249
|
def minimum_up_member_enabled_state
|
|
222
250
|
super
|
|
223
251
|
end
|
|
224
252
|
|
|
225
253
|
##
|
|
226
254
|
# Gets the monitor associations for this pool, i.e. the monitor rules used by the pool.
|
|
255
|
+
# @rspec_example
|
|
227
256
|
# @return [MonitorAssociation]
|
|
228
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
229
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
230
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
257
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
258
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
259
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
231
260
|
def monitor_association
|
|
232
261
|
super
|
|
233
262
|
end
|
|
234
263
|
|
|
235
264
|
##
|
|
236
|
-
# Gets the monitor instance information for this pool, i.e. the monitor instance information
|
|
265
|
+
# Gets the monitor instance information for this pool, i.e. the monitor instance information
|
|
266
|
+
# for the pool members of this pool.
|
|
267
|
+
# @rspec_example
|
|
237
268
|
# @return [MonitorInstanceState[]]
|
|
238
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
239
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
240
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
269
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
270
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
271
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
241
272
|
def monitor_instance
|
|
242
273
|
super
|
|
243
274
|
end
|
|
244
275
|
|
|
245
276
|
##
|
|
246
277
|
# Gets the statuses of this pool.
|
|
278
|
+
# @rspec_example
|
|
247
279
|
# @return [ObjectStatus]
|
|
248
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
249
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
250
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
280
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
281
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
282
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
251
283
|
def object_status
|
|
252
284
|
super
|
|
253
285
|
end
|
|
254
286
|
|
|
255
287
|
##
|
|
256
288
|
# Gets the persistence records based on this persistent modes for this pool.
|
|
289
|
+
# @rspec_example
|
|
257
290
|
# @return [PersistenceRecord[]]
|
|
258
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
259
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
260
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
291
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
292
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
293
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
261
294
|
# @param [Hash] opts
|
|
262
295
|
# @option opts [IControl::LocalLB::PersistenceMode] :persistence_modes The persistence modes from which we retrieve the persistence records. If the specified persistence mode is PERSIST_MODE_NONE, then all persistence records regardless of persistence mode will be returned for that pool.
|
|
263
296
|
def persistence_record(opts)
|
|
@@ -267,56 +300,63 @@ module IControl::LocalLB
|
|
|
267
300
|
|
|
268
301
|
##
|
|
269
302
|
# Gets the IP ToS values for server traffic for this pool.
|
|
303
|
+
# @rspec_example
|
|
270
304
|
# @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.
|
|
305
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
306
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
307
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
274
308
|
def server_ip_tos
|
|
275
309
|
super
|
|
276
310
|
end
|
|
277
311
|
|
|
278
312
|
##
|
|
279
313
|
# Gets the link QoS values for server traffic for this pool.
|
|
314
|
+
# @rspec_example
|
|
280
315
|
# @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.
|
|
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.
|
|
284
319
|
def server_link_qos
|
|
285
320
|
super
|
|
286
321
|
end
|
|
287
322
|
|
|
288
323
|
##
|
|
289
324
|
# Gets the simple timeouts for this pool.
|
|
325
|
+
# @rspec_example
|
|
290
326
|
# @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.
|
|
327
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
328
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
329
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
294
330
|
def simple_timeout
|
|
295
331
|
super
|
|
296
332
|
end
|
|
297
333
|
|
|
298
334
|
##
|
|
299
|
-
# Gets the ramp-up time (in seconds) to gradually ramp up the load on newly added or
|
|
335
|
+
# Gets the ramp-up time (in seconds) to gradually ramp up the load on newly added or
|
|
336
|
+
# freshly detected UP pool members.
|
|
337
|
+
# @rspec_example
|
|
300
338
|
# @return [long]
|
|
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.
|
|
339
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
340
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
341
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
304
342
|
def slow_ramp_time
|
|
305
343
|
super
|
|
306
344
|
end
|
|
307
345
|
|
|
308
346
|
##
|
|
309
347
|
# Gets the statistics for this pool.
|
|
348
|
+
# @rspec_example
|
|
310
349
|
# @return [PoolStatistics]
|
|
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.
|
|
350
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
351
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
352
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
314
353
|
def statistics
|
|
315
354
|
super
|
|
316
355
|
end
|
|
317
356
|
|
|
318
357
|
##
|
|
319
358
|
# Gets the version information for this interface.
|
|
359
|
+
# @rspec_example
|
|
320
360
|
# @return [String]
|
|
321
361
|
def version
|
|
322
362
|
super
|
|
@@ -324,9 +364,10 @@ module IControl::LocalLB
|
|
|
324
364
|
|
|
325
365
|
##
|
|
326
366
|
# Removes members from this pool.
|
|
327
|
-
# @
|
|
328
|
-
# @raise [IControl::Common::
|
|
329
|
-
# @raise [IControl::Common::
|
|
367
|
+
# @rspec_example
|
|
368
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
369
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
370
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
330
371
|
# @param [Hash] opts
|
|
331
372
|
# @option opts [IControl::Common::IPPortDefinition[]] :members The members to delete from the pools.
|
|
332
373
|
def remove_member(opts)
|
|
@@ -335,28 +376,33 @@ module IControl::LocalLB
|
|
|
335
376
|
end
|
|
336
377
|
|
|
337
378
|
##
|
|
338
|
-
# Removes the monitor associations for this pool. This basically deletes the monitor
|
|
339
|
-
#
|
|
340
|
-
#
|
|
341
|
-
# @
|
|
379
|
+
# Removes the monitor associations for this pool. This basically deletes the monitor
|
|
380
|
+
# associations between a pool and a monitor rule, i.e. this pool will no longer be
|
|
381
|
+
# monitored.
|
|
382
|
+
# @rspec_example
|
|
383
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
384
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
385
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
342
386
|
def remove_monitor_association
|
|
343
387
|
super
|
|
344
388
|
end
|
|
345
389
|
|
|
346
390
|
##
|
|
347
391
|
# Resets the statistics for this pool.
|
|
348
|
-
# @
|
|
349
|
-
# @raise [IControl::Common::
|
|
350
|
-
# @raise [IControl::Common::
|
|
392
|
+
# @rspec_example
|
|
393
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
394
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
395
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
351
396
|
def reset_statistics
|
|
352
397
|
super
|
|
353
398
|
end
|
|
354
399
|
|
|
355
400
|
##
|
|
356
401
|
# Sets the action to take when the node goes down for this pool.
|
|
357
|
-
# @
|
|
358
|
-
# @raise [IControl::Common::
|
|
359
|
-
# @raise [IControl::Common::
|
|
402
|
+
# @rspec_example
|
|
403
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
404
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
405
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
360
406
|
# @param [Hash] opts
|
|
361
407
|
# @option opts [IControl::LocalLB::ServiceDownAction] :actions The action to take when the node goes down for the specified pools.
|
|
362
408
|
def set_action_on_service_down(opts)
|
|
@@ -366,9 +412,10 @@ module IControl::LocalLB
|
|
|
366
412
|
|
|
367
413
|
##
|
|
368
414
|
# Sets the states indicating whether NATs are allowed for this pool.
|
|
369
|
-
# @
|
|
370
|
-
# @raise [IControl::Common::
|
|
371
|
-
# @raise [IControl::Common::
|
|
415
|
+
# @rspec_example
|
|
416
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
417
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
418
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
372
419
|
# @param [Hash] opts
|
|
373
420
|
# @option opts [IControl::Common::EnabledState] :states The NAT allow/disallow states of the specified pools.
|
|
374
421
|
def set_allow_nat_state(opts)
|
|
@@ -378,9 +425,10 @@ module IControl::LocalLB
|
|
|
378
425
|
|
|
379
426
|
##
|
|
380
427
|
# Sets the states indicating whether SNATs are allowed for this pool.
|
|
381
|
-
# @
|
|
382
|
-
# @raise [IControl::Common::
|
|
383
|
-
# @raise [IControl::Common::
|
|
428
|
+
# @rspec_example
|
|
429
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
430
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
431
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
384
432
|
# @param [Hash] opts
|
|
385
433
|
# @option opts [IControl::Common::EnabledState] :states The SNAT allow/disallow states of the specified pools.
|
|
386
434
|
def set_allow_snat_state(opts)
|
|
@@ -390,9 +438,10 @@ module IControl::LocalLB
|
|
|
390
438
|
|
|
391
439
|
##
|
|
392
440
|
# Sets the IP ToS values for client traffic for this pool.
|
|
393
|
-
# @
|
|
394
|
-
# @raise [IControl::Common::
|
|
395
|
-
# @raise [IControl::Common::
|
|
441
|
+
# @rspec_example
|
|
442
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
443
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
444
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
396
445
|
# @param [Hash] opts
|
|
397
446
|
# @option opts [long] :values The client IP ToS values.
|
|
398
447
|
def set_client_ip_tos(opts)
|
|
@@ -402,9 +451,10 @@ module IControl::LocalLB
|
|
|
402
451
|
|
|
403
452
|
##
|
|
404
453
|
# Sets the link QoS values for client traffic for this pool.
|
|
405
|
-
# @
|
|
406
|
-
# @raise [IControl::Common::
|
|
407
|
-
# @raise [IControl::Common::
|
|
454
|
+
# @rspec_example
|
|
455
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
456
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
457
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
408
458
|
# @param [Hash] opts
|
|
409
459
|
# @option opts [long] :values The client-side link QoS values.
|
|
410
460
|
def set_client_link_qos(opts)
|
|
@@ -414,9 +464,10 @@ module IControl::LocalLB
|
|
|
414
464
|
|
|
415
465
|
##
|
|
416
466
|
# Sets the gateway failsafe unit IDs for this pool.
|
|
417
|
-
# @
|
|
418
|
-
# @raise [IControl::Common::
|
|
419
|
-
# @raise [IControl::Common::
|
|
467
|
+
# @rspec_example
|
|
468
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
469
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
470
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
420
471
|
# @param [Hash] opts
|
|
421
472
|
# @option opts [long] :unit_ids The gateway failsafe unit IDs of the specified pools.
|
|
422
473
|
def set_gateway_failsafe_unit_id(opts)
|
|
@@ -426,9 +477,10 @@ module IControl::LocalLB
|
|
|
426
477
|
|
|
427
478
|
##
|
|
428
479
|
# Sets the load balancing methods for this pool.
|
|
429
|
-
# @
|
|
430
|
-
# @raise [IControl::Common::
|
|
431
|
-
# @raise [IControl::Common::
|
|
480
|
+
# @rspec_example
|
|
481
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
482
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
483
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
432
484
|
# @param [Hash] opts
|
|
433
485
|
# @option opts [IControl::LocalLB::LBMethod] :lb_methods The load balancing methods to use for the pools.
|
|
434
486
|
def set_lb_method(opts)
|
|
@@ -438,9 +490,10 @@ module IControl::LocalLB
|
|
|
438
490
|
|
|
439
491
|
##
|
|
440
492
|
# Sets the minimum active member counts for this pool.
|
|
441
|
-
# @
|
|
442
|
-
# @raise [IControl::Common::
|
|
443
|
-
# @raise [IControl::Common::
|
|
493
|
+
# @rspec_example
|
|
494
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
495
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
496
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
444
497
|
# @param [Hash] opts
|
|
445
498
|
# @option opts [long] :values The minimum active member counts of the specified pools.
|
|
446
499
|
def set_minimum_active_member(opts)
|
|
@@ -450,9 +503,10 @@ module IControl::LocalLB
|
|
|
450
503
|
|
|
451
504
|
##
|
|
452
505
|
# Sets the minimum member counts that are required to be UP for this pool.
|
|
453
|
-
# @
|
|
454
|
-
# @raise [IControl::Common::
|
|
455
|
-
# @raise [IControl::Common::
|
|
506
|
+
# @rspec_example
|
|
507
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
508
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
509
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
456
510
|
# @param [Hash] opts
|
|
457
511
|
# @option opts [long] :values The minimum UP member counts of the specified pools.
|
|
458
512
|
def set_minimum_up_member(opts)
|
|
@@ -461,10 +515,12 @@ module IControl::LocalLB
|
|
|
461
515
|
end
|
|
462
516
|
|
|
463
517
|
##
|
|
464
|
-
# Sets the actions to be taken if the minimum number of members required to be UP for
|
|
465
|
-
#
|
|
466
|
-
# @
|
|
467
|
-
# @raise [IControl::Common::
|
|
518
|
+
# Sets the actions to be taken if the minimum number of members required to be UP for
|
|
519
|
+
# this pool is not met.
|
|
520
|
+
# @rspec_example
|
|
521
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
522
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
523
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
468
524
|
# @param [Hash] opts
|
|
469
525
|
# @option opts [IControl::Common::HAAction] :actions The actions to be taken if the minimum number of members required to be UP for the specified pools is not met.
|
|
470
526
|
def set_minimum_up_member_action(opts)
|
|
@@ -473,10 +529,12 @@ module IControl::LocalLB
|
|
|
473
529
|
end
|
|
474
530
|
|
|
475
531
|
##
|
|
476
|
-
# Sets the states indicating that the feature that requires a minimum number of members
|
|
477
|
-
#
|
|
478
|
-
# @
|
|
479
|
-
# @raise [IControl::Common::
|
|
532
|
+
# Sets the states indicating that the feature that requires a minimum number of members
|
|
533
|
+
# to be UP is enabled/disabled for this pool.
|
|
534
|
+
# @rspec_example
|
|
535
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
536
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
537
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
480
538
|
# @param [Hash] opts
|
|
481
539
|
# @option opts [IControl::Common::EnabledState] :states The minimum UP member states of the specified pools.
|
|
482
540
|
def set_minimum_up_member_enabled_state(opts)
|
|
@@ -485,10 +543,12 @@ module IControl::LocalLB
|
|
|
485
543
|
end
|
|
486
544
|
|
|
487
545
|
##
|
|
488
|
-
# Sets/creates the monitor associations for this pool. This basically creates the monitor
|
|
489
|
-
#
|
|
490
|
-
# @
|
|
491
|
-
# @raise [IControl::Common::
|
|
546
|
+
# Sets/creates the monitor associations for this pool. This basically creates the monitor
|
|
547
|
+
# associations between a pool and a monitor rule.
|
|
548
|
+
# @rspec_example
|
|
549
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
550
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
551
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
492
552
|
# @param [Hash] opts
|
|
493
553
|
# @option opts [IControl::LocalLB::Pool::MonitorAssociation] :monitor_associations The monitor associations that will be used to evaluate the specified pools.
|
|
494
554
|
def set_monitor_association(opts)
|
|
@@ -498,9 +558,10 @@ module IControl::LocalLB
|
|
|
498
558
|
|
|
499
559
|
##
|
|
500
560
|
# Sets the IP ToS values for server traffic for this pool.
|
|
501
|
-
# @
|
|
502
|
-
# @raise [IControl::Common::
|
|
503
|
-
# @raise [IControl::Common::
|
|
561
|
+
# @rspec_example
|
|
562
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
563
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
564
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
504
565
|
# @param [Hash] opts
|
|
505
566
|
# @option opts [long] :values The server IP ToS values.
|
|
506
567
|
def set_server_ip_tos(opts)
|
|
@@ -510,9 +571,10 @@ module IControl::LocalLB
|
|
|
510
571
|
|
|
511
572
|
##
|
|
512
573
|
# Sets the link QoS values for server traffic for this pool.
|
|
513
|
-
# @
|
|
514
|
-
# @raise [IControl::Common::
|
|
515
|
-
# @raise [IControl::Common::
|
|
574
|
+
# @rspec_example
|
|
575
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
576
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
577
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
516
578
|
# @param [Hash] opts
|
|
517
579
|
# @option opts [long] :values The server link QoS values.
|
|
518
580
|
def set_server_link_qos(opts)
|
|
@@ -522,9 +584,10 @@ module IControl::LocalLB
|
|
|
522
584
|
|
|
523
585
|
##
|
|
524
586
|
# Sets the simple timeouts for this pool.
|
|
525
|
-
# @
|
|
526
|
-
# @raise [IControl::Common::
|
|
527
|
-
# @raise [IControl::Common::
|
|
587
|
+
# @rspec_example
|
|
588
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
589
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
590
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
528
591
|
# @param [Hash] opts
|
|
529
592
|
# @option opts [long] :simple_timeouts The simple timeouts.
|
|
530
593
|
def set_simple_timeout(opts)
|
|
@@ -533,10 +596,12 @@ module IControl::LocalLB
|
|
|
533
596
|
end
|
|
534
597
|
|
|
535
598
|
##
|
|
536
|
-
# Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or
|
|
537
|
-
#
|
|
538
|
-
# @
|
|
539
|
-
# @raise [IControl::Common::
|
|
599
|
+
# Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or
|
|
600
|
+
# freshly detected UP pool members.
|
|
601
|
+
# @rspec_example
|
|
602
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
603
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
604
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
540
605
|
# @param [Hash] opts
|
|
541
606
|
# @option opts [long] :values The ramp-up times.
|
|
542
607
|
def set_slow_ramp_time(opts)
|
|
@@ -556,19 +621,15 @@ module IControl::LocalLB
|
|
|
556
621
|
##
|
|
557
622
|
# A struct that describes statistics for a particular pool.
|
|
558
623
|
# @attr [String] pool_name The pool name.
|
|
559
|
-
# @attr [IControl::Common::
|
|
624
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the pool.
|
|
560
625
|
class PoolStatisticEntry < IControl::Base::Struct
|
|
561
626
|
icontrol_attribute :pool_name, String
|
|
562
627
|
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
563
628
|
end
|
|
564
|
-
## A sequence of monitor associations.
|
|
565
|
-
class MonitorAssociationSequence < IControl::Base::Sequence ; end
|
|
566
|
-
## A sequence of Pool statistics.
|
|
567
|
-
class PoolStatisticEntrySequence < IControl::Base::Sequence ; end
|
|
568
629
|
|
|
569
630
|
##
|
|
570
631
|
# A struct that describes pool statistics and timestamp.
|
|
571
|
-
# @attr [IControl::LocalLB::Pool::
|
|
632
|
+
# @attr [IControl::LocalLB::Pool::PoolStatisticEntrySequence] statistics The statistics for a sequence of pools.
|
|
572
633
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
573
634
|
class PoolStatistics < IControl::Base::Struct
|
|
574
635
|
icontrol_attribute :statistics, IControl::LocalLB::Pool::PoolStatisticEntrySequence
|
|
@@ -576,5 +637,9 @@ module IControl::LocalLB
|
|
|
576
637
|
end
|
|
577
638
|
|
|
578
639
|
|
|
640
|
+
## A sequence of monitor associations.
|
|
641
|
+
class MonitorAssociationSequence < IControl::Base::Sequence ; end
|
|
642
|
+
## A sequence of Pool statistics.
|
|
643
|
+
class PoolStatisticEntrySequence < IControl::Base::Sequence ; end
|
|
579
644
|
end
|
|
580
645
|
end
|