Class: IControl::LocalLB::ProfileHttp

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/local_lb/profile_http.rb,
lib/icontrol/local_lb.rb

Overview

The ProfileHttp interface enables you to manipulate a local load balancer’s HTTP profile.

Defined Under Namespace

Classes: ProfileHttpStatisticEntry, ProfileHttpStatisticEntrySequence, ProfileHttpStatistics

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#add_compression_content_type_exclude(opts) ⇒ Object

Adds to the lists of regular expressions used to match the MIME types in the server response’s "Content-Type:“ headers. No match may be found in any of the "exclude” fields. For example, to disable compression on all PDF and image files, one would use the following in the content_type exclue fields: : "application/pdf“ "image/*”.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be added to the “exclude” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



23
24
25
26
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 23

def add_compression_content_type_exclude(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#add_compression_content_type_include(opts) ⇒ Object

Adds to the lists of regular expressions used to match the MIME types in the server response’s "Content-Type:“ headers. A match must be found in at least one of the "include” fields. For example, to enable compression on all PDF and image files, one would use the following in the content_type include fields: : "application/pdf“ "image/*”.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be added to the “include” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



40
41
42
43
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 40

def add_compression_content_type_include(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#add_compression_uri_exclude(opts) ⇒ Object

Adds to the lists of regular expressions used to match the request URI part of the client requests during compression. (see section 5.1 of RFC2616). No match may be found in any of the "exclude“ fields. For example, to disable compressing requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the URI "exclude“ fields: "*.txt” "*.htm“ "*.html”

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be added to the “exclude” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



58
59
60
61
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 58

def add_compression_uri_exclude(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#add_compression_uri_include(opts) ⇒ Object

Adds to the lists of regular expressions used to match the request URI part of the client requests during compression. (see section 5.1 of RFC2616). A match must be found in at least one of the "include“ fields. For example, to include requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the uri include field: "*.txt“ "*.htm” "*.html“.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be added to the “include” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



75
76
77
78
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 75

def add_compression_uri_include(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#add_cookie_encryption(opts) ⇒ Object

Adds to the lists of cookies to be encrypted before sending them to the clients.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cookies (String[]) —

    The lists of cookies to be encrypted.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



88
89
90
91
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 88

def add_cookie_encryption(opts)
  opts = check_params(opts,[:cookies])
  super(opts)
end

#add_fallback_status_code(opts) ⇒ Object

Adds to the lists of status codes that when matched, traffic will be sent to the "fallback_host“. An exception will be thrown if fallback status codes are set when "fallback_host” has not been specified.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :status_codes (String[]) —

    The lists of status codes.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



103
104
105
106
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 103

def add_fallback_status_code(opts)
  opts = check_params(opts,[:status_codes])
  super(opts)
end

#add_permitted_response_header(opts) ⇒ Object

Adds to the lists of permitted headers in the responses for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :headers (String[]) —

    The lists of permitted response headers.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



116
117
118
119
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 116

def add_permitted_response_header(opts)
  opts = check_params(opts,[:headers])
  super(opts)
end

#add_ramcache_uri_exclude(opts) ⇒ Object

Adds to the lists of regular expressions used to match the request URI part of the client requests during caching. (see section 5.1 of RFC2616). No match may be found in any of the "exclude“ fields. For example, to disable compressing requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the URI "exclude“ fields: "*.txt” "*.htm“ "*.html”

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be added to the “exclude” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



134
135
136
137
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 134

def add_ramcache_uri_exclude(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#add_ramcache_uri_include(opts) ⇒ Object

Adds to the lists of regular expressions used to match the request URI part of the client requests during caching. (see section 5.1 of RFC2616). A match must be found in at least one of the "include“ fields. For example, to include requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the uri include field: "*.txt“ "*.htm” "*.html“.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be added to the “include” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



151
152
153
154
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 151

def add_ramcache_uri_include(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#add_ramcache_uri_pinned(opts) ⇒ Object

Adds to the lists of cachable document URIs that will never be evicted from the cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be added to the “pinned” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



164
165
166
167
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 164

def add_ramcache_uri_pinned(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#all_statistics ⇒ ProfileHttpStatistics

Gets the statistics for all the HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



206
207
208
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 206

def all_statistics
  super
end

#basic_auth_realm ⇒ ProfileString

Gets the basic authentication realms for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



217
218
219
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 217

def basic_auth_realm
  super
end

#compression_allow_http_10_state ⇒ ProfileEnabledState

Gets the states that specify whether we will allow compression on responses to HTTP 1.0 requests. Default will be "false“, i.e. disallowing compression on HTTP 1.0 responses.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



230
231
232
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 230

def compression_allow_http_10_state
  super
end

#compression_browser_workaround_state ⇒ ProfileEnabledState

Gets the states that specify whether to workaround browser bugs when doing compression.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



241
242
243
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 241

def compression_browser_workaround_state
  super
end

#compression_buffer_size ⇒ ProfileULong

Gets the values that specify the maximum number of uncompressed bytes that the compression proxy will buffer before it decides whether or not to compress the server’s response, in case the server’s response headers don’t specify the content length of the response.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



254
255
256
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 254

def compression_buffer_size
  super
end

#compression_content_type_exclude ⇒ ProfileStringArray

Gets the lists of regular expressions used to match the MIME types in the server response’s "Content-Type:“ headers. No match may be found in any of the "exclude” fields. For example, to disable compression on all PDF and image files, one would use the following in the content_type exclue fields: : "application/pdf“ "image/*”.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



269
270
271
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 269

def compression_content_type_exclude
  super
end

#compression_content_type_include ⇒ ProfileStringArray

Gets the lists of regular expressions used to match the MIME types in the server response’s "Content-Type:“ headers. A match must be found in at least one of the "include” fields. For example, to enable compression on all PDF and image files, one would use the following in the content_type include fields: : "application/pdf“ "image/*”.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



284
285
286
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 284

def compression_content_type_include
  super
end

#compression_cpu_saver_high_threshold ⇒ ProfileULong

Gets the CPU saver high threshold that basically switches to NULL compression when CPU utilization exceeds this value.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



296
297
298
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 296

def compression_cpu_saver_high_threshold
  super
end

#compression_cpu_saver_low_threshold ⇒ ProfileULong

Gets the CPU saver low threshold that basically enables full throttle on compression when CPU utilization drops below this value.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



308
309
310
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 308

def compression_cpu_saver_low_threshold
  super
end

#compression_cpu_saver_state ⇒ ProfileEnabledState

Gets the states that specify whether to enable CPU saving mode when doing compression.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



319
320
321
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 319

def compression_cpu_saver_state
  super
end

#compression_level ⇒ ProfileULong

Gets the compression level used by this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



330
331
332
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 330

def compression_level
  super
end

#compression_memory_level ⇒ ProfileULong

Gets the amount of memory (in bytes) that the will be used for the internal compression state for each compressed response. Smaller values will be slower and will produce smaller compression ratios, whereas larger values will be faster and produce larger compression ratios. The value must be one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K, 256K and represent power-of-2 values (kilobytes). The default value will be 8K.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



345
346
347
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 345

def compression_memory_level
  super
end

#compression_minimum_size ⇒ ProfileULong

Gets the values that specify the minimmum length of the server responses (in bytes) to be considered acceptable for compression.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



357
358
359
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 357

def compression_minimum_size
  super
end

#compression_mode ⇒ ProfileHttpCompressionMode

Gets the HTTP compression modes for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



368
369
370
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 368

def compression_mode
  super
end

#compression_uri_exclude ⇒ ProfileStringArray

Gets the lists of regular expressions used to match the request URI part of the client requests during compression. (see section 5.1 of RFC2616). No match may be found in any of the "exclude“ fields. For example, to disable compressing requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the URI "exclude“ fields: "*.txt” "*.htm“ "*.html”

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



384
385
386
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 384

def compression_uri_exclude
  super
end

#compression_uri_include ⇒ ProfileStringArray

Gets the lists of regular expressions used to match the request URI part of the client requests during compression. (see section 5.1 of RFC2616). A match must be found in at least one of the "include“ fields. For example, to include requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the uri include field: "*.txt“ "*.htm” "*.html“.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



399
400
401
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 399

def compression_uri_include
  super
end

#compression_vary_header_state ⇒ ProfileEnabledState

Gets the states that specify whether we will insert the header "Vary: Accept-Encoding“ in the server response for responses that have been compressed. If the "Vary:” header already exists in the server response, then the value "Accept-Encoding“ will be appended to it.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



413
414
415
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 413

def compression_vary_header_state
  super
end

#compression_window_size ⇒ ProfileULong

Gets the amount of memory (in bytes) for the window size (the compression history buffer) that will be used when compressing the server response. Higher values produce better compression ratios at the expense of more memory usage. The value must be one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K and represent power-of-2 values (kilobytes). The default value will be 16K.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



428
429
430
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 428

def compression_window_size
  super
end

#cookie_encryption ⇒ ProfileStringArray

Gets the lists of cookies to be encrypted before sending them to the clients.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



439
440
441
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 439

def cookie_encryption
  super
end

#cookie_encryption_passphrase ⇒ ProfileString

Gets the passphrases used to encrypt the cookies for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



450
451
452
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 450

def cookie_encryption_passphrase
  super
end

#create ⇒ Object

Creates this HTTP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



175
176
177
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 175

def create
  super
end

#default_profile ⇒ String

Gets the names of the default profile from which this profile will derive default values for its attributes.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



462
463
464
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 462

def default_profile
  super
end

#delete_all_profiles ⇒ Object

Deletes all HTTP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



185
186
187
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 185

def delete_all_profiles
  super
end

#delete_profile ⇒ Object

Deletes this HTTP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



195
196
197
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 195

def delete_profile
  super
end

#fallback_host_name ⇒ ProfileString

Gets the fallback host names used in HTTP redirect for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



473
474
475
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 473

def fallback_host_name
  super
end

#fallback_status_code ⇒ ProfileStringArray

Gets the lists of status codes that when matched, traffic will be sent to the "fallback_host“. An exception will be thrown if fallback status codes are set when "fallback_host” has not been specified.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



486
487
488
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 486

def fallback_status_code
  super
end

#header_erase ⇒ ProfileString

Gets the headers to be erased for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



497
498
499
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 497

def header_erase
  super
end

#header_insert ⇒ ProfileString

Gets the headers to be inserted for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



508
509
510
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 508

def header_insert
  super
end

#insert_xforwarded_for_header_mode ⇒ ProfileProfileMode

Gets the mode to indicate whether to insert X-Forwarded-For headers for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



519
520
521
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 519

def insert_xforwarded_for_header_mode
  super
end

#is_base_profile ⇒ boolean

Determines whether this profile are base/pre-configured profile, or user-defined profile.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



841
842
843
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 841

def is_base_profile
  super
end

#keep_accept_encoding_header_state ⇒ ProfileEnabledState

Gets the states that specify how we handle the "Accept-Encoding:“ header. If set to false, we will strip the "Accept-Encoding:” header before passing the request on to the server (so that the server doesn’t also compress the response). If it is set to true, we will leave the "Accept-Encoding:“ header in the request so that servers are able to do compression. We will not compress responses that have already been compressed.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



535
536
537
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 535

def keep_accept_encoding_header_state
  super
end

#list ⇒ String

Gets a list of all HTTP profile.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



546
547
548
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 546

def list
  super
end

#lws_maximum_column ⇒ ProfileULong

Gets the linear white space maximum column sizes used to support multi-line header insertion.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



558
559
560
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 558

def lws_maximum_column
  super
end

#lws_separator ⇒ ProfileString

Gets the linear white space separator strings for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



569
570
571
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 569

def lws_separator
  super
end

#maximum_header_size ⇒ ProfileULong

Gets the maximum header sizes for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



580
581
582
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 580

def maximum_header_size
  super
end

#maximum_requests ⇒ ProfileULong

Gets the maximum number of HTTP requests allowed in the connection before it is closed automatically.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



592
593
594
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 592

def maximum_requests
  super
end

#oneconnect_header_transformation_state ⇒ ProfileEnabledState

Gets the states that specify that OneConnect HTTP header transformation feature is used or not.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



604
605
606
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 604

def oneconnect_header_transformation_state
  super
end

#permitted_response_header ⇒ ProfileStringArray

Gets the lists of permitted headers in the responses for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



615
616
617
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 615

def permitted_response_header
  super
end

#pipelining_mode ⇒ ProfileProfileMode

Gets the pipelining mode for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



626
627
628
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 626

def pipelining_mode
  super
end

#preferred_compression_method ⇒ ProfileCompressionMethod

Gets the preferred compression methods.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



637
638
639
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 637

def preferred_compression_method
  super
end

#ramcache_aging_rate ⇒ ProfileULong

Gets the aging rate for the RAM cache.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



648
649
650
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 648

def ramcache_aging_rate
  super
end

#ramcache_ignore_client_cache_control_mode ⇒ ProfileRamCacheCacheControlMode

Gets the mode to indicate whether to ignore the client cache control headers.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



659
660
661
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 659

def ramcache_ignore_client_cache_control_mode
  super
end

#ramcache_insert_age_header_mode ⇒ ProfileProfileMode

Gets the mode that indicates whether to insert the Age headers for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



670
671
672
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 670

def ramcache_insert_age_header_mode
  super
end

#ramcache_maximum_age ⇒ ProfileULong

Gets the maximum age of a cached object in the RAM cache.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



681
682
683
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 681

def ramcache_maximum_age
  super
end

#ramcache_maximum_entry ⇒ ProfileULong

Gets the maximum number of cache entries allowed in the RAM cache.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



692
693
694
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 692

def ramcache_maximum_entry
  super
end

#ramcache_mode ⇒ ProfileProfileMode

Gets the RAM cache mode for this profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



703
704
705
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 703

def ramcache_mode
  super
end

#ramcache_object_maximum_size ⇒ ProfileULong

Gets the maximum size requirement of a cached object in the RAM cache.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



714
715
716
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 714

def ramcache_object_maximum_size
  super
end

#ramcache_object_minimum_size ⇒ ProfileULong

Gets the minimum size requirement of a cached object in the RAM cache.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



725
726
727
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 725

def ramcache_object_minimum_size
  super
end

#ramcache_size ⇒ ProfileULong

Gets the size (MB) of the RAM cache.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



736
737
738
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 736

def ramcache_size
  super
end

#ramcache_uri_exclude ⇒ ProfileStringArray

Gets the lists of regular expressions used to match the request URI part of the client requests during caching. (see section 5.1 of RFC2616). No match may be found in any of the "exclude“ fields. For example, to disable compressing requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the URI "exclude“ fields: "*.txt” "*.htm“ "*.html”

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



751
752
753
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 751

def ramcache_uri_exclude
  super
end

#ramcache_uri_include ⇒ ProfileStringArray

Gets the lists of regular expressions used to match the request URI part of the client requests during caching. (see section 5.1 of RFC2616). A match must be found in at least one of the "include“ fields. For example, to include requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the uri include field: "*.txt“ "*.htm” "*.html“.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



766
767
768
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 766

def ramcache_uri_include
  super
end

#ramcache_uri_pinned ⇒ ProfileStringArray

Gets the lists of cachable document URIs that will never be evicted from the cache.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



777
778
779
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 777

def ramcache_uri_pinned
  super
end

#redirect_rewrite_mode ⇒ ProfileHttpRedirectRewriteMode

Gets the HTTP redirect/rewrite mode for the responses.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



788
789
790
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 788

def redirect_rewrite_mode
  super
end

#remove_compression_content_type_exclude(opts) ⇒ Object

Removes from the lists of regular expressions used to match the MIME types in the server response’s "Content-Type:“ headers. No match may be found in any of the "exclude” fields. For example, to disable compression on all PDF and image files, one would use the following in the content_type exclue fields: : "application/pdf“ "image/*”.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be removed from the “exclude” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



857
858
859
860
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 857

def remove_compression_content_type_exclude(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#remove_compression_content_type_include(opts) ⇒ Object

Removes from the lists of regular expressions used to match the MIME types in the server response’s "Content-Type:“ headers. A match must be found in at least one of the "include” fields. For example, to enable compression on all PDF and image files, one would use the following in the content_type include fields: : "application/pdf“ "image/*”.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be removed from the “include” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



874
875
876
877
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 874

def remove_compression_content_type_include(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#remove_compression_uri_exclude(opts) ⇒ Object

Removes from the lists of regular expressions used to match the request URI part of the client requests during compression. (see section 5.1 of RFC2616). No match may be found in any of the "exclude“ fields. For example, to disable compressing requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the URI "exclude“ fields: "*.txt” "*.htm“ "*.html”

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be removed from the “exclude” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



892
893
894
895
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 892

def remove_compression_uri_exclude(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#remove_compression_uri_include(opts) ⇒ Object

Removes from the lists of regular expressions used to match the request URI part of the client requests during compression. (see section 5.1 of RFC2616). A match must be found in at least one of the "include“ fields. For example, to include requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the uri include field: "*.txt“ "*.htm” "*.html“.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be removed from the “include” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



909
910
911
912
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 909

def remove_compression_uri_include(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#remove_cookie_encryption(opts) ⇒ Object

Removes from the lists of cookies to be encrypted before sending them to the clients.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cookies (String[]) —

    The lists of cookies to be encrypted.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



922
923
924
925
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 922

def remove_cookie_encryption(opts)
  opts = check_params(opts,[:cookies])
  super(opts)
end

#remove_fallback_status_code(opts) ⇒ Object

Removes from the lists of status codes that when matched, traffic will be sent to the "fallback_host“. An exception will be thrown if fallback status codes are set when "fallback_host” has not been specified.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :status_codes (String[]) —

    The lists of status codes.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



937
938
939
940
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 937

def remove_fallback_status_code(opts)
  opts = check_params(opts,[:status_codes])
  super(opts)
end

#remove_permitted_response_header(opts) ⇒ Object

Removes from the lists of permitted headers in the responses for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :headers (String[]) —

    The lists of permitted response headers.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



950
951
952
953
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 950

def remove_permitted_response_header(opts)
  opts = check_params(opts,[:headers])
  super(opts)
end

#remove_ramcache_uri_exclude(opts) ⇒ Object

Removes from the lists of regular expressions used to match the request URI part of the client requests during caching. (see section 5.1 of RFC2616). No match may be found in any of the "exclude“ fields. For example, to disable compressing requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the URI "exclude“ fields: "*.txt” "*.htm“ "*.html”

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be removed from the “exclude” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



968
969
970
971
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 968

def remove_ramcache_uri_exclude(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#remove_ramcache_uri_include(opts) ⇒ Object

Removes from the lists of regular expressions used to match the request URI part of the client requests during caching. (see section 5.1 of RFC2616). A match must be found in at least one of the "include“ fields. For example, to include requests ending in ".txt”, ".htm“ and ".html”, one would use the following in the uri include field: "*.txt“ "*.htm” "*.html“.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be removed from the “include” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



985
986
987
988
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 985

def remove_ramcache_uri_include(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#remove_ramcache_uri_pinned(opts) ⇒ Object

Removes from the lists of cachable document URIs that will never be evicted from the cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :reg_expressions (String[]) —

    The lists of regular expressions to be removed from the “pinned” list.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



999
1000
1001
1002
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 999

def remove_ramcache_uri_pinned(opts)
  opts = check_params(opts,[:reg_expressions])
  super(opts)
end

#reset_statistics ⇒ Object

Resets the statistics for this HTTP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1010
1011
1012
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1010

def reset_statistics
  super
end

#response_chunk_mode ⇒ ProfileHttpChunkMode

Gets the HTTP chunk mode for the responses.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



799
800
801
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 799

def response_chunk_mode
  super
end

#security_enabled_request_state ⇒ ProfileEnabledState

Gets the state that if true, enable horizontal security for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



810
811
812
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 810

def security_enabled_request_state
  super
end

#set_basic_auth_realm(opts) ⇒ Object

Sets the basic authentication realms for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1022
1023
1024
1025
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1022

def set_basic_auth_realm(opts)
  opts = check_params(opts,[:realms])
  super(opts)
end

#set_compression_allow_http_10_state(opts) ⇒ Object

Sets the states that specify whether we will allow compression on responses to HTTP 1.0 requests. Default will be "false“, i.e. disallowing compression on HTTP 1.0 responses.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1037
1038
1039
1040
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1037

def set_compression_allow_http_10_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_compression_browser_workaround_state(opts) ⇒ Object

Sets the states that specify whether to workaround browser bugs when doing compression.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1050
1051
1052
1053
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1050

def set_compression_browser_workaround_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_compression_buffer_size(opts) ⇒ Object

Sets the values that specify the maximum number of uncompressed bytes that the compression proxy will buffer before it decides whether or not to compress the server’s response, in case the server’s response headers don’t specify the content length of the response.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1065
1066
1067
1068
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1065

def set_compression_buffer_size(opts)
  opts = check_params(opts,[:sizes])
  super(opts)
end

#set_compression_cpu_saver_high_threshold(opts) ⇒ Object

Sets the CPU saver high threshold that basically switches to NULL compression when CPU utilization exceeds this value.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1079
1080
1081
1082
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1079

def set_compression_cpu_saver_high_threshold(opts)
  opts = check_params(opts,[:thresholds])
  super(opts)
end

#set_compression_cpu_saver_low_threshold(opts) ⇒ Object

Sets the CPU saver low threshold that basically enables full throttle on compression when CPU utilization drops below this value.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1093
1094
1095
1096
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1093

def set_compression_cpu_saver_low_threshold(opts)
  opts = check_params(opts,[:thresholds])
  super(opts)
end

#set_compression_cpu_saver_state(opts) ⇒ Object

Sets the states that specify whether to enable CPU saving mode when doing compression.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1106
1107
1108
1109
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1106

def set_compression_cpu_saver_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_compression_level(opts) ⇒ Object

Sets the compression level used by this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1119
1120
1121
1122
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1119

def set_compression_level(opts)
  opts = check_params(opts,[:levels])
  super(opts)
end

#set_compression_memory_level(opts) ⇒ Object

Sets the amount of memory (in bytes) that the will be used for the internal compression state for each compressed response. Smaller values will be slower and will produce smaller compression ratios, whereas larger values will be faster and produce larger compression ratios. The value must be one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K, 256K and represent power-of-2 values (kilobytes). The default value will be 8K.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1136
1137
1138
1139
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1136

def set_compression_memory_level(opts)
  opts = check_params(opts,[:levels])
  super(opts)
end

#set_compression_minimum_size(opts) ⇒ Object

Sets the values that specify the minimmum length of the server responses (in bytes) to be considered acceptable for compression.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1150
1151
1152
1153
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1150

def set_compression_minimum_size(opts)
  opts = check_params(opts,[:sizes])
  super(opts)
end

#set_compression_mode(opts) ⇒ Object

Sets the HTTP compression modes for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1163
1164
1165
1166
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1163

def set_compression_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_compression_vary_header_state(opts) ⇒ Object

Sets the states that specify whether we will insert the header "Vary: Accept-Encoding“ in the server response for responses that have been compressed. If the "Vary:” header already exists in the server response, then the value "Accept-Encoding“ will be appended to it.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1179
1180
1181
1182
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1179

def set_compression_vary_header_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_compression_window_size(opts) ⇒ Object

Sets the amount of memory (in bytes) for the window size (the compression history buffer) that will be used when compressing the server response. Higher values produce better compression ratios at the expense of more memory usage. The value must be one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K and represent power-of-2 values (kilobytes). The default value will be 16K.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1196
1197
1198
1199
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1196

def set_compression_window_size(opts)
  opts = check_params(opts,[:sizes])
  super(opts)
end

#set_cookie_encryption_passphrase(opts) ⇒ Object

Sets the passphrases used to encrypt the cookies for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1209
1210
1211
1212
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1209

def set_cookie_encryption_passphrase(opts)
  opts = check_params(opts,[:passphrases])
  super(opts)
end

#set_default_compression_content_type_exclude ⇒ Object

Resets the lists to parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1220
1221
1222
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1220

def set_default_compression_content_type_exclude
  super
end

#set_default_compression_content_type_include ⇒ Object

Resets the lists to parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1230
1231
1232
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1230

def set_default_compression_content_type_include
  super
end

#set_default_compression_uri_exclude ⇒ Object

Resets the lists to parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1240
1241
1242
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1240

def set_default_compression_uri_exclude
  super
end

#set_default_compression_uri_include ⇒ Object

Resets the list to the parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1250
1251
1252
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1250

def set_default_compression_uri_include
  super
end

#set_default_cookie_encryption ⇒ Object

Resets the list to the parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1260
1261
1262
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1260

def set_default_cookie_encryption
  super
end

#set_default_fallback_status_code ⇒ Object

Resets the list to the parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1270
1271
1272
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1270

def set_default_fallback_status_code
  super
end

#set_default_permitted_response_header ⇒ Object

Resets the list to the parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1280
1281
1282
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1280

def set_default_permitted_response_header
  super
end

#set_default_profile(opts) ⇒ Object

Sets the names of the default profile from which this profile will derive default values for its attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String) —

    The default profiles from which the specified profiles will get default values.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1293
1294
1295
1296
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1293

def set_default_profile(opts)
  opts = check_params(opts,[:defaults])
  super(opts)
end

#set_default_ramcache_uri_exclude ⇒ Object

Resets the lists to parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1304
1305
1306
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1304

def set_default_ramcache_uri_exclude
  super
end

#set_default_ramcache_uri_include ⇒ Object

Resets the list to the parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1314
1315
1316
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1314

def set_default_ramcache_uri_include
  super
end

#set_default_ramcache_uri_pinned ⇒ Object

Resets the lists to parent defaults.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1324
1325
1326
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1324

def set_default_ramcache_uri_pinned
  super
end

#set_fallback_host_name(opts) ⇒ Object

Sets the fallback host names used in HTTP redirect for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1336
1337
1338
1339
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1336

def set_fallback_host_name(opts)
  opts = check_params(opts,[:fallbacks])
  super(opts)
end

#set_header_erase(opts) ⇒ Object

Sets the headers to be erased into the HTTP headers for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1349
1350
1351
1352
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1349

def set_header_erase(opts)
  opts = check_params(opts,[:headers])
  super(opts)
end

#set_header_insert(opts) ⇒ Object

Sets the headers to be inserted into the HTTP headers for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1362
1363
1364
1365
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1362

def set_header_insert(opts)
  opts = check_params(opts,[:headers])
  super(opts)
end

#set_insert_xforwarded_for_header_mode(opts) ⇒ Object

Sets the mode to indicate whether to insert X-Forwarded-For headers for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1375
1376
1377
1378
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1375

def set_insert_xforwarded_for_header_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_keep_accept_encoding_header_state(opts) ⇒ Object

Sets the states that specify how we handle the "Accept-Encoding:“ header. If set to false, we will strip the "Accept-Encoding:” header before passing the request on to the server (so that the server doesn’t also compress the response). If it is set to true, we will leave the "Accept-Encoding:“ header in the request so that servers are able to do compression. We will not compress responses that have already been compressed.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1393
1394
1395
1396
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1393

def set_keep_accept_encoding_header_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_lws_maximum_column(opts) ⇒ Object

Sets the linear white space maximum column sizes used to support multi-line header insertion.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1407
1408
1409
1410
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1407

def set_lws_maximum_column(opts)
  opts = check_params(opts,[:sizes])
  super(opts)
end

#set_lws_separator(opts) ⇒ Object

Sets the linear white space separator strings for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1420
1421
1422
1423
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1420

def set_lws_separator(opts)
  opts = check_params(opts,[:separators])
  super(opts)
end

#set_maximum_header_size(opts) ⇒ Object

Sets the maximum header sizes for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1433
1434
1435
1436
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1433

def set_maximum_header_size(opts)
  opts = check_params(opts,[:sizes])
  super(opts)
end

#set_maximum_requests(opts) ⇒ Object

Sets the maximum number of HTTP requests allowed in the connection before it is closed automatically.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1447
1448
1449
1450
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1447

def set_maximum_requests(opts)
  opts = check_params(opts,[:maximum_requests])
  super(opts)
end

#set_oneconnect_header_transformation_state(opts) ⇒ Object

Sets the states that specify whether OneConnect HTTP header transformation is used for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1461
1462
1463
1464
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1461

def set_oneconnect_header_transformation_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_pipelining_mode(opts) ⇒ Object

Sets the pipelining mode for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1474
1475
1476
1477
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1474

def set_pipelining_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_preferred_compression_method(opts) ⇒ Object

Sets the preferred compression methods.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1487
1488
1489
1490
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1487

def set_preferred_compression_method(opts)
  opts = check_params(opts,[:compression_methods])
  super(opts)
end

#set_ramcache_aging_rate(opts) ⇒ Object

Sets the aging rate for the RAM cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1500
1501
1502
1503
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1500

def set_ramcache_aging_rate(opts)
  opts = check_params(opts,[:aging_rates])
  super(opts)
end

#set_ramcache_ignore_client_cache_control_mode(opts) ⇒ Object

Sets the mode to indicate whether to ignore the client cache control headers.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1513
1514
1515
1516
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1513

def set_ramcache_ignore_client_cache_control_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_ramcache_insert_age_header_mode(opts) ⇒ Object

Sets the mode that indicates whether to insert the Age headers for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1526
1527
1528
1529
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1526

def set_ramcache_insert_age_header_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_ramcache_maximum_age(opts) ⇒ Object

Sets the maximum age of a cached object in the RAM cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1539
1540
1541
1542
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1539

def set_ramcache_maximum_age(opts)
  opts = check_params(opts,[:maximum_age])
  super(opts)
end

#set_ramcache_maximum_entry(opts) ⇒ Object

Sets the maximum number of cache entries allowed in the RAM cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1552
1553
1554
1555
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1552

def set_ramcache_maximum_entry(opts)
  opts = check_params(opts,[:maximum_entries])
  super(opts)
end

#set_ramcache_mode(opts) ⇒ Object

Sets the RAM cache mode for this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1565
1566
1567
1568
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1565

def set_ramcache_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_ramcache_object_maximum_size(opts) ⇒ Object

Sets the maximum size requirement of a cached object in the RAM cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1578
1579
1580
1581
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1578

def set_ramcache_object_maximum_size(opts)
  opts = check_params(opts,[:maximum_size])
  super(opts)
end

#set_ramcache_object_minimum_size(opts) ⇒ Object

Sets the minimum size requirement of a cached object in the RAM cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1591
1592
1593
1594
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1591

def set_ramcache_object_minimum_size(opts)
  opts = check_params(opts,[:minimum_size])
  super(opts)
end

#set_ramcache_size(opts) ⇒ Object

Sets the size (MB) of the RAM cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1604
1605
1606
1607
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1604

def set_ramcache_size(opts)
  opts = check_params(opts,[:sizes])
  super(opts)
end

#set_redirect_rewrite_mode(opts) ⇒ Object

Sets the HTTP redirect/rewrite mode for the responses.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1617
1618
1619
1620
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1617

def set_redirect_rewrite_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_response_chunk_mode(opts) ⇒ Object

Sets the HTTP chunk mode for the responses.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1630
1631
1632
1633
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1630

def set_response_chunk_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_security_enabled_request_state(opts) ⇒ Object

Sets the state that if true, enable horizontal security for this HTTP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



1643
1644
1645
1646
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 1643

def set_security_enabled_request_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#statistics ⇒ ProfileHttpStatistics

Gets the statistics for this HTTP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



821
822
823
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 821

def statistics
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


829
830
831
 
# File 'lib/icontrol/local_lb/profile_http.rb', line 829

def version
  super
end