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,299 +1,350 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The ProfileFastHttp interface enables you to manipulate a local load balancer's Fast HTTP profile.
3
+ # The ProfileFastHttp interface enables you to manipulate a local load balancer's Fast
4
+ # HTTP profile.
4
5
  class ProfileFastHttp < IControl::Base
5
6
 
6
7
  set_id_name "profile_names"
7
8
 
8
9
  class ProfileFastHttpStatisticEntry < IControl::Base::Struct; end
9
- class ProfileFastHttpStatistics < IControl::Base::Struct; end ##
10
+ class ProfileFastHttpStatistics < IControl::Base::Struct; end
11
+ class ProfileFastHttpStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
12
  # Creates this Fast HTTP 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 Fast HTTP 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 Fast HTTP 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 Fast HTTP profile.
43
+ # @rspec_example
38
44
  # @return [ProfileFastHttpStatistics]
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 idle timeout override when waiting for the client to close. This occurs after a client FIN is received or after a FIN is sent.
53
+ # Gets the idle timeout override when waiting for the client to close. This occurs
54
+ # after a client FIN is received or after a FIN is sent.
55
+ # @rspec_example
48
56
  # @return [ProfileULong]
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 client_close_timeout
53
61
  super
54
62
  end
55
63
 
56
64
  ##
57
- # Gets the idle timeout override for unspliced serverside flows in the reuse pool. 0 is disabled, i.e. use the default idle timeout.
65
+ # Gets the idle timeout override for unspliced serverside flows in the reuse pool.
66
+ # 0 is disabled, i.e. use the default idle timeout.
67
+ # @rspec_example
58
68
  # @return [ProfileULong]
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.
69
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
70
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
71
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
72
  def connection_pool_idle_timeout
63
73
  super
64
74
  end
65
75
 
66
76
  ##
67
77
  # Gets the maximum number of times a serverside flow will be reused. 0 for unlimited.
78
+ # @rspec_example
68
79
  # @return [ProfileULong]
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.
80
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
81
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
82
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
72
83
  def connection_pool_maximum_reuse
73
84
  super
74
85
  end
75
86
 
76
87
  ##
77
88
  # Gets the maximum number of connections to any given LB pool. 0 for unlimited.
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 connection_pool_maximum_size
83
95
  super
84
96
  end
85
97
 
86
98
  ##
87
99
  # Gets the minimum number of connections to any given LB pool. 0 is an acceptable value.
100
+ # @rspec_example
88
101
  # @return [ProfileULong]
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.
102
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
92
105
  def connection_pool_minimum_size
93
106
  super
94
107
  end
95
108
 
96
109
  ##
97
- # Gets the connection ramp-up increments for this Fast HTTP profile. Must be greater than 0.
110
+ # Gets the connection ramp-up increments for this Fast HTTP profile. Must be greater
111
+ # than 0.
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 connection_pool_ramp_increment
103
118
  super
104
119
  end
105
120
 
106
121
  ##
107
- # Gets the state that specifies whether the connpool should be replenished to its prior number of connections when a connection is closed by the server. If this is disabled, then we will only replenish a closed server side connection residing in the connpool if there are less than connpool_min_size connections in the pool.
122
+ # Gets the state that specifies whether the connpool should be replenished to its prior
123
+ # number of connections when a connection is closed by the server. If this is disabled,
124
+ # then we will only replenish a closed server side connection residing in the connpool
125
+ # if there are less than connpool_min_size connections in the pool.
126
+ # @rspec_example
108
127
  # @return [ProfileEnabledState]
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.
128
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
129
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
130
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
112
131
  def connection_pool_replenish_state
113
132
  super
114
133
  end
115
134
 
116
135
  ##
117
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
136
+ # Gets the names of the default profile from which this profile will derive default
137
+ # values for its attributes.
138
+ # @rspec_example
118
139
  # @return [String]
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.
140
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
141
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
142
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
122
143
  def default_profile
123
144
  super
124
145
  end
125
146
 
126
147
  ##
127
- # Gets the state that if true, rewrite server's HTTP version to 1.0 in status line in order to dissuade the client from pipelining or chunking.
148
+ # Gets the state that if true, rewrite server's HTTP version to 1.0 in status line
149
+ # in order to dissuade the client from pipelining or chunking.
150
+ # @rspec_example
128
151
  # @return [ProfileEnabledState]
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.
152
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
153
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
154
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
132
155
  def force_http10_response_state
133
156
  super
134
157
  end
135
158
 
136
159
  ##
137
160
  # Gets the strings to be inserted as headers for this HTTP profile.
161
+ # @rspec_example
138
162
  # @return [ProfileString]
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.
163
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
164
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
165
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
142
166
  def header_insert
143
167
  super
144
168
  end
145
169
 
146
170
  ##
147
- # Gets the state that if true, work around problems with certain brands of benchmarking software that cannot handle FIN-PUSH on HTTP/1.1 responses.
171
+ # Gets the state that if true, work around problems with certain brands of benchmarking
172
+ # software that cannot handle FIN-PUSH on HTTP/1.1 responses.
173
+ # @rspec_example
148
174
  # @return [ProfileEnabledState]
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.
175
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
176
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
177
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
152
178
  def http11_close_workarounds_state
153
179
  super
154
180
  end
155
181
 
156
182
  ##
157
- # Gets the idle timeout for this Fast HTTP profile. The number of seconds without traffic before a connection is eligible for deletion.
183
+ # Gets the idle timeout for this Fast HTTP profile. The number of seconds without traffic
184
+ # before a connection is eligible for deletion.
185
+ # @rspec_example
158
186
  # @return [ProfileULong]
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.
187
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
188
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
189
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
162
190
  def idle_timeout
163
191
  super
164
192
  end
165
193
 
166
194
  ##
167
195
  # Gets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
196
+ # @rspec_example
168
197
  # @return [ProfileProfileMode]
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.
198
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
199
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
200
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
172
201
  def insert_xforwarded_for_header_mode
173
202
  super
174
203
  end
175
204
 
176
205
  ##
177
- # Gets the state that if false, we will not parse the HTTP requests. This is useful for providing SYN-proxy protection for L4 connections through a SNAT where the client sends data to the server before the server responds.
206
+ # Gets the state that if false, we will not parse the HTTP requests. This is useful
207
+ # for providing SYN-proxy protection for L4 connections through a SNAT where the client
208
+ # sends data to the server before the server responds.
209
+ # @rspec_example
178
210
  # @return [ProfileEnabledState]
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.
211
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
212
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
213
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
182
214
  def layer7_state
183
215
  super
184
216
  end
185
217
 
186
218
  ##
187
219
  # Gets a list of all Fast HTTP profile.
220
+ # @rspec_example
188
221
  # @return [String]
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.
222
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
223
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
224
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
192
225
  def list
193
226
  super
194
227
  end
195
228
 
196
229
  ##
197
- # Gets the maximum amount of data that will be buffered in order to make a content-switching decision.
230
+ # Gets the maximum amount of data that will be buffered in order to make a content-switching
231
+ # decision.
232
+ # @rspec_example
198
233
  # @return [ProfileULong]
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.
234
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
235
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
236
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
202
237
  def maximum_header_size
203
238
  super
204
239
  end
205
240
 
206
241
  ##
207
242
  # Gets the maximum number of requests on a clientside flow before the flow is shutdown.
243
+ # @rspec_example
208
244
  # @return [ProfileULong]
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.
245
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
246
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
247
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
212
248
  def maximum_requests
213
249
  super
214
250
  end
215
251
 
216
252
  ##
217
- # Gets the MSS override values for this profile. If non-zero and less than the default value, this value overrides the maximum segment size for serverside flows.
253
+ # Gets the MSS override values for this profile. If non-zero and less than the default
254
+ # value, this value overrides the maximum segment size for serverside flows.
255
+ # @rspec_example
218
256
  # @return [ProfileULong]
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.
257
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
258
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
259
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
222
260
  def mss_override
223
261
  super
224
262
  end
225
263
 
226
264
  ##
227
- # Gets the reset on timeout states for this Fast HTTP profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.
265
+ # Gets the reset on timeout states for this Fast HTTP profile. If true and a TCP connection
266
+ # exceeds its idle timeout, send a reset in addition to deleting the connection.
267
+ # @rspec_example
228
268
  # @return [ProfileEnabledState]
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.
269
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
270
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
271
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
232
272
  def reset_on_timeout_state
233
273
  super
234
274
  end
235
275
 
236
276
  ##
237
- # Gets the idle timeout override when waiting for the server to close. This occurs if the server flow is not suitable for reuse or after a FIN is received on an unspliced server connection.
277
+ # Gets the idle timeout override when waiting for the server to close. This occurs
278
+ # if the server flow is not suitable for reuse or after a FIN is received on an unspliced
279
+ # server connection.
280
+ # @rspec_example
238
281
  # @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.
282
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
283
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
284
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
242
285
  def server_close_timeout
243
286
  super
244
287
  end
245
288
 
246
289
  ##
247
290
  # Gets the statistics for this Fast HTTP profile.
291
+ # @rspec_example
248
292
  # @return [ProfileFastHttpStatistics]
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.
293
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
294
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
295
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
252
296
  def statistics
253
297
  super
254
298
  end
255
299
 
256
300
  ##
257
301
  # Gets the mode to indicate whether to do unclean shutdown for client connections.
302
+ # @rspec_example
258
303
  # @return [ProfileUncleanShutdownMode]
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.
304
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
305
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
306
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
262
307
  def unclean_shutdown_mode
263
308
  super
264
309
  end
265
310
 
266
311
  ##
267
312
  # Gets the version information for this interface.
313
+ # @rspec_example
268
314
  # @return [String]
269
315
  def version
270
316
  super
271
317
  end
272
318
 
273
319
  ##
274
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
320
+ # Determines whether this profile are base/pre-configured profile, or user-defined
321
+ # profile.
322
+ # @rspec_example
275
323
  # @return [boolean]
276
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
277
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
278
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
324
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
325
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
326
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
279
327
  def is_base_profile
280
328
  super
281
329
  end
282
330
 
283
331
  ##
284
332
  # Resets the statistics for this Fast HTTP profile.
285
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
286
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
287
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
333
+ # @rspec_example
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.
288
337
  def reset_statistics
289
338
  super
290
339
  end
291
340
 
292
341
  ##
293
- # Sets the idle timeout override when waiting for the client to close. This occurs after a client FIN is received or after a FIN is sent.
294
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
295
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
296
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
342
+ # Sets the idle timeout override when waiting for the client to close. This occurs
343
+ # after a client FIN is received or after a FIN is sent.
344
+ # @rspec_example
345
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
346
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
347
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
297
348
  # @param [Hash] opts
298
349
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The client close idle timeouts for the specified Fast HTTP profiles.
299
350
  def set_client_close_timeout(opts)
@@ -302,10 +353,12 @@ module IControl::LocalLB
302
353
  end
303
354
 
304
355
  ##
305
- # Sets the idle timeout override for unspliced serverside flows in the reuse pool. 0 is disabled, i.e. use the default idle timeout.
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.
356
+ # Sets the idle timeout override for unspliced serverside flows in the reuse pool.
357
+ # 0 is disabled, i.e. use the default idle timeout.
358
+ # @rspec_example
359
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
360
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
361
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
309
362
  # @param [Hash] opts
310
363
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeout override for unspliced serverside flows in the reuse pool.
311
364
  def set_connection_pool_idle_timeout(opts)
@@ -315,9 +368,10 @@ module IControl::LocalLB
315
368
 
316
369
  ##
317
370
  # Sets the maximum number of times a serverside flow will be reused. 0 for unlimited.
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.
371
+ # @rspec_example
372
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
373
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
374
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
321
375
  # @param [Hash] opts
322
376
  # @option opts [IControl::LocalLB::ProfileULong] :reuses The maximum number of times a serverside flow will be reused.
323
377
  def set_connection_pool_maximum_reuse(opts)
@@ -327,9 +381,10 @@ module IControl::LocalLB
327
381
 
328
382
  ##
329
383
  # Sets the maximum number of connections to any given LB pool. 0 for unlimited.
330
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
331
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
332
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
384
+ # @rspec_example
385
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
386
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
387
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
333
388
  # @param [Hash] opts
334
389
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The maximum number of connections to any given LB pool.
335
390
  def set_connection_pool_maximum_size(opts)
@@ -339,9 +394,10 @@ module IControl::LocalLB
339
394
 
340
395
  ##
341
396
  # Sets the minimum number of connections to any given LB pool. 0 is an acceptable value.
342
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
343
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
344
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
397
+ # @rspec_example
398
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
399
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
400
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
345
401
  # @param [Hash] opts
346
402
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The minimum number of connections to any given LB pool.
347
403
  def set_connection_pool_minimum_size(opts)
@@ -350,10 +406,12 @@ module IControl::LocalLB
350
406
  end
351
407
 
352
408
  ##
353
- # Sets the connection ramp-up increments for this Fast HTTP profile. Must be greater than 0.
354
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
355
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
356
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
409
+ # Sets the connection ramp-up increments for this Fast HTTP profile. Must be greater
410
+ # than 0.
411
+ # @rspec_example
412
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
413
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
414
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
357
415
  # @param [Hash] opts
358
416
  # @option opts [IControl::LocalLB::ProfileULong] :increments The connection ramp-up increments for the specified Fast HTTP profiles.
359
417
  def set_connection_pool_ramp_increment(opts)
@@ -362,10 +420,14 @@ module IControl::LocalLB
362
420
  end
363
421
 
364
422
  ##
365
- # Sets the state that specifies whether the connpool should be replenished to its prior number of connections when a connection is closed by the server. If this is disabled, then we will only replenish a closed server side connection residing in the connpool if there are less than connpool_min_size connections in the pool.
366
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
367
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
368
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
423
+ # Sets the state that specifies whether the connpool should be replenished to its prior
424
+ # number of connections when a connection is closed by the server. If this is disabled,
425
+ # then we will only replenish a closed server side connection residing in the connpool
426
+ # if there are less than connpool_min_size connections in the pool.
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.
369
431
  # @param [Hash] opts
370
432
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Fast HTTP profiles.
371
433
  def set_connection_pool_replenish_state(opts)
@@ -374,10 +436,12 @@ module IControl::LocalLB
374
436
  end
375
437
 
376
438
  ##
377
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
378
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
379
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
380
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
439
+ # Sets the names of the default profile from which this profile will derive default
440
+ # values for its attributes.
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.
381
445
  # @param [Hash] opts
382
446
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
383
447
  def set_default_profile(opts)
@@ -386,10 +450,12 @@ module IControl::LocalLB
386
450
  end
387
451
 
388
452
  ##
389
- # Sets the state that if true, rewrite server's HTTP version to 1.0 in status line in order to dissuade the client from pipelining or chunking.
390
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
391
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
392
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
453
+ # Sets the state that if true, rewrite server's HTTP version to 1.0 in status line
454
+ # in order to dissuade the client from pipelining or chunking.
455
+ # @rspec_example
456
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
457
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
458
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
393
459
  # @param [Hash] opts
394
460
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Fast HTTP profiles.
395
461
  def set_force_http10_response_state(opts)
@@ -398,10 +464,12 @@ module IControl::LocalLB
398
464
  end
399
465
 
400
466
  ##
401
- # Insert the given string as a header. If the header already exists, it is not replaced. Unlike HTTP, this string does not support rule command expansion.
402
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
403
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
404
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
467
+ # Insert the given string as a header. If the header already exists, it is not replaced.
468
+ # Unlike HTTP, this string does not support rule command expansion.
469
+ # @rspec_example
470
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
471
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
472
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
405
473
  # @param [Hash] opts
406
474
  # @option opts [IControl::LocalLB::ProfileString] :headers The headers to be inserted for the specified Fast HTTP profiles.
407
475
  def set_header_insert(opts)
@@ -410,10 +478,12 @@ module IControl::LocalLB
410
478
  end
411
479
 
412
480
  ##
413
- # Sets the state that if true, work around problems with certain brands of benchmarking software that cannot handle FIN-PUSH on HTTP/1.1 responses.
414
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
415
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
416
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
481
+ # Sets the state that if true, work around problems with certain brands of benchmarking
482
+ # software that cannot handle FIN-PUSH on HTTP/1.1 responses.
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.
417
487
  # @param [Hash] opts
418
488
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Fast HTTP profiles.
419
489
  def set_http11_close_workarounds_state(opts)
@@ -422,10 +492,12 @@ module IControl::LocalLB
422
492
  end
423
493
 
424
494
  ##
425
- # Sets the idle timeout for this Fast HTTP profile. The number of seconds without traffic before a connection is eligible for deletion.
426
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
427
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
428
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
495
+ # Sets the idle timeout for this Fast HTTP profile. The number of seconds without traffic
496
+ # before a connection is eligible for deletion.
497
+ # @rspec_example
498
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
499
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
500
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
429
501
  # @param [Hash] opts
430
502
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeouts for the specified Fast HTTP profiles.
431
503
  def set_idle_timeout(opts)
@@ -435,9 +507,10 @@ module IControl::LocalLB
435
507
 
436
508
  ##
437
509
  # Sets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
438
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
439
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
440
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
441
514
  # @param [Hash] opts
442
515
  # @option opts [IControl::LocalLB::ProfileProfileMode] :modes The insert X-Forwarded-For header mode for the specified profiles.
443
516
  def set_insert_xforwarded_for_header_mode(opts)
@@ -446,10 +519,13 @@ module IControl::LocalLB
446
519
  end
447
520
 
448
521
  ##
449
- # Sets the state that if false, we will not parse the HTTP requests. This is useful for providing SYN-proxy protection for L4 connections through a SNAT where the client sends data to the server before the server responds.
450
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
451
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
452
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
522
+ # Sets the state that if false, we will not parse the HTTP requests. This is useful
523
+ # for providing SYN-proxy protection for L4 connections through a SNAT where the client
524
+ # sends data to the server before the server responds.
525
+ # @rspec_example
526
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
527
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
528
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
453
529
  # @param [Hash] opts
454
530
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Fast HTTP profiles.
455
531
  def set_layer7_state(opts)
@@ -458,10 +534,12 @@ module IControl::LocalLB
458
534
  end
459
535
 
460
536
  ##
461
- # Sets the maximum amount of data that will be buffered in order to make a content-switching decision.
462
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
463
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
464
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
537
+ # Sets the maximum amount of data that will be buffered in order to make a content-switching
538
+ # decision.
539
+ # @rspec_example
540
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
541
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
542
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
465
543
  # @param [Hash] opts
466
544
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The maximum header sizes.
467
545
  def set_maximum_header_size(opts)
@@ -471,9 +549,10 @@ module IControl::LocalLB
471
549
 
472
550
  ##
473
551
  # Sets the maximum number of requests on a clientside flow before the flow is shutdown.
474
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
475
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
476
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
477
556
  # @param [Hash] opts
478
557
  # @option opts [IControl::LocalLB::ProfileULong] :maximum_requests The maximum number of Fast HTTP requests allowed in a connection.
479
558
  def set_maximum_requests(opts)
@@ -482,10 +561,12 @@ module IControl::LocalLB
482
561
  end
483
562
 
484
563
  ##
485
- # Sets the MSS override values for this profile. If non-zero and less than the default value, this value overrides the maximum segment size for serverside flows.
486
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
487
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
488
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
564
+ # Sets the MSS override values for this profile. If non-zero and less than the default
565
+ # value, this value overrides the maximum segment size for serverside flows.
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.
489
570
  # @param [Hash] opts
490
571
  # @option opts [IControl::LocalLB::ProfileULong] :mss_overrides The MSS override values for the specified profiles.
491
572
  def set_mss_override(opts)
@@ -494,10 +575,12 @@ module IControl::LocalLB
494
575
  end
495
576
 
496
577
  ##
497
- # Sets the reset on timeout states for this Fast HTTP profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.
498
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
499
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
500
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
578
+ # Sets the reset on timeout states for this Fast HTTP profile. If true and a TCP connection
579
+ # exceeds its idle timeout, send a reset in addition to deleting the connection.
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.
501
584
  # @param [Hash] opts
502
585
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The reset on timeout states for the specified Fast HTTP profiles.
503
586
  def set_reset_on_timeout_state(opts)
@@ -506,10 +589,13 @@ module IControl::LocalLB
506
589
  end
507
590
 
508
591
  ##
509
- # Sets the idle timeout override when waiting for the server to close. This occurs if the server flow is not suitable for reuse or after a FIN is received on an unspliced server connection.
510
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
511
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
512
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
592
+ # Sets the idle timeout override when waiting for the server to close. This occurs
593
+ # if the server flow is not suitable for reuse or after a FIN is received on an unspliced
594
+ # server connection.
595
+ # @rspec_example
596
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
597
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
598
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
513
599
  # @param [Hash] opts
514
600
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The server close idle timeouts for the specified Fast HTTP profiles.
515
601
  def set_server_close_timeout(opts)
@@ -519,9 +605,10 @@ module IControl::LocalLB
519
605
 
520
606
  ##
521
607
  # Sets the mode to indicate whether to do unclean shutdown for client connections.
522
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
523
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
524
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
608
+ # @rspec_example
609
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
610
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
611
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
525
612
  # @param [Hash] opts
526
613
  # @option opts [IControl::LocalLB::ProfileUncleanShutdownMode] :modes The unclean shutdown mode for the specified profiles.
527
614
  def set_unclean_shutdown_mode(opts)
@@ -532,18 +619,18 @@ module IControl::LocalLB
532
619
  ##
533
620
  # A struct that describes statistics for a particular Fast HTTP profile.
534
621
  # @attr [String] profile_name The profile name.
535
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
622
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
536
623
  class ProfileFastHttpStatisticEntry < IControl::Base::Struct
537
624
  icontrol_attribute :profile_name, String
538
- icontrol_attribute :statistics, IControl::Common::Statistic
625
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
539
626
  end
540
627
 
541
628
  ##
542
629
  # A struct that describes profile statistics and timestamp.
543
- # @attr [IControl::LocalLB::ProfileFastHttp::ProfileFastHttpStatisticEntry] statistics The statistics for a sequence of profiles.
630
+ # @attr [IControl::LocalLB::ProfileFastHttp::ProfileFastHttpStatisticEntrySequence] statistics The statistics for a sequence of profiles.
544
631
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
545
632
  class ProfileFastHttpStatistics < IControl::Base::Struct
546
- icontrol_attribute :statistics, IControl::LocalLB::ProfileFastHttp::ProfileFastHttpStatisticEntry
633
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileFastHttp::ProfileFastHttpStatisticEntrySequence
547
634
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
548
635
  end
549
636