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.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -9,11 +9,17 @@ module IControl::GlobalLB
9
9
  class PoolMemberDefinition < IControl::Base::Struct; end
10
10
  class PoolMetricLimit < IControl::Base::Struct; end
11
11
  class PoolStatisticEntry < IControl::Base::Struct; end
12
- class PoolStatistics < IControl::Base::Struct; end ##
12
+ class PoolStatistics < IControl::Base::Struct; end
13
+ class MonitorAssociationSequence < IControl::Base::Sequence ; end
14
+ class PoolMemberDefinitionSequence < IControl::Base::Sequence ; end
15
+ class PoolMemberDefinitionSequenceSequence < IControl::Base::SequenceSequence ; end
16
+ class PoolMetricLimitSequence < IControl::Base::Sequence ; end
17
+ class PoolStatisticEntrySequence < IControl::Base::Sequence ; end ##
13
18
  # Adds members to this pool.
14
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
15
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
16
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
19
+ # @rspec_example
20
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
21
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
22
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
17
23
  # @param [Hash] opts
18
24
  # @option opts [IControl::GlobalLB::Pool::PoolMemberDefinition[]] :members The members to add to the pools.
19
25
  def add_member(opts)
@@ -23,9 +29,10 @@ module IControl::GlobalLB
23
29
 
24
30
  ##
25
31
  # Creates this pool.
26
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
27
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
28
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
32
+ # @rspec_example
33
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
34
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
35
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
29
36
  # @param [Hash] opts
30
37
  # @option opts [IControl::GlobalLB::LBMethod] :lb_methods The load balancing methods to use for the pools.
31
38
  # @option opts [IControl::GlobalLB::Pool::PoolMemberDefinition[]] :members The lists of initial members of the pools.
@@ -36,304 +43,345 @@ module IControl::GlobalLB
36
43
 
37
44
  ##
38
45
  # Deletes all pool.
39
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
40
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
41
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
46
+ # @rspec_example
47
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
48
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
49
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
42
50
  def delete_all_pools
43
51
  super
44
52
  end
45
53
 
46
54
  ##
47
55
  # Deletes this pool.
48
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
56
+ # @rspec_example
57
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
58
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
59
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
51
60
  def delete_pool
52
61
  super
53
62
  end
54
63
 
55
64
  ##
56
65
  # Gets the statistics for all the pool.
66
+ # @rspec_example
57
67
  # @return [PoolStatistics]
58
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
59
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
60
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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 all_statistics
62
72
  super
63
73
  end
64
74
 
65
75
  ##
66
76
  # Gets the alternate load balancing methods for this pool.
77
+ # @rspec_example
67
78
  # @return [LBMethod]
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 alternate_lb_method
72
83
  super
73
84
  end
74
85
 
75
86
  ##
76
87
  # Gets the number of answers to return 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 answers_to_return
82
94
  super
83
95
  end
84
96
 
85
97
  ##
86
98
  # Gets the CNAMEs for this pool.
99
+ # @rspec_example
87
100
  # @return [String]
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 cname
92
105
  super
93
106
  end
94
107
 
95
108
  ##
96
- # Gets the states to indicate whether to use dynamic ratio to modify the behavior of QOS.
109
+ # Gets the states to indicate whether to use dynamic ratio to modify the behavior of
110
+ # QOS.
111
+ # @rspec_example
97
112
  # @return [EnabledState]
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.
113
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
115
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
101
116
  def dynamic_ratio_state
102
117
  super
103
118
  end
104
119
 
105
120
  ##
106
121
  # Gets the enabled state of this pool.
122
+ # @rspec_example
107
123
  # @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.
124
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
125
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
126
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
111
127
  def enabled_state
112
128
  super
113
129
  end
114
130
 
115
131
  ##
116
132
  # Gets the fallback/emergency failure IP for this pool.
133
+ # @rspec_example
117
134
  # @return [String]
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.
135
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
136
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
137
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
121
138
  def fallback_ip
122
139
  super
123
140
  end
124
141
 
125
142
  ##
126
143
  # Gets the fallback load balancing methods for this pool.
144
+ # @rspec_example
127
145
  # @return [LBMethod]
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.
146
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
147
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
148
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
131
149
  def fallback_lb_method
132
150
  super
133
151
  end
134
152
 
135
153
  ##
136
154
  # Gets all metrics limits for a sequence of pool.
155
+ # @rspec_example
137
156
  # @return [PoolMetricLimit]
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.
157
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
158
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
159
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
141
160
  def limit
142
161
  super
143
162
  end
144
163
 
145
164
  ##
146
165
  # Gets a list of pool.
166
+ # @rspec_example
147
167
  # @return [String]
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.
168
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
169
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
170
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
151
171
  def list
152
172
  super
153
173
  end
154
174
 
155
175
  ##
156
- # Gets the states indicating whether to disable pool members when pool member status goes from Green to Red.
176
+ # Gets the states indicating whether to disable pool members when pool member status
177
+ # goes from Green to Red.
178
+ # @rspec_example
157
179
  # @return [EnabledState]
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.
180
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
181
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
182
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
161
183
  def manual_resume_state
162
184
  super
163
185
  end
164
186
 
165
187
  ##
166
188
  # Gets a list of pool members.
189
+ # @rspec_example
167
190
  # @return [PoolMemberDefinition[]]
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.
191
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
192
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
193
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
171
194
  def member
172
195
  super
173
196
  end
174
197
 
175
198
  ##
176
199
  # Gets the monitor associations for this pool, i.e. the monitor rules used by the pool.
200
+ # @rspec_example
177
201
  # @return [MonitorAssociation]
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.
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.
181
205
  def monitor_association
182
206
  super
183
207
  end
184
208
 
185
209
  ##
186
210
  # Gets the statuses of this pool.
211
+ # @rspec_example
187
212
  # @return [ObjectStatus]
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.
213
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
214
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
215
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
191
216
  def object_status
192
217
  super
193
218
  end
194
219
 
195
220
  ##
196
221
  # Gets the preferred load balancing methods for this pool.
222
+ # @rspec_example
197
223
  # @return [LBMethod]
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.
224
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
225
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
226
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
201
227
  def preferred_lb_method
202
228
  super
203
229
  end
204
230
 
205
231
  ##
206
- # Gets the relative weight for bits per second when the load balancing mode is set to LB_METHOD_QOS.
232
+ # Gets the relative weight for bits per second when the load balancing mode is set
233
+ # to LB_METHOD_QOS.
234
+ # @rspec_example
207
235
  # @return [long]
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.
236
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
237
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
238
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
211
239
  def qos_coefficient_bps
212
240
  super
213
241
  end
214
242
 
215
243
  ##
216
- # Gets the relative weight for connection rate when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.
244
+ # Gets the relative weight for connection rate when the load balancing mode is set
245
+ # to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.
246
+ # @rspec_example
217
247
  # @return [long]
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.
248
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
249
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
250
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
221
251
  def qos_coefficient_connection_rate
222
252
  super
223
253
  end
224
254
 
225
255
  ##
226
- # Gets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS.
256
+ # Gets the relative weight for ping packet completion rate when the load balancing
257
+ # mode is set to LB_METHOD_QOS.
258
+ # @rspec_example
227
259
  # @return [long]
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.
260
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
261
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
262
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
231
263
  def qos_coefficient_hit_ratio
232
264
  super
233
265
  end
234
266
 
235
267
  ##
236
268
  # Gets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS.
269
+ # @rspec_example
237
270
  # @return [long]
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.
271
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
272
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
273
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
241
274
  def qos_coefficient_hops
242
275
  super
243
276
  end
244
277
 
245
278
  ##
246
- # Gets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS.
279
+ # Gets the relative weight for link capacity when the load balancing mode is set to
280
+ # LB_METHOD_QOS.
281
+ # @rspec_example
247
282
  # @return [long]
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.
283
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
284
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
285
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
251
286
  def qos_coefficient_lcs
252
287
  super
253
288
  end
254
289
 
255
290
  ##
256
291
  # Gets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS.
292
+ # @rspec_example
257
293
  # @return [long]
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.
294
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
295
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
296
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
261
297
  def qos_coefficient_packet_rate
262
298
  super
263
299
  end
264
300
 
265
301
  ##
266
- # Gets the relative weight for round-trip time when the load balancing mode is set to LB_METHOD_QOS.
302
+ # Gets the relative weight for round-trip time when the load balancing mode is set
303
+ # to LB_METHOD_QOS.
304
+ # @rspec_example
267
305
  # @return [long]
268
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
269
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
270
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
306
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
307
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
308
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
271
309
  def qos_coefficient_rtt
272
310
  super
273
311
  end
274
312
 
275
313
  ##
276
314
  # Gets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS.
315
+ # @rspec_example
277
316
  # @return [long]
278
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
279
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
280
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
317
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
318
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
319
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
281
320
  def qos_coefficient_topology
282
321
  super
283
322
  end
284
323
 
285
324
  ##
286
- # Gets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS.
325
+ # Gets the relative weight for virtual server capacity when the load balancing mode
326
+ # is set to LB_METHOD_QOS.
327
+ # @rspec_example
287
328
  # @return [long]
288
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
289
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
290
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
329
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
330
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
331
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
291
332
  def qos_coefficient_vs_capacity
292
333
  super
293
334
  end
294
335
 
295
336
  ##
296
- # Gets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS.
337
+ # Gets the relative weight for virtual server (VS) score when the load balancing mode
338
+ # is set to LB_METHOD_QOS.
339
+ # @rspec_example
297
340
  # @return [long]
298
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
299
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
300
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
341
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
342
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
343
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
301
344
  def qos_coefficient_vs_score
302
345
  super
303
346
  end
304
347
 
305
348
  ##
306
349
  # Gets the statistics for this pool.
350
+ # @rspec_example
307
351
  # @return [PoolStatistics]
308
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
309
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
310
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
352
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
353
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
354
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
311
355
  def statistics
312
356
  super
313
357
  end
314
358
 
315
359
  ##
316
360
  # Gets the TTL values for this pool.
361
+ # @rspec_example
317
362
  # @return [long]
318
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
319
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
320
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
363
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
364
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
365
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
321
366
  def ttl
322
367
  super
323
368
  end
324
369
 
325
370
  ##
326
- # Gets the states to indicate whether to check the availability of pool member availability before using them.
371
+ # Gets the states to indicate whether to check the availability of pool member availability
372
+ # before using them.
373
+ # @rspec_example
327
374
  # @return [EnabledState]
328
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
329
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
330
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
375
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
376
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
377
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
331
378
  def verify_member_availability_state
332
379
  super
333
380
  end
334
381
 
335
382
  ##
336
383
  # Gets the version information for this interface.
384
+ # @rspec_example
337
385
  # @return [String]
338
386
  def version
339
387
  super
@@ -341,9 +389,10 @@ module IControl::GlobalLB
341
389
 
342
390
  ##
343
391
  # Removes members from this pool.
344
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
345
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
346
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
347
396
  # @param [Hash] opts
348
397
  # @option opts [IControl::Common::IPPortDefinition[]] :members The members to delete from the pools.
349
398
  def remove_member(opts)
@@ -352,28 +401,33 @@ module IControl::GlobalLB
352
401
  end
353
402
 
354
403
  ##
355
- # Removes the monitor associations for this pool. This basically deletes the monitor associations between a pool and a monitor rule, i.e. this pool will no longer be monitored.
356
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
357
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
358
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
404
+ # Removes the monitor associations for this pool. This basically deletes the monitor
405
+ # associations between a pool and a monitor rule, i.e. this pool will no longer be
406
+ # monitored.
407
+ # @rspec_example
408
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
409
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
410
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
359
411
  def remove_monitor_association
360
412
  super
361
413
  end
362
414
 
363
415
  ##
364
416
  # Resets the statistics for this pool.
365
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
366
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
367
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
417
+ # @rspec_example
418
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
419
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
420
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
368
421
  def reset_statistics
369
422
  super
370
423
  end
371
424
 
372
425
  ##
373
426
  # Sets the alternate load balancing methods for this pool.
374
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
375
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
376
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
427
+ # @rspec_example
428
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
429
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
430
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
377
431
  # @param [Hash] opts
378
432
  # @option opts [IControl::GlobalLB::LBMethod] :lb_methods The alternate load balancing methods to use for the pools.
379
433
  def set_alternate_lb_method(opts)
@@ -383,9 +437,10 @@ module IControl::GlobalLB
383
437
 
384
438
  ##
385
439
  # Sets the number of answers to return for this pool.
386
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
387
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
388
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
440
+ # @rspec_example
441
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
442
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
443
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
389
444
  # @param [Hash] opts
390
445
  # @option opts [long] :answers The Round Robin LDNS limits to set for the pools.
391
446
  def set_answers_to_return(opts)
@@ -395,9 +450,10 @@ module IControl::GlobalLB
395
450
 
396
451
  ##
397
452
  # Sets the CNAMEs for this pool.
398
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
399
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
400
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
453
+ # @rspec_example
454
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
455
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
456
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
401
457
  # @param [Hash] opts
402
458
  # @option opts [String] :cnames The CNAMEs for the specified pools.
403
459
  def set_cname(opts)
@@ -406,10 +462,12 @@ module IControl::GlobalLB
406
462
  end
407
463
 
408
464
  ##
409
- # Sets the states to indicate whether to use dynamic ratio to modify the behavior of QOS.
410
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
411
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
412
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
465
+ # Sets the states to indicate whether to use dynamic ratio to modify the behavior of
466
+ # QOS.
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.
413
471
  # @param [Hash] opts
414
472
  # @option opts [IControl::Common::EnabledState] :states The states to set for the pools.
415
473
  def set_dynamic_ratio_state(opts)
@@ -419,9 +477,10 @@ module IControl::GlobalLB
419
477
 
420
478
  ##
421
479
  # Sets the enabled state of this pool.
422
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
423
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
424
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
425
484
  # @param [Hash] opts
426
485
  # @option opts [IControl::Common::EnabledState] :states The enabled states to set.
427
486
  def set_enabled_state(opts)
@@ -431,9 +490,10 @@ module IControl::GlobalLB
431
490
 
432
491
  ##
433
492
  # Sets the fallback/emergency failure IP for this pool.
434
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
435
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
436
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
437
497
  # @param [Hash] opts
438
498
  # @option opts [String] :ips The fallback IP addresses for the specified pools.
439
499
  def set_fallback_ip(opts)
@@ -443,9 +503,10 @@ module IControl::GlobalLB
443
503
 
444
504
  ##
445
505
  # Sets the fallback load balancing methods for this pool.
446
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
447
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
448
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
449
510
  # @param [Hash] opts
450
511
  # @option opts [IControl::GlobalLB::LBMethod] :lb_methods The fallback load balancing methods to use for the pools.
451
512
  def set_fallback_lb_method(opts)
@@ -455,9 +516,10 @@ module IControl::GlobalLB
455
516
 
456
517
  ##
457
518
  # Sets the limits for pool metrics.
458
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
459
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
460
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
519
+ # @rspec_example
520
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
521
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
522
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
461
523
  # @param [Hash] opts
462
524
  # @option opts [IControl::GlobalLB::Pool::PoolMetricLimit] :limits The pools' metric limits.
463
525
  def set_limit(opts)
@@ -466,10 +528,12 @@ module IControl::GlobalLB
466
528
  end
467
529
 
468
530
  ##
469
- # Sets the states indicating whether to disable pool members when pool member status goes from Green to Red.
470
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
471
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
472
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
531
+ # Sets the states indicating whether to disable pool members when pool member status
532
+ # goes from Green to Red.
533
+ # @rspec_example
534
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
535
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
536
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
473
537
  # @param [Hash] opts
474
538
  # @option opts [IControl::Common::EnabledState] :states The states to set for the pools.
475
539
  def set_manual_resume_state(opts)
@@ -478,10 +542,12 @@ module IControl::GlobalLB
478
542
  end
479
543
 
480
544
  ##
481
- # Sets/creates the monitor associations for this pool. This basically creates the monitor associations between a pool and a monitor rule.
482
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
483
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
484
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
545
+ # Sets/creates the monitor associations for this pool. This basically creates the monitor
546
+ # associations between a pool and a monitor rule.
547
+ # @rspec_example
548
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
549
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
550
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
485
551
  # @param [Hash] opts
486
552
  # @option opts [IControl::GlobalLB::Pool::MonitorAssociation] :monitor_associations The monitor associations that will be used to evaluate the specified pools.
487
553
  def set_monitor_association(opts)
@@ -491,9 +557,10 @@ module IControl::GlobalLB
491
557
 
492
558
  ##
493
559
  # Sets the preferred load balancing methods for this pool.
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.
560
+ # @rspec_example
561
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
562
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
563
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
497
564
  # @param [Hash] opts
498
565
  # @option opts [IControl::GlobalLB::LBMethod] :lb_methods The preferred load balancing methods to use for the pools.
499
566
  def set_preferred_lb_method(opts)
@@ -502,10 +569,12 @@ module IControl::GlobalLB
502
569
  end
503
570
 
504
571
  ##
505
- # Sets the relative weight for bits per second when the load balancing mode is set to LB_METHOD_QOS.
506
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
507
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
508
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
572
+ # Sets the relative weight for bits per second when the load balancing mode is set
573
+ # to LB_METHOD_QOS.
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.
509
578
  # @param [Hash] opts
510
579
  # @option opts [long] :values The bits per second QoS coefficients of the specified pools.
511
580
  def set_qos_coefficient_bps(opts)
@@ -514,10 +583,12 @@ module IControl::GlobalLB
514
583
  end
515
584
 
516
585
  ##
517
- # Sets the relative weight for connection rate when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.
518
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
519
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
520
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
586
+ # Sets the relative weight for connection rate when the load balancing mode is set
587
+ # to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.
588
+ # @rspec_example
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.
521
592
  # @param [Hash] opts
522
593
  # @option opts [long] :values The connection rate QoS coefficients of the specified pools.
523
594
  def set_qos_coefficient_connection_rate(opts)
@@ -526,10 +597,12 @@ module IControl::GlobalLB
526
597
  end
527
598
 
528
599
  ##
529
- # Sets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS.
530
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
531
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
532
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
600
+ # Sets the relative weight for ping packet completion rate when the load balancing
601
+ # mode is set to LB_METHOD_QOS.
602
+ # @rspec_example
603
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
604
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
605
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
533
606
  # @param [Hash] opts
534
607
  # @option opts [long] :values The ping packet completion rate QoS coefficients of the specified pools.
535
608
  def set_qos_coefficient_hit_ratio(opts)
@@ -539,9 +612,10 @@ module IControl::GlobalLB
539
612
 
540
613
  ##
541
614
  # Sets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS.
542
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
543
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
544
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
615
+ # @rspec_example
616
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
617
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
618
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
545
619
  # @param [Hash] opts
546
620
  # @option opts [long] :values The hops QoS coefficients of the specified pools.
547
621
  def set_qos_coefficient_hops(opts)
@@ -550,10 +624,12 @@ module IControl::GlobalLB
550
624
  end
551
625
 
552
626
  ##
553
- # Sets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS.
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.
627
+ # Sets the relative weight for link capacity when the load balancing mode is set to
628
+ # LB_METHOD_QOS.
629
+ # @rspec_example
630
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
631
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
632
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
557
633
  # @param [Hash] opts
558
634
  # @option opts [long] :values The link capacity QoS coefficients of the specified pools.
559
635
  def set_qos_coefficient_lcs(opts)
@@ -563,9 +639,10 @@ module IControl::GlobalLB
563
639
 
564
640
  ##
565
641
  # Sets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS.
566
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
567
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
568
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
642
+ # @rspec_example
643
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
644
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
645
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
569
646
  # @param [Hash] opts
570
647
  # @option opts [long] :values The packet rate QoS coefficients of the specified pools.
571
648
  def set_qos_coefficient_packet_rate(opts)
@@ -574,10 +651,12 @@ module IControl::GlobalLB
574
651
  end
575
652
 
576
653
  ##
577
- # Sets the relative weight for round-trip time when the load balancing mode is set to LB_METHOD_QOS.
578
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
579
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
580
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
654
+ # Sets the relative weight for round-trip time when the load balancing mode is set
655
+ # to LB_METHOD_QOS.
656
+ # @rspec_example
657
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
658
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
659
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
581
660
  # @param [Hash] opts
582
661
  # @option opts [long] :values The RTT QoS coefficients of the specified pools.
583
662
  def set_qos_coefficient_rtt(opts)
@@ -587,9 +666,10 @@ module IControl::GlobalLB
587
666
 
588
667
  ##
589
668
  # Sets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS.
590
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
591
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
592
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
669
+ # @rspec_example
670
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
671
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
672
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
593
673
  # @param [Hash] opts
594
674
  # @option opts [long] :values The topology QoS coefficients of the specified pools.
595
675
  def set_qos_coefficient_topology(opts)
@@ -598,10 +678,12 @@ module IControl::GlobalLB
598
678
  end
599
679
 
600
680
  ##
601
- # Sets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS.
602
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
603
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
604
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
681
+ # Sets the relative weight for virtual server capacity when the load balancing mode
682
+ # is set to LB_METHOD_QOS.
683
+ # @rspec_example
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.
605
687
  # @param [Hash] opts
606
688
  # @option opts [long] :values The virtual server capacity QoS coefficients of the specified pools.
607
689
  def set_qos_coefficient_vs_capacity(opts)
@@ -610,10 +692,12 @@ module IControl::GlobalLB
610
692
  end
611
693
 
612
694
  ##
613
- # Sets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS.
614
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
615
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
616
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
695
+ # Sets the relative weight for virtual server (VS) score when the load balancing mode
696
+ # is set to LB_METHOD_QOS.
697
+ # @rspec_example
698
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
699
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
700
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
617
701
  # @param [Hash] opts
618
702
  # @option opts [long] :values The VS score QoS coefficients of the specified pools.
619
703
  def set_qos_coefficient_vs_score(opts)
@@ -623,9 +707,10 @@ module IControl::GlobalLB
623
707
 
624
708
  ##
625
709
  # Sets the TTL values for this pool.
626
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
627
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
628
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
710
+ # @rspec_example
711
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
712
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
713
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
629
714
  # @param [Hash] opts
630
715
  # @option opts [long] :values The TTLs of the specified pools.
631
716
  def set_ttl(opts)
@@ -634,10 +719,12 @@ module IControl::GlobalLB
634
719
  end
635
720
 
636
721
  ##
637
- # Sets the states to indicate whether to check the availability of pool member availability before using them.
638
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
639
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
640
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
722
+ # Sets the states to indicate whether to check the availability of pool member availability
723
+ # before using them.
724
+ # @rspec_example
725
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
726
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
727
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
641
728
  # @param [Hash] opts
642
729
  # @option opts [IControl::Common::EnabledState] :states The states to set for the pools.
643
730
  def set_verify_member_availability_state(opts)
@@ -666,27 +753,27 @@ module IControl::GlobalLB
666
753
  ##
667
754
  # A struct that contains metric limits for a pool.
668
755
  # @attr [String] pool_name The pool name.
669
- # @attr [IControl::GlobalLB::MetricLimit] metric_limits Metric limits of the pool.
756
+ # @attr [IControl::GlobalLB::MetricLimitSequence] metric_limits Metric limits of the pool.
670
757
  class PoolMetricLimit < IControl::Base::Struct
671
758
  icontrol_attribute :pool_name, String
672
- icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimit
759
+ icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimitSequence
673
760
  end
674
761
 
675
762
  ##
676
763
  # A struct that describes statistics for a particular pool.
677
764
  # @attr [String] pool_name The pool name.
678
- # @attr [IControl::Common::Statistic] statistics The statistics for the pool.
765
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the pool.
679
766
  class PoolStatisticEntry < IControl::Base::Struct
680
767
  icontrol_attribute :pool_name, String
681
- icontrol_attribute :statistics, IControl::Common::Statistic
768
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
682
769
  end
683
770
 
684
771
  ##
685
772
  # A struct that describes pool statistics and timestamp.
686
- # @attr [IControl::GlobalLB::Pool::PoolStatisticEntry] statistics The statistics for a sequence of pools.
773
+ # @attr [IControl::GlobalLB::Pool::PoolStatisticEntrySequence] statistics The statistics for a sequence of pools.
687
774
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
688
775
  class PoolStatistics < IControl::Base::Struct
689
- icontrol_attribute :statistics, IControl::GlobalLB::Pool::PoolStatisticEntry
776
+ icontrol_attribute :statistics, IControl::GlobalLB::Pool::PoolStatisticEntrySequence
690
777
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
691
778
  end
692
779