icontrol 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -1,329 +1,380 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The ProfileFastL4 interface enables you to manipulate a local load balancer's L4 profile.
3
+ # The ProfileFastL4 interface enables you to manipulate a local load balancer's L4
4
+ # profile.
4
5
  class ProfileFastL4 < IControl::Base
5
6
 
6
7
  set_id_name "profile_names"
7
8
 
8
9
  class ProfileFastL4StatisticEntry < IControl::Base::Struct; end
9
- class ProfileFastL4Statistics < IControl::Base::Struct; end ##
10
+ class ProfileFastL4Statistics < IControl::Base::Struct; end
11
+ class ProfileFastL4StatisticEntrySequence < IControl::Base::Sequence ; end ##
10
12
  # Creates this profile.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
13
+ # @rspec_example
14
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
15
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
16
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
17
  def create
15
18
  super
16
19
  end
17
20
 
18
21
  ##
19
22
  # Deletes all profile.
20
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
21
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
22
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
23
+ # @rspec_example
24
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
25
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
26
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
23
27
  def delete_all_profiles
24
28
  super
25
29
  end
26
30
 
27
31
  ##
28
32
  # Deletes this profile.
29
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
30
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
31
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
33
+ # @rspec_example
34
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
35
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
36
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
32
37
  def delete_profile
33
38
  super
34
39
  end
35
40
 
36
41
  ##
37
42
  # Gets the statistics for all the profile.
43
+ # @rspec_example
38
44
  # @return [ProfileFastL4Statistics]
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.
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.
42
48
  def all_statistics
43
49
  super
44
50
  end
45
51
 
46
52
  ##
47
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
53
+ # Gets the names of the default profile from which this profile will derive default
54
+ # values for its attributes.
55
+ # @rspec_example
48
56
  # @return [String]
49
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
50
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
51
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
52
60
  def default_profile
53
61
  super
54
62
  end
55
63
 
56
64
  ##
57
65
  # Gets the preferred hardware acceleration modes for this profile.
66
+ # @rspec_example
58
67
  # @return [ProfileHardwareAccelerationMode]
59
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
- # @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.
62
71
  def hardware_acceleration_mode
63
72
  super
64
73
  end
65
74
 
66
75
  ##
67
76
  # Gets the state to enable/disable support for hardware SYN cookie.
77
+ # @rspec_example
68
78
  # @return [ProfileEnabledState]
69
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
70
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
71
- # @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.
72
82
  def hardware_syn_cookie_state
73
83
  super
74
84
  end
75
85
 
76
86
  ##
77
- # Gets the idle timeout for this profile. The number of seconds without traffic before a connection is eligible for deletion.
87
+ # Gets the idle timeout for this profile. The number of seconds without traffic before
88
+ # a connection is eligible for deletion.
89
+ # @rspec_example
78
90
  # @return [ProfileULong]
79
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
80
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
81
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
91
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
92
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
93
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
82
94
  def idle_timeout
83
95
  super
84
96
  end
85
97
 
86
98
  ##
87
- # Gets the IP fragment reassembly states for this profile. If true, reassemble the IP fragments.
99
+ # Gets the IP fragment reassembly states for this profile. If true, reassemble the
100
+ # IP fragments.
101
+ # @rspec_example
88
102
  # @return [ProfileEnabledState]
89
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
90
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
91
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
103
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
104
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
105
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
92
106
  def ip_fragment_reassemble_state
93
107
  super
94
108
  end
95
109
 
96
110
  ##
97
111
  # Gets the IP type of service set in packets sent to the clients.
112
+ # @rspec_example
98
113
  # @return [ProfileULong]
99
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
100
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
101
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
114
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
115
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
116
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
102
117
  def ip_tos_to_client
103
118
  super
104
119
  end
105
120
 
106
121
  ##
107
122
  # Gets the IP type of service set in packets sent to the servers.
123
+ # @rspec_example
108
124
  # @return [ProfileULong]
109
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
125
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
126
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
127
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
112
128
  def ip_tos_to_server
113
129
  super
114
130
  end
115
131
 
116
132
  ##
117
133
  # Gets the keep-alive probe interval for a set of FastL4 profile.
134
+ # @rspec_example
118
135
  # @return [ProfileULong]
119
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
120
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
121
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
136
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
137
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
138
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
122
139
  def keep_alive_interval
123
140
  super
124
141
  end
125
142
 
126
143
  ##
127
144
  # Gets the link quality of service set in packets sent to the clients.
145
+ # @rspec_example
128
146
  # @return [ProfileULong]
129
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
130
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
131
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
147
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
148
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
149
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
132
150
  def link_qos_to_client
133
151
  super
134
152
  end
135
153
 
136
154
  ##
137
155
  # Gets the link quality of service set in packets sent to the servers.
156
+ # @rspec_example
138
157
  # @return [ProfileULong]
139
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
140
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
141
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
158
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
159
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
160
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
142
161
  def link_qos_to_server
143
162
  super
144
163
  end
145
164
 
146
165
  ##
147
166
  # Gets a list of all profile.
167
+ # @rspec_example
148
168
  # @return [String]
149
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
150
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
151
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
169
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
170
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
171
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
152
172
  def list
153
173
  super
154
174
  end
155
175
 
156
176
  ##
157
- # Gets the state to aggressively close out a connection by allowing TMM to switch the idle_timeout to tcp_close_timeout once the first FIN packet has been seen.
177
+ # Gets the state to aggressively close out a connection by allowing TMM to switch the
178
+ # idle_timeout to tcp_close_timeout once the first FIN packet has been seen.
179
+ # @rspec_example
158
180
  # @return [ProfileEnabledState]
159
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
160
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
161
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
181
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
182
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
183
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
162
184
  def loose_close_state
163
185
  super
164
186
  end
165
187
 
166
188
  ##
167
- # Gets the state to allow any TCP packet to initiate a connection (rather than requiring a SYN).
189
+ # Gets the state to allow any TCP packet to initiate a connection (rather than requiring
190
+ # a SYN).
191
+ # @rspec_example
168
192
  # @return [ProfileEnabledState]
169
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
170
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
171
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
193
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
194
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
195
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
172
196
  def loose_initiation_state
173
197
  super
174
198
  end
175
199
 
176
200
  ##
177
- # Gets the MSS override values for this profile. If non-zero and less than the default value, this value overrides the maximum segment size.
201
+ # Gets the MSS override values for this profile. If non-zero and less than the default
202
+ # value, this value overrides the maximum segment size.
203
+ # @rspec_example
178
204
  # @return [ProfileULong]
179
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
180
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
181
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
205
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
206
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
207
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
182
208
  def mss_override
183
209
  super
184
210
  end
185
211
 
186
212
  ##
187
- # Gets the reset on timeout states for this profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.
213
+ # Gets the reset on timeout states for this profile. If true and a TCP connection exceeds
214
+ # its idle timeout, send a reset in addition to deleting the connection.
215
+ # @rspec_example
188
216
  # @return [ProfileEnabledState]
189
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
190
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
191
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
217
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
218
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
219
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
192
220
  def reset_on_timeout_state
193
221
  super
194
222
  end
195
223
 
196
224
  ##
197
- # Gets the state to use TCP timestamp options to measure the round trip time to the client.
225
+ # Gets the state to use TCP timestamp options to measure the round trip time to the
226
+ # client.
227
+ # @rspec_example
198
228
  # @return [ProfileEnabledState]
199
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
200
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
201
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
229
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
230
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
231
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
202
232
  def rtt_from_client_state
203
233
  super
204
234
  end
205
235
 
206
236
  ##
207
- # Gets the state to use TCP timestamp options to measure the round trip time to the server.
237
+ # Gets the state to use TCP timestamp options to measure the round trip time to the
238
+ # server.
239
+ # @rspec_example
208
240
  # @return [ProfileEnabledState]
209
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
210
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
211
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
241
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
242
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
243
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
212
244
  def rtt_from_server_state
213
245
  super
214
246
  end
215
247
 
216
248
  ##
217
249
  # Gets the state to enable/disable support for software SYN cookie.
250
+ # @rspec_example
218
251
  # @return [ProfileEnabledState]
219
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
252
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
253
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
254
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
222
255
  def software_syn_cookie_state
223
256
  super
224
257
  end
225
258
 
226
259
  ##
227
260
  # Gets the statistics for this profile.
261
+ # @rspec_example
228
262
  # @return [ProfileFastL4Statistics]
229
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
230
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
231
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
263
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
264
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
265
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
232
266
  def statistics
233
267
  super
234
268
  end
235
269
 
236
270
  ##
237
- # Gets the TCP close timeout for this profile. Only used when &amp;quot;loose_initiation" or &amp;quot;loose_close" is enabled. This is used to rapidly close out a loosely initiated connection after the first FIN packet has been seen (either client or server side).
271
+ # Gets the TCP close timeout for this profile. Only used when &amp;quot;loose_initiation"
272
+ # or &amp;quot;loose_close" is enabled. This is used to rapidly close out a loosely
273
+ # initiated connection after the first FIN packet has been seen (either client or server
274
+ # side).
275
+ # @rspec_example
238
276
  # @return [ProfileULong]
239
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
240
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
241
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
277
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
278
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
279
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
242
280
  def tcp_close_timeout
243
281
  super
244
282
  end
245
283
 
246
284
  ##
247
285
  # Gets the options to generate our own sequence numbers on all SYNs.
286
+ # @rspec_example
248
287
  # @return [ProfileEnabledState]
249
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
250
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
251
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
288
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
289
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
290
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
252
291
  def tcp_generate_isn_state
253
292
  super
254
293
  end
255
294
 
256
295
  ##
257
- # Gets the TCP handshake timeout for this profile. The number of seconds without traffic before a connection in the SYN received state is eligible for deletion.
296
+ # Gets the TCP handshake timeout for this profile. The number of seconds without traffic
297
+ # before a connection in the SYN received state is eligible for deletion.
298
+ # @rspec_example
258
299
  # @return [ProfileULong]
259
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
260
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
261
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
300
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
301
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
302
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
262
303
  def tcp_handshake_timeout
263
304
  super
264
305
  end
265
306
 
266
307
  ##
267
- # Gets the options to block TCP SackOK option from passing to server on an initiating SYN.
308
+ # Gets the options to block TCP SackOK option from passing to server on an initiating
309
+ # SYN.
310
+ # @rspec_example
268
311
  # @return [ProfileEnabledState]
269
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
270
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
271
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
312
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
313
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
314
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
272
315
  def tcp_strip_sackok_state
273
316
  super
274
317
  end
275
318
 
276
319
  ##
277
320
  # Gets the TCP timestamp options for this profile.
321
+ # @rspec_example
278
322
  # @return [ProfileTCPOptionMode]
279
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
280
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
281
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
323
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
324
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
325
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
282
326
  def tcp_timestamp_mode
283
327
  super
284
328
  end
285
329
 
286
330
  ##
287
331
  # Gets the TCP window scale options for this profile.
332
+ # @rspec_example
288
333
  # @return [ProfileTCPOptionMode]
289
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
290
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
291
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
334
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
335
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
336
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
292
337
  def tcp_window_scale_mode
293
338
  super
294
339
  end
295
340
 
296
341
  ##
297
342
  # Gets the version information for this interface.
343
+ # @rspec_example
298
344
  # @return [String]
299
345
  def version
300
346
  super
301
347
  end
302
348
 
303
349
  ##
304
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
350
+ # Determines whether this profile are base/pre-configured profile, or user-defined
351
+ # profile.
352
+ # @rspec_example
305
353
  # @return [boolean]
306
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
307
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
308
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
354
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
355
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
356
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
309
357
  def is_base_profile
310
358
  super
311
359
  end
312
360
 
313
361
  ##
314
362
  # Resets the statistics for this profile.
315
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
316
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
317
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
363
+ # @rspec_example
364
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
365
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
366
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
318
367
  def reset_statistics
319
368
  super
320
369
  end
321
370
 
322
371
  ##
323
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
324
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
325
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
326
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
372
+ # Sets the names of the default profile from which this profile will derive default
373
+ # values for its attributes.
374
+ # @rspec_example
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.
327
378
  # @param [Hash] opts
328
379
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
329
380
  def set_default_profile(opts)
@@ -333,9 +384,10 @@ module IControl::LocalLB
333
384
 
334
385
  ##
335
386
  # Sets the preferred hardware acceleration modes for this profile.
336
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
337
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
338
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
387
+ # @rspec_example
388
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
389
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
390
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
339
391
  # @param [Hash] opts
340
392
  # @option opts [IControl::LocalLB::ProfileHardwareAccelerationMode] :acceleration_modes The preferred hardware acceleration modes for the specified profiles.
341
393
  def set_hardware_acceleration_mode(opts)
@@ -345,9 +397,10 @@ module IControl::LocalLB
345
397
 
346
398
  ##
347
399
  # Sets the state to enable/disable support for hardware SYN cookie.
348
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
349
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
350
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
400
+ # @rspec_example
401
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
402
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
403
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
351
404
  # @param [Hash] opts
352
405
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The enabled/disabled state.
353
406
  def set_hardware_syn_cookie_state(opts)
@@ -356,10 +409,12 @@ module IControl::LocalLB
356
409
  end
357
410
 
358
411
  ##
359
- # Sets the idle timeout for this profile. The number of seconds without traffic before a connection is eligible for deletion.
360
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
361
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
362
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
412
+ # Sets the idle timeout for this profile. The number of seconds without traffic before
413
+ # a connection is eligible for deletion.
414
+ # @rspec_example
415
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
416
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
417
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
363
418
  # @param [Hash] opts
364
419
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeout for the specified profiles.
365
420
  def set_idle_timeout(opts)
@@ -368,10 +423,12 @@ module IControl::LocalLB
368
423
  end
369
424
 
370
425
  ##
371
- # Sets the IP fragment reassembly states for this profile. If true, reassemble the IP fragments.
372
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
373
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
374
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
426
+ # Sets the IP fragment reassembly states for this profile. If true, reassemble the
427
+ # IP fragments.
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.
375
432
  # @param [Hash] opts
376
433
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The IP fragment reassembly states for the specified profiles.
377
434
  def set_ip_fragment_reassemble_state(opts)
@@ -381,9 +438,10 @@ module IControl::LocalLB
381
438
 
382
439
  ##
383
440
  # Sets the IP type of service set in packets sent to the clients.
384
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
385
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
386
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
387
445
  # @param [Hash] opts
388
446
  # @option opts [IControl::LocalLB::ProfileULong] :ip_tos_values The IP type of service set in packets sent to the clients.
389
447
  def set_ip_tos_to_client(opts)
@@ -393,9 +451,10 @@ module IControl::LocalLB
393
451
 
394
452
  ##
395
453
  # Sets the IP type of service set in packets sent to the servers.
396
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
397
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
398
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
399
458
  # @param [Hash] opts
400
459
  # @option opts [IControl::LocalLB::ProfileULong] :ip_tos_values The IP type of service set in packets sent to the servers.
401
460
  def set_ip_tos_to_server(opts)
@@ -404,10 +463,14 @@ module IControl::LocalLB
404
463
  end
405
464
 
406
465
  ##
407
- # Sets the keep-alive probe interval for a set of FastL4 profile. This interval is the elapsed time between sending data over an idle TCP connection to keep the connection open and to determine whether the connection is still valid. If zero, the keep-alive probe is disabled.
408
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
409
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
410
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
466
+ # Sets the keep-alive probe interval for a set of FastL4 profile. This interval is
467
+ # the elapsed time between sending data over an idle TCP connection to keep the connection
468
+ # open and to determine whether the connection is still valid. If zero, the keep-alive
469
+ # probe is disabled.
470
+ # @rspec_example
471
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
472
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
473
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
411
474
  # @param [Hash] opts
412
475
  # @option opts [IControl::LocalLB::ProfileULong] :intervals Keep-alive probe interval (in seconds) for each specified FastL4 profile (default: 0)
413
476
  def set_keep_alive_interval(opts)
@@ -417,9 +480,10 @@ module IControl::LocalLB
417
480
 
418
481
  ##
419
482
  # Sets the link quality of service set in packets sent to the clients.
420
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
421
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
422
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
483
+ # @rspec_example
484
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
485
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
486
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
423
487
  # @param [Hash] opts
424
488
  # @option opts [IControl::LocalLB::ProfileULong] :link_qos_values The link quality of service set in packets sent to the clients.
425
489
  def set_link_qos_to_client(opts)
@@ -429,9 +493,10 @@ module IControl::LocalLB
429
493
 
430
494
  ##
431
495
  # Sets the link quality of service set in packets sent to the servers.
432
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
433
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
434
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
496
+ # @rspec_example
497
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
498
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
499
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
435
500
  # @param [Hash] opts
436
501
  # @option opts [IControl::LocalLB::ProfileULong] :link_qos_values The link quality of service set in packets sent to the servers.
437
502
  def set_link_qos_to_server(opts)
@@ -440,10 +505,12 @@ module IControl::LocalLB
440
505
  end
441
506
 
442
507
  ##
443
- # Sets the state to aggressively close out a connection by allowing TMM to switch the idle_timeout to tcp_close_timeout once the first FIN packet has been seen.
444
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
445
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
446
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
508
+ # Sets the state to aggressively close out a connection by allowing TMM to switch the
509
+ # idle_timeout to tcp_close_timeout once the first FIN packet has been seen.
510
+ # @rspec_example
511
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
512
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
513
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
447
514
  # @param [Hash] opts
448
515
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The loose close state.
449
516
  def set_loose_close_state(opts)
@@ -452,10 +519,12 @@ module IControl::LocalLB
452
519
  end
453
520
 
454
521
  ##
455
- # Sets the state to allow any TCP packet to initiate a connection (rather than requiring a SYN).
456
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
457
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
458
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
522
+ # Sets the state to allow any TCP packet to initiate a connection (rather than requiring
523
+ # a SYN).
524
+ # @rspec_example
525
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
526
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
527
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
459
528
  # @param [Hash] opts
460
529
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The loose initiation state.
461
530
  def set_loose_initiation_state(opts)
@@ -464,10 +533,12 @@ module IControl::LocalLB
464
533
  end
465
534
 
466
535
  ##
467
- # Sets the MSS override values for this profile. If non-zero and less than the default value, this value overrides the maximum segment size.
468
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
469
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
470
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
536
+ # Sets the MSS override values for this profile. If non-zero and less than the default
537
+ # value, this value overrides the maximum segment size.
538
+ # @rspec_example
539
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
540
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
541
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
471
542
  # @param [Hash] opts
472
543
  # @option opts [IControl::LocalLB::ProfileULong] :mss_overrides The MSS override values for the specified profiles.
473
544
  def set_mss_override(opts)
@@ -476,10 +547,12 @@ module IControl::LocalLB
476
547
  end
477
548
 
478
549
  ##
479
- # Sets the reset on timeout states for this profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.
480
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
481
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
482
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
550
+ # Sets the reset on timeout states for this profile. If true and a TCP connection exceeds
551
+ # its idle timeout, send a reset in addition to deleting the connection.
552
+ # @rspec_example
553
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
554
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
555
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
483
556
  # @param [Hash] opts
484
557
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The key reset on timeout states for the specified profiles.
485
558
  def set_reset_on_timeout_state(opts)
@@ -488,10 +561,12 @@ module IControl::LocalLB
488
561
  end
489
562
 
490
563
  ##
491
- # Sets the state to use TCP timestamp options to measure the round trip time to the client.
492
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
493
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
494
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
564
+ # Sets the state to use TCP timestamp options to measure the round trip time to the
565
+ # client.
566
+ # @rspec_example
567
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
568
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
569
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
495
570
  # @param [Hash] opts
496
571
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The state to use TCP timestamp options to measure the round trip time to the client.
497
572
  def set_rtt_from_client_state(opts)
@@ -500,10 +575,12 @@ module IControl::LocalLB
500
575
  end
501
576
 
502
577
  ##
503
- # Sets the state to use TCP timestamp options to measure the round trip time to the server.
504
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
505
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
506
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
578
+ # Sets the state to use TCP timestamp options to measure the round trip time to the
579
+ # server.
580
+ # @rspec_example
581
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
582
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
583
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
507
584
  # @param [Hash] opts
508
585
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The state to use TCP timestamp options to measure the round trip time to the server.
509
586
  def set_rtt_from_server_state(opts)
@@ -513,9 +590,10 @@ module IControl::LocalLB
513
590
 
514
591
  ##
515
592
  # Sets the state to enable/disable support for software SYN cookie.
516
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
517
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
518
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
593
+ # @rspec_example
594
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
595
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
596
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
519
597
  # @param [Hash] opts
520
598
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The enabled/disabled state.
521
599
  def set_software_syn_cookie_state(opts)
@@ -524,10 +602,14 @@ module IControl::LocalLB
524
602
  end
525
603
 
526
604
  ##
527
- # Sets the TCP close timeout for this profile. Only used when &amp;quot;loose_initiation" or &amp;quot;loose_close" is enabled. This is used to rapidly close out a loosely initiated connection after the first FIN packet has been seen (either client or server side).
528
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
529
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
530
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
605
+ # Sets the TCP close timeout for this profile. Only used when &amp;quot;loose_initiation"
606
+ # or &amp;quot;loose_close" is enabled. This is used to rapidly close out a loosely
607
+ # initiated connection after the first FIN packet has been seen (either client or server
608
+ # side).
609
+ # @rspec_example
610
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
611
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
612
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
531
613
  # @param [Hash] opts
532
614
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The TCP close timeout for the specified profiles.
533
615
  def set_tcp_close_timeout(opts)
@@ -537,9 +619,10 @@ module IControl::LocalLB
537
619
 
538
620
  ##
539
621
  # Sets the options to generate our own sequence numbers on all SYNs.
540
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
541
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
542
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
622
+ # @rspec_example
623
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
624
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
625
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
543
626
  # @param [Hash] opts
544
627
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to enable/disable generating our own sequence numbers on all SYNs for the specified profiles.
545
628
  def set_tcp_generate_isn_state(opts)
@@ -548,10 +631,12 @@ module IControl::LocalLB
548
631
  end
549
632
 
550
633
  ##
551
- # Sets the TCP handshake timeout for this profile. The number of seconds without traffic before a connection in the SYN received state is eligible for deletion.
552
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
553
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
554
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
634
+ # Sets the TCP handshake timeout for this profile. The number of seconds without traffic
635
+ # before a connection in the SYN received state is eligible for deletion.
636
+ # @rspec_example
637
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
638
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
639
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
555
640
  # @param [Hash] opts
556
641
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The TCP handshake timeout for the specified profiles.
557
642
  def set_tcp_handshake_timeout(opts)
@@ -560,10 +645,12 @@ module IControl::LocalLB
560
645
  end
561
646
 
562
647
  ##
563
- # Sets the options to block TCP SackOK option from passing to server on an initiating SYN.
564
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
565
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
566
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
648
+ # Sets the options to block TCP SackOK option from passing to server on an initiating
649
+ # SYN.
650
+ # @rspec_example
651
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
652
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
653
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
567
654
  # @param [Hash] opts
568
655
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to block TCP SackOK option from passing to server on an initiating SYN.
569
656
  def set_tcp_strip_sackok_state(opts)
@@ -573,9 +660,10 @@ module IControl::LocalLB
573
660
 
574
661
  ##
575
662
  # Sets the TCP timestamp options for this profile.
576
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
577
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
578
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
663
+ # @rspec_example
664
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
665
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
666
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
579
667
  # @param [Hash] opts
580
668
  # @option opts [IControl::LocalLB::ProfileTCPOptionMode] :modes The TCP timestamp options for the specified profiles.
581
669
  def set_tcp_timestamp_mode(opts)
@@ -585,9 +673,10 @@ module IControl::LocalLB
585
673
 
586
674
  ##
587
675
  # Sets the TCP window scale options for this profile.
588
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
589
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
590
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
676
+ # @rspec_example
677
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
678
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
679
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
591
680
  # @param [Hash] opts
592
681
  # @option opts [IControl::LocalLB::ProfileTCPOptionMode] :modes The TCP window scale options for the specified profiles. Note: mode "rewrite" is invalid for window scale mode, and as of 9.4.2, the method will throw Common::InvalidArgument and do nothing if you use this option in any mode element.
593
682
  def set_tcp_window_scale_mode(opts)
@@ -598,18 +687,18 @@ module IControl::LocalLB
598
687
  ##
599
688
  # A struct that describes statistics for a particular profile.
600
689
  # @attr [String] profile_name The profile name.
601
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
690
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
602
691
  class ProfileFastL4StatisticEntry < IControl::Base::Struct
603
692
  icontrol_attribute :profile_name, String
604
- icontrol_attribute :statistics, IControl::Common::Statistic
693
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
605
694
  end
606
695
 
607
696
  ##
608
697
  # A struct that describes profile statistics and timestamp.
609
- # @attr [IControl::LocalLB::ProfileFastL4::ProfileFastL4StatisticEntry] statistics The statistics for a sequence of profiles.
698
+ # @attr [IControl::LocalLB::ProfileFastL4::ProfileFastL4StatisticEntrySequence] statistics The statistics for a sequence of profiles.
610
699
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
611
700
  class ProfileFastL4Statistics < IControl::Base::Struct
612
- icontrol_attribute :statistics, IControl::LocalLB::ProfileFastL4::ProfileFastL4StatisticEntry
701
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileFastL4::ProfileFastL4StatisticEntrySequence
613
702
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
614
703
  end
615
704