Class: IControl::LocalLB::ProfileFastHttp
- Inherits:
-
Base
- Object
- Base
- IControl::LocalLB::ProfileFastHttp
- Defined in:
- lib/icontrol/local_lb/profile_fast_http.rb,
lib/icontrol/local_lb.rb
Overview
The ProfileFastHttp interface enables you to manipulate a local load balancer's Fast HTTP profile.
Defined Under Namespace
Classes: ProfileFastHttpStatisticEntry, ProfileFastHttpStatisticEntrySequence, ProfileFastHttpStatistics
Instance Method Summary (collapse)
-
- (ProfileFastHttpStatistics) all_statistics
Gets the statistics for all the Fast HTTP profile.
-
- (ProfileULong) client_close_timeout
Gets the idle timeout override when waiting for the client to close.
-
- (ProfileULong) connection_pool_idle_timeout
Gets the idle timeout override for unspliced serverside flows in the reuse pool.
-
- (ProfileULong) connection_pool_maximum_reuse
Gets the maximum number of times a serverside flow will be reused.
-
- (ProfileULong) connection_pool_maximum_size
Gets the maximum number of connections to any given LB pool.
-
- (ProfileULong) connection_pool_minimum_size
Gets the minimum number of connections to any given LB pool.
-
- (ProfileULong) connection_pool_ramp_increment
Gets the connection ramp-up increments for this Fast HTTP profile.
-
- (ProfileEnabledState) connection_pool_replenish_state
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.
-
- (Object) create
Creates this Fast HTTP profile.
-
- (String) default_profile
Gets the names of the default profile from which this profile will derive default values for its attributes.
-
- (Object) delete_all_profiles
Deletes all Fast HTTP profile.
-
- (Object) delete_profile
Deletes this Fast HTTP profile.
-
- (ProfileEnabledState) force_http10_response_state
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.
-
- (ProfileString) header_insert
Gets the strings to be inserted as headers for this HTTP profile.
-
- (ProfileEnabledState) http11_close_workarounds_state
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.
-
- (ProfileULong) idle_timeout
Gets the idle timeout for this Fast HTTP profile.
-
- (ProfileProfileMode) insert_xforwarded_for_header_mode
Gets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
-
- (boolean) is_base_profile
Determines whether this profile are base/pre-configured profile, or user-defined profile.
-
- (ProfileEnabledState) layer7_state
Gets the state that if false, we will not parse the HTTP requests.
-
- (String) list
Gets a list of all Fast HTTP profile.
-
- (ProfileULong) maximum_header_size
Gets the maximum amount of data that will be buffered in order to make a content-switching decision.
-
- (ProfileULong) maximum_requests
Gets the maximum number of requests on a clientside flow before the flow is shutdown.
-
- (ProfileULong) mss_override
Gets the MSS override values for this profile.
-
- (ProfileEnabledState) reset_on_timeout_state
Gets the reset on timeout states for this Fast HTTP profile.
-
- (Object) reset_statistics
Resets the statistics for this Fast HTTP profile.
-
- (ProfileULong) server_close_timeout
Gets the idle timeout override when waiting for the server to close.
-
- (Object) set_client_close_timeout(opts)
Sets the idle timeout override when waiting for the client to close.
-
- (Object) set_connection_pool_idle_timeout(opts)
Sets the idle timeout override for unspliced serverside flows in the reuse pool.
-
- (Object) set_connection_pool_maximum_reuse(opts)
Sets the maximum number of times a serverside flow will be reused.
-
- (Object) set_connection_pool_maximum_size(opts)
Sets the maximum number of connections to any given LB pool.
-
- (Object) set_connection_pool_minimum_size(opts)
Sets the minimum number of connections to any given LB pool.
-
- (Object) set_connection_pool_ramp_increment(opts)
Sets the connection ramp-up increments for this Fast HTTP profile.
-
- (Object) set_connection_pool_replenish_state(opts)
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.
-
- (Object) set_default_profile(opts)
Sets the names of the default profile from which this profile will derive default values for its attributes.
-
- (Object) set_force_http10_response_state(opts)
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.
-
- (Object) set_header_insert(opts)
Insert the given string as a header.
-
- (Object) set_http11_close_workarounds_state(opts)
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.
-
- (Object) set_idle_timeout(opts)
Sets the idle timeout for this Fast HTTP profile.
-
- (Object) set_insert_xforwarded_for_header_mode(opts)
Sets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
-
- (Object) set_layer7_state(opts)
Sets the state that if false, we will not parse the HTTP requests.
-
- (Object) set_maximum_header_size(opts)
Sets the maximum amount of data that will be buffered in order to make a content-switching decision.
-
- (Object) set_maximum_requests(opts)
Sets the maximum number of requests on a clientside flow before the flow is shutdown.
-
- (Object) set_mss_override(opts)
Sets the MSS override values for this profile.
-
- (Object) set_reset_on_timeout_state(opts)
Sets the reset on timeout states for this Fast HTTP profile.
-
- (Object) set_server_close_timeout(opts)
Sets the idle timeout override when waiting for the server to close.
-
- (Object) set_unclean_shutdown_mode(opts)
Sets the mode to indicate whether to do unclean shutdown for client connections.
-
- (ProfileFastHttpStatistics) statistics
Gets the statistics for this Fast HTTP profile.
-
- (ProfileUncleanShutdownMode) unclean_shutdown_mode
Gets the mode to indicate whether to do unclean shutdown for client connections.
-
- (String) version
Gets the version information for this interface.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class IControl::Base
Instance Method Details
- (ProfileFastHttpStatistics) all_statistics
Gets the statistics for all the Fast HTTP profile.
48 49 50 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 48 def all_statistics super end |
- (ProfileULong) client_close_timeout
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.
60 61 62 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 60 def client_close_timeout super end |
- (ProfileULong) connection_pool_idle_timeout
Gets the idle timeout override for unspliced serverside flows in the reuse pool. 0 is disabled, i.e. use the default idle timeout.
72 73 74 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 72 def connection_pool_idle_timeout super end |
- (ProfileULong) connection_pool_maximum_reuse
Gets the maximum number of times a serverside flow will be reused. 0 for unlimited.
83 84 85 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 83 def connection_pool_maximum_reuse super end |
- (ProfileULong) connection_pool_maximum_size
Gets the maximum number of connections to any given LB pool. 0 for unlimited.
94 95 96 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 94 def connection_pool_maximum_size super end |
- (ProfileULong) connection_pool_minimum_size
Gets the minimum number of connections to any given LB pool. 0 is an acceptable value.
105 106 107 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 105 def connection_pool_minimum_size super end |
- (ProfileULong) connection_pool_ramp_increment
Gets the connection ramp-up increments for this Fast HTTP profile. Must be greater than 0.
117 118 119 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 117 def connection_pool_ramp_increment super end |
- (ProfileEnabledState) connection_pool_replenish_state
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.
131 132 133 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 131 def connection_pool_replenish_state super end |
- (Object) create
Creates this Fast HTTP profile.
17 18 19 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 17 def create super end |
- (String) default_profile
Gets the names of the default profile from which this profile will derive default values for its attributes.
143 144 145 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 143 def default_profile super end |
- (Object) delete_all_profiles
Deletes all Fast HTTP profile.
27 28 29 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 27 def delete_all_profiles super end |
- (Object) delete_profile
Deletes this Fast HTTP profile.
37 38 39 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 37 def delete_profile super end |
- (ProfileEnabledState) force_http10_response_state
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.
155 156 157 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 155 def force_http10_response_state super end |
- (ProfileString) header_insert
Gets the strings to be inserted as headers for this HTTP profile.
166 167 168 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 166 def header_insert super end |
- (ProfileEnabledState) http11_close_workarounds_state
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.
178 179 180 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 178 def http11_close_workarounds_state super end |
- (ProfileULong) idle_timeout
Gets the idle timeout for this Fast HTTP profile. The number of seconds without traffic before a connection is eligible for deletion.
190 191 192 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 190 def idle_timeout super end |
- (ProfileProfileMode) insert_xforwarded_for_header_mode
Gets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
201 202 203 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 201 def insert_xforwarded_for_header_mode super end |
- (boolean) is_base_profile
Determines whether this profile are base/pre-configured profile, or user-defined profile.
327 328 329 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 327 def is_base_profile super end |
- (ProfileEnabledState) layer7_state
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.
214 215 216 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 214 def layer7_state super end |
- (String) list
Gets a list of all Fast HTTP profile.
225 226 227 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 225 def list super end |
- (ProfileULong) maximum_header_size
Gets the maximum amount of data that will be buffered in order to make a content-switching decision.
237 238 239 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 237 def maximum_header_size super end |
- (ProfileULong) maximum_requests
Gets the maximum number of requests on a clientside flow before the flow is shutdown.
248 249 250 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 248 def maximum_requests super end |
- (ProfileULong) mss_override
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.
260 261 262 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 260 def mss_override super end |
- (ProfileEnabledState) reset_on_timeout_state
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.
272 273 274 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 272 def reset_on_timeout_state super end |
- (Object) reset_statistics
Resets the statistics for this Fast HTTP profile.
337 338 339 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 337 def reset_statistics super end |
- (ProfileULong) server_close_timeout
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.
285 286 287 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 285 def server_close_timeout super end |
- (Object) set_client_close_timeout(opts)
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.
350 351 352 353 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 350 def set_client_close_timeout(opts) check_params(opts,[:timeouts]) super end |
- (Object) set_connection_pool_idle_timeout(opts)
Sets the idle timeout override for unspliced serverside flows in the reuse pool. 0 is disabled, i.e. use the default idle timeout.
364 365 366 367 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 364 def set_connection_pool_idle_timeout(opts) check_params(opts,[:timeouts]) super end |
- (Object) set_connection_pool_maximum_reuse(opts)
Sets the maximum number of times a serverside flow will be reused. 0 for unlimited.
377 378 379 380 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 377 def set_connection_pool_maximum_reuse(opts) check_params(opts,[:reuses]) super end |
- (Object) set_connection_pool_maximum_size(opts)
Sets the maximum number of connections to any given LB pool. 0 for unlimited.
390 391 392 393 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 390 def set_connection_pool_maximum_size(opts) check_params(opts,[:sizes]) super end |
- (Object) set_connection_pool_minimum_size(opts)
Sets the minimum number of connections to any given LB pool. 0 is an acceptable value.
403 404 405 406 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 403 def set_connection_pool_minimum_size(opts) check_params(opts,[:sizes]) super end |
- (Object) set_connection_pool_ramp_increment(opts)
Sets the connection ramp-up increments for this Fast HTTP profile. Must be greater than 0.
417 418 419 420 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 417 def set_connection_pool_ramp_increment(opts) check_params(opts,[:increments]) super end |
- (Object) set_connection_pool_replenish_state(opts)
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.
433 434 435 436 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 433 def set_connection_pool_replenish_state(opts) check_params(opts,[:states]) super end |
- (Object) set_default_profile(opts)
Sets the names of the default profile from which this profile will derive default values for its attributes.
447 448 449 450 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 447 def set_default_profile(opts) check_params(opts,[:defaults]) super end |
- (Object) set_force_http10_response_state(opts)
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.
461 462 463 464 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 461 def set_force_http10_response_state(opts) check_params(opts,[:states]) super end |
- (Object) set_header_insert(opts)
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.
475 476 477 478 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 475 def set_header_insert(opts) check_params(opts,[:headers]) super end |
- (Object) set_http11_close_workarounds_state(opts)
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.
489 490 491 492 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 489 def set_http11_close_workarounds_state(opts) check_params(opts,[:states]) super end |
- (Object) set_idle_timeout(opts)
Sets the idle timeout for this Fast HTTP profile. The number of seconds without traffic before a connection is eligible for deletion.
503 504 505 506 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 503 def set_idle_timeout(opts) check_params(opts,[:timeouts]) super end |
- (Object) set_insert_xforwarded_for_header_mode(opts)
Sets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
516 517 518 519 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 516 def set_insert_xforwarded_for_header_mode(opts) check_params(opts,[:modes]) super end |
- (Object) set_layer7_state(opts)
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.
531 532 533 534 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 531 def set_layer7_state(opts) check_params(opts,[:states]) super end |
- (Object) set_maximum_header_size(opts)
Sets the maximum amount of data that will be buffered in order to make a content-switching decision.
545 546 547 548 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 545 def set_maximum_header_size(opts) check_params(opts,[:sizes]) super end |
- (Object) set_maximum_requests(opts)
Sets the maximum number of requests on a clientside flow before the flow is shutdown.
558 559 560 561 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 558 def set_maximum_requests(opts) check_params(opts,[:maximum_requests]) super end |
- (Object) set_mss_override(opts)
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.
572 573 574 575 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 572 def set_mss_override(opts) check_params(opts,[:mss_overrides]) super end |
- (Object) set_reset_on_timeout_state(opts)
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.
586 587 588 589 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 586 def set_reset_on_timeout_state(opts) check_params(opts,[:states]) super end |
- (Object) set_server_close_timeout(opts)
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.
601 602 603 604 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 601 def set_server_close_timeout(opts) check_params(opts,[:timeouts]) super end |
- (Object) set_unclean_shutdown_mode(opts)
Sets the mode to indicate whether to do unclean shutdown for client connections.
614 615 616 617 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 614 def set_unclean_shutdown_mode(opts) check_params(opts,[:modes]) super end |
- (ProfileFastHttpStatistics) statistics
Gets the statistics for this Fast HTTP profile.
296 297 298 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 296 def statistics super end |
- (ProfileUncleanShutdownMode) unclean_shutdown_mode
Gets the mode to indicate whether to do unclean shutdown for client connections.
307 308 309 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 307 def unclean_shutdown_mode super end |
- (String) version
Gets the version information for this interface.
315 316 317 |
# File 'lib/icontrol/local_lb/profile_fast_http.rb', line 315 def version super end |