LocalLB::ProfileHttp

Introduced : BIG-IP_v9.0
The ProfileHttp interface enables you to manipulate a local load balancer&aposs HTTP profile.

Methods

Method Description Introduced
add_compression_content_type_exclude This method is deprecated (immediately) and should no longer be used. Adds to the lists of regular expressions used to match the MIME types in the server response&aposs “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/*”. BIG-IP_v9.0
add_compression_content_type_include This method is deprecated (immediately) and should no longer be used. Adds to the lists of regular expressions used to match the MIME types in the server response&aposs “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/*”. BIG-IP_v9.0
add_compression_uri_exclude This method is deprecated (immediately) and should no longer be used. 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” BIG-IP_v9.0
add_compression_uri_include This method is deprecated (immediately) and should no longer be used. 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”. BIG-IP_v9.0
add_cookie_encryption Adds to the lists of cookies to be encrypted before sending them to the clients. BIG-IP_v9.4.0
add_fallback_status_code 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. BIG-IP_v9.4.0
add_permitted_response_header Adds to the lists of permitted headers in the responses for the specified HTTP profiles. BIG-IP_v9.4.0
add_ramcache_uri_exclude This method is deprecated (immediately) and should no longer be used. 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” BIG-IP_v9.0.5
add_ramcache_uri_include This method is deprecated (immediately) and should no longer be used. 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”. BIG-IP_v9.0.5
add_ramcache_uri_pinned This method is deprecated (immediately) and should no longer be used. Adds to the lists of cachable document URIs that will never be evicted from the cache. BIG-IP_v9.0.5
add_xff_alternative_names Adds a list of XFF alternative header names. BIG-IP_v11.3.0
create Creates the specified HTTP profiles. BIG-IP_v9.0
delete_all_profiles Deletes all HTTP profiles. BIG-IP_v9.0
delete_profile Deletes the specified HTTP profiles. BIG-IP_v9.0
get_accept_xff_state Gets the accept XFF (X-Forwarded-For) state for the specified HTTP profiles. BIG-IP_v11.3.0
get_all_statistics Gets the statistics for all the HTTP profiles. BIG-IP_v9.0
get_basic_auth_realm Gets the basic authentication realms for the specified HTTP profiles. BIG-IP_v9.0
get_compression_allow_http_10_state This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
get_compression_browser_workaround_state This method is deprecated (immediately) and should no longer be used. Gets the states that specify whether to workaround browser bugs when doing compression. BIG-IP_v9.0
get_compression_buffer_size This method is deprecated (immediately) and should no longer be used. 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&aposs response, in case the server&aposs response headers don&apost specify the content length of the response. BIG-IP_v9.0
get_compression_content_type_exclude This method is deprecated (immediately) and should no longer be used. Gets the lists of regular expressions used to match the MIME types in the server response&aposs “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/*”. BIG-IP_v9.0
get_compression_content_type_include This method is deprecated (immediately) and should no longer be used. Gets the lists of regular expressions used to match the MIME types in the server response&aposs “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/*”. BIG-IP_v9.0
get_compression_cpu_saver_high_threshold This method is deprecated (immediately) and should no longer be used. Gets the CPU saver high threshold that basically switches to NULL compression when CPU utilization exceeds this value. BIG-IP_v9.0.3
get_compression_cpu_saver_low_threshold This method is deprecated (immediately) and should no longer be used. Gets the CPU saver low threshold that basically enables full throttle on compression when CPU utilization drops below this value. BIG-IP_v9.0.3
get_compression_cpu_saver_state This method is deprecated (immediately) and should no longer be used. Gets the states that specify whether to enable CPU saving mode when doing compression. BIG-IP_v9.0.3
get_compression_level This method is deprecated (immediately) and should no longer be used. Gets the compression level used by the specified HTTP profiles. BIG-IP_v9.0
get_compression_memory_level This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
get_compression_minimum_size This method is deprecated (immediately) and should no longer be used. Gets the values that specify the minimmum length of the server responses (in bytes) to be considered acceptable for compression. BIG-IP_v9.0
get_compression_mode This method is deprecated (immediately) and should no longer be used. Gets the HTTP compression modes for the specified HTTP profiles. BIG-IP_v9.0
get_compression_uri_exclude This method is deprecated (immediately) and should no longer be used. 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” BIG-IP_v9.0
get_compression_uri_include This method is deprecated (immediately) and should no longer be used. 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”. BIG-IP_v9.0
get_compression_vary_header_state This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
get_compression_window_size This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
get_cookie_encryption Gets the lists of cookies to be encrypted before sending them to the clients. BIG-IP_v9.4.0
get_cookie_encryption_passphrase Gets the passphrases used to encrypt the cookies for the specified profiles. BIG-IP_v9.4.0
get_default_profile Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v9.0
get_description Gets the descriptions for a set of HTTP profiles. BIG-IP_v11.0.0
get_fallback_host_name Gets the fallback host names used in HTTP redirect for the specified HTTP profiles. BIG-IP_v9.0
get_fallback_status_code 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. BIG-IP_v9.4.0
get_header_erase Gets the headers to be erased for the specified HTTP profiles. BIG-IP_v9.0
get_header_insert Gets the headers to be inserted for the specified HTTP profiles. BIG-IP_v9.0
get_hsts_include_subdomains_state Gets HSTS include subdomains state for the specified HTTP profiles. BIG-IP_v12.0.0
get_hsts_maximum_age Gets HSTS values for the specified HTTP profiles. BIG-IP_v12.0.0
get_hsts_preload_state Gets the HSTS preload state for the specified HTTP profiles. BIG-IP_v13.0.0
get_hsts_state Gets HSTS enabled state for the specified HTTP profiles. BIG-IP_v12.0.0
get_http_proxy_type Gets the HTTP proxy type for the specified profiles, which specifies the type of proxy the system acts as to incoming HTTP traffic. The default proxy type is reverse. BIG-IP_v11.5.0
get_insert_xforwarded_for_header_mode Gets the mode to indicate whether to insert X-Forwarded-For headers for the specified profiles. BIG-IP_v9.0
get_keep_accept_encoding_header_state This method is deprecated (immediately) and should no longer be used. 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&apost 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. BIG-IP_v9.0
get_list Gets a list of all HTTP profiles. BIG-IP_v9.0
get_lws_maximum_column Gets the linear white space maximum column sizes used to support multi-line header insertion. BIG-IP_v9.0
get_lws_separator Gets the linear white space separator strings for the specified HTTP profiles. BIG-IP_v9.0
get_maximum_header_size Gets the maximum header sizes for the specified HTTP profiles. BIG-IP_v9.0.2
get_maximum_requests Gets the maximum number of HTTP requests allowed in the connection before it is closed automatically. BIG-IP_v9.0
get_oneconnect_header_transformation_state Gets the states that specify that OneConnect HTTP header transformation feature is used or not. BIG-IP_v9.0
get_passthrough_excess_client_headers_state Gets the excess client headers state for the specified profiles. BIG-IP_v11.5.0
get_passthrough_excess_server_headers_state Gets the excess server headers state for the specified profiles. BIG-IP_v11.5.0
get_passthrough_oversize_client_headers_state Gets the oversize client headers state for the specified profiles. BIG-IP_v11.5.0
get_passthrough_oversize_server_headers_state Gets the oversize server headers state for the specified profiles. BIG-IP_v11.5.0
get_passthrough_unknown_method_mode Gets the unknown HTTP method passthrough mode for the specified profiles. BIG-IP_v11.5.0
get_permitted_response_header Gets the lists of permitted headers in the responses for the specified HTTP profiles. BIG-IP_v9.4.0
get_pipelining_mode This method has been deprecated. Please use get_pipelining_mode_v2 instead. Gets the pipelining mode for the specified profiles. BIG-IP_v9.0
get_pipelining_mode_v2 Gets the HTTP/1.1 pipelining mode for the specified profiles. BIG-IP_v11.5.0
get_preferred_compression_method This method is deprecated (immediately) and should no longer be used. Gets the preferred compression methods. BIG-IP_v9.2.0
get_ramcache_aging_rate This method is deprecated (immediately) and should no longer be used. Gets the aging rate for the RAM cache. BIG-IP_v9.0.5
get_ramcache_ignore_client_cache_control_mode This method is deprecated (immediately) and should no longer be used. Gets the mode to indicate whether to ignore the client cache control headers. BIG-IP_v9.0.5
get_ramcache_insert_age_header_mode This method is deprecated (immediately) and should no longer be used. Gets the mode that indicates whether to insert the Age headers for the specified profiles. BIG-IP_v9.0.5
get_ramcache_maximum_age This method is deprecated (immediately) and should no longer be used. Gets the maximum age of a cached object in the RAM cache. BIG-IP_v9.0.5
get_ramcache_maximum_entry This method is deprecated (immediately) and should no longer be used. Gets the maximum number of cache entries allowed in the RAM cache. BIG-IP_v9.0.5
get_ramcache_mode This method is deprecated (immediately) and should no longer be used. Gets the RAM cache mode for the specified profiles. BIG-IP_v9.0.5
get_ramcache_object_maximum_size This method is deprecated (immediately) and should no longer be used. Gets the maximum size requirement of a cached object in the RAM cache. BIG-IP_v9.0.5
get_ramcache_object_minimum_size This method is deprecated (immediately) and should no longer be used. Gets the minimum size requirement of a cached object in the RAM cache. BIG-IP_v9.0.5
get_ramcache_size This method is deprecated (immediately) and should no longer be used. Gets the size (MB) of the RAM cache. BIG-IP_v9.0.5
get_ramcache_uri_exclude This method is deprecated (immediately) and should no longer be used. 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” BIG-IP_v9.0.5
get_ramcache_uri_include This method is deprecated (immediately) and should no longer be used. 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”. BIG-IP_v9.0.5
get_ramcache_uri_pinned This method is deprecated (immediately) and should no longer be used. Gets the lists of cachable document URIs that will never be evicted from the cache. BIG-IP_v9.0.5
get_redirect_rewrite_mode Gets the HTTP redirect/rewrite mode for the responses. BIG-IP_v9.0
get_request_chunk_mode Gets the HTTP chunk mode for the requests. BIG-IP_v11.0.0
get_response_chunk_mode Gets the HTTP chunk mode for the responses. BIG-IP_v9.0
get_security_enabled_request_state This method has been deprecated (immediately) and should no longer be used. As of v11.5.0, there is separate HTTP Security profile, which is assigned to VS. Gets the state that if true, enable horizontal security for the specified HTTP profiles. BIG-IP_v9.4.5
get_send_proxy_via_header_host_name Gets the hostname appended to a Via header in a request or response by this system. BIG-IP_v11.0.0
get_send_proxy_via_header_type_in_request Gets the Via header configuration for requests to the OWS. For more information on Via header configurations see ViaHeader. BIG-IP_v11.0.0
get_send_proxy_via_header_type_in_response Gets the Via header configuration for responses from the OWS. For more information on Via header configurations see ViaHeader. BIG-IP_v11.0.0
get_server_agent_name Gets the server agent name sent in responses that the BIG-IP itself generates. BIG-IP_v11.4.0
get_sflow_poll_interval Gets the sFlow poll intervals for the specified HTTP profiles. BIG-IP_v11.4.0
get_sflow_poll_interval_global Gets the sFlow polling types for the specified HTTP profiles. BIG-IP_v11.4.0
get_sflow_sampling_rate Gets the sFlow sampling rates for the specified HTTP profiles. BIG-IP_v11.4.0
get_sflow_sampling_rate_global Gets the sFlow sampling types for the specified HTTP profiles. BIG-IP_v11.4.0
get_statistics Gets the statistics for the specified HTTP profiles. Note that as of v11.0, statistics related to compression and caching have been moved to the HTTP Compression and Web Acceleration profiles. BIG-IP_v9.0
get_statistics_by_virtual Gets the statistics for the specified profiles, by virtual server. BIG-IP_v11.0.0
get_truncated_redirect_mode Gets the truncated redirect mode for the specified profiles, which specifies the action taken if a truncated redirect is seen from a server. BIG-IP_v11.5.0
get_version Gets the version information for this interface. BIG-IP_v9.0
get_xff_alternative_names Gets the list of XFF alternative header names that are used instead of the default X-Forwarded-For HTTP header. BIG-IP_v11.3.0
is_base_profile Determines whether the specified HTTP profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). BIG-IP_v9.0
is_system_profile Determines whether the specified HTTP profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). BIG-IP_v11.0.0
remove_all_xff_alternative_names Removes all XFF alternative header names. BIG-IP_v11.3.0
remove_compression_content_type_exclude This method is deprecated (immediately) and should no longer be used. Removes from the lists of regular expressions used to match the MIME types in the server response&aposs “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/*”. BIG-IP_v9.0
remove_compression_content_type_include This method is deprecated (immediately) and should no longer be used. Removes from the lists of regular expressions used to match the MIME types in the server response&aposs “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/*”. BIG-IP_v9.0
remove_compression_uri_exclude This method is deprecated (immediately) and should no longer be used. 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” BIG-IP_v9.0
remove_compression_uri_include This method is deprecated (immediately) and should no longer be used. 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”. BIG-IP_v9.0
remove_cookie_encryption Removes from the lists of cookies to be encrypted before sending them to the clients. BIG-IP_v9.4.0
remove_fallback_status_code 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. BIG-IP_v9.4.0
remove_permitted_response_header Removes from the lists of permitted headers in the responses for the specified HTTP profiles. BIG-IP_v9.4.0
remove_ramcache_uri_exclude This method is deprecated (immediately) and should no longer be used. 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” BIG-IP_v9.0.5
remove_ramcache_uri_include This method is deprecated (immediately) and should no longer be used. 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”. BIG-IP_v9.0.5
remove_ramcache_uri_pinned This method is deprecated (immediately) and should no longer be used. Removes from the lists of cachable document URIs that will never be evicted from the cache. BIG-IP_v9.0.5
remove_xff_alternative_names Removes a list of XFF alternative header names. BIG-IP_v11.3.0
reset_statistics Resets the statistics for the specified HTTP profiles. BIG-IP_v9.0
reset_statistics_by_virtual Resets the statistics for the specified profiles, for specified virtual servers. BIG-IP_v11.0.0
set_accept_xff_state Sets the accept XFF (X-Forwarded-For) state for the specified HTTP profiles. If enabled - the XFF HTTP header is trusted (accepted) and forwarded. BIG-IP_v11.3.0
set_basic_auth_realm Sets the basic authentication realms for the specified HTTP profiles. BIG-IP_v9.0
set_compression_allow_http_10_state This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
set_compression_browser_workaround_state This method is deprecated (immediately) and should no longer be used. Sets the states that specify whether to workaround browser bugs when doing compression. BIG-IP_v9.0
set_compression_buffer_size This method is deprecated (immediately) and should no longer be used. 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&aposs response, in case the server&aposs response headers don&apost specify the content length of the response. BIG-IP_v9.0
set_compression_cpu_saver_high_threshold This method is deprecated (immediately) and should no longer be used. Sets the CPU saver high threshold that basically switches to NULL compression when CPU utilization exceeds this value. BIG-IP_v9.0.3
set_compression_cpu_saver_low_threshold This method is deprecated (immediately) and should no longer be used. Sets the CPU saver low threshold that basically enables full throttle on compression when CPU utilization drops below this value. BIG-IP_v9.0.3
set_compression_cpu_saver_state This method is deprecated (immediately) and should no longer be used. Sets the states that specify whether to enable CPU saving mode when doing compression. BIG-IP_v9.0.3
set_compression_level This method is deprecated (immediately) and should no longer be used. Sets the compression level used by the specified HTTP profiles. BIG-IP_v9.0
set_compression_memory_level This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
set_compression_minimum_size This method is deprecated (immediately) and should no longer be used. Sets the values that specify the minimmum length of the server responses (in bytes) to be considered acceptable for compression. BIG-IP_v9.0
set_compression_mode This method is deprecated (immediately) and should no longer be used. Sets the HTTP compression modes for the specified HTTP profiles. BIG-IP_v9.0
set_compression_vary_header_state This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
set_compression_window_size This method is deprecated (immediately) and should no longer be used. 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. BIG-IP_v9.0
set_cookie_encryption_passphrase Sets the passphrases used to encrypt the cookies for the specified profiles. BIG-IP_v9.4.0
set_default_compression_content_type_exclude This method is deprecated (immediately) and should no longer be used. Resets the lists to parent defaults. BIG-IP_v9.0
set_default_compression_content_type_include This method is deprecated (immediately) and should no longer be used. Resets the lists to parent defaults. BIG-IP_v9.0
set_default_compression_uri_exclude This method is deprecated (immediately) and should no longer be used. Resets the lists to parent defaults. BIG-IP_v9.0
set_default_compression_uri_include This method is deprecated (immediately) and should no longer be used. Resets the list to the parent defaults. BIG-IP_v9.0
set_default_cookie_encryption Resets the list to the parent defaults. BIG-IP_v9.4.0
set_default_fallback_status_code Resets the list to the parent defaults. BIG-IP_v9.4.0
set_default_permitted_response_header Resets the list to the parent defaults. BIG-IP_v9.4.0
set_default_profile Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v9.0
set_default_ramcache_uri_exclude This method is deprecated (immediately) and should no longer be used. Resets the lists to parent defaults. BIG-IP_v9.0.5
set_default_ramcache_uri_include This method is deprecated (immediately) and should no longer be used. Resets the list to the parent defaults. BIG-IP_v9.0.5
set_default_ramcache_uri_pinned This method is deprecated (immediately) and should no longer be used. Resets the lists to parent defaults. BIG-IP_v9.0.5
set_default_xff_alternative_names Resets the XFF alternative header names to default. BIG-IP_v11.3.0
set_description Sets the description for a set of HTTP profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_fallback_host_name Sets the fallback host names used in HTTP redirect for the specified HTTP profiles. BIG-IP_v9.0
set_header_erase Sets the headers to be erased into the HTTP headers for the specified HTTP profiles. BIG-IP_v9.0
set_header_insert Sets the headers to be inserted into the HTTP headers for the specified HTTP profiles. BIG-IP_v9.0
set_hsts_include_subdomains_state Sets HSTS include subdomains state for the specified HTTP profiles, which when enabled will include the `includeSubdomains&apos directive in the Strict-Transport-Security response header. BIG-IP_v12.0.0
set_hsts_maximum_age Sets HSTS timeout (in seconds) for the specified HTTP profiles. BIG-IP_v12.0.0
set_hsts_preload_state Sets the HSTS preload state for the specified HTTP profiles, which when enabled will include the `preload&apos directive in the Strict-Transport-Security response header. BIG-IP_v13.0.0
set_hsts_state Sets HSTS enabled state for the specified HTTP profiles. When enabled, the `Strict-Transport-Security&apos response header is inserted informing the HTTP client that all access should only be through HTTPS. BIG-IP_v12.0.0
set_insert_xforwarded_for_header_mode Sets the mode to indicate whether to insert X-Forwarded-For headers for the specified profiles. BIG-IP_v9.0
set_keep_accept_encoding_header_state This method is deprecated (immediately) and should no longer be used. 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&apost 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. BIG-IP_v9.0
set_lws_maximum_column Sets the linear white space maximum column sizes used to support multi-line header insertion. BIG-IP_v9.0
set_lws_separator Sets the linear white space separator strings for the specified HTTP profiles. BIG-IP_v9.0
set_maximum_header_size Sets the maximum header sizes for the specified HTTP profiles. BIG-IP_v9.0
set_maximum_requests Sets the maximum number of HTTP requests allowed in the connection before it is closed automatically. BIG-IP_v9.0.2
set_oneconnect_header_transformation_state Sets the states that specify whether OneConnect HTTP header transformation is used for the specified HTTP profiles. BIG-IP_v9.0
set_passthrough_excess_client_headers_state Sets the excess client headers state for the specified profiles, which indicates the behavior when too many client headers are received. If enabled, the system will switch to pass through mode instead of rejecting the connection. BIG-IP_v11.5.0
set_passthrough_excess_server_headers_state Sets the excess server headers state for the specified profiles, which indicates the behavior when too many server headers are received. If enabled, the system will switch to pass through mode instead of rejecting the connection. BIG-IP_v11.5.0
set_passthrough_oversize_client_headers_state Sets the oversize client headers state for the specified profiles, which indicates the behavior when client headers that are too large are received. If enabled, the system will switch to pass through mode instead of rejecting the connection. BIG-IP_v11.5.0
set_passthrough_oversize_server_headers_state Sets the oversize server headers state for the specified profiles, which indicates the behavior when server headers that are too large are received. If enabled, the system will switch to pass through mode instead of rejecting the connection. BIG-IP_v11.5.0
set_passthrough_unknown_method_mode Sets the unknown HTTP method passthrough mode for the specified profiles, which specifies the action to take when an unknown HTTP method is parsed. The known HTTP methods are: CONNECT, DELETE, GET, HEAD, LOCK, OPTIONS, POST, PROPFIND, PUT, TRACE, and UNLOCK. The default mode is allow. BIG-IP_v11.5.0
set_pipelining_mode This method has been deprecated. Please use set_pipelining_mode_v2 instead. Sets the pipelining mode for the specified profiles. BIG-IP_v9.0
set_pipelining_mode_v2 Sets the HTTP/1.1 pipelining mode for the specified profiles. This allows clients to make requests even when prior requests have not received a response. In order for this to succeed, however, destination servers must include support for pipelining. If set to pass-through, pipelined data will cause the system to switch immediately to pass-through mode and disable the HTTP filter. The default mode is allow. BIG-IP_v11.5.0
set_preferred_compression_method This method is deprecated (immediately) and should no longer be used. Sets the preferred compression methods. BIG-IP_v9.2.0
set_ramcache_aging_rate This method is deprecated (immediately) and should no longer be used. Sets the aging rate for the RAM cache. BIG-IP_v9.0.5
set_ramcache_ignore_client_cache_control_mode This method is deprecated (immediately) and should no longer be used. Sets the mode to indicate whether to ignore the client cache control headers. BIG-IP_v9.0.5
set_ramcache_insert_age_header_mode This method is deprecated (immediately) and should no longer be used. Sets the mode that indicates whether to insert the Age headers for the specified profiles. BIG-IP_v9.0.5
set_ramcache_maximum_age This method is deprecated (immediately) and should no longer be used. Sets the maximum age of a cached object in the RAM cache. BIG-IP_v9.0.5
set_ramcache_maximum_entry This method is deprecated (immediately) and should no longer be used. Sets the maximum number of cache entries allowed in the RAM cache. BIG-IP_v9.0.5
set_ramcache_mode This method is deprecated (immediately) and should no longer be used. Sets the RAM cache mode for the specified profiles. BIG-IP_v9.0.5
set_ramcache_object_maximum_size This method is deprecated (immediately) and should no longer be used. Sets the maximum size requirement of a cached object in the RAM cache. BIG-IP_v9.0.5
set_ramcache_object_minimum_size This method is deprecated (immediately) and should no longer be used. Sets the minimum size requirement of a cached object in the RAM cache. BIG-IP_v9.0.5
set_ramcache_size This method is deprecated (immediately) and should no longer be used. Sets the size (MB) of the RAM cache. BIG-IP_v9.0.5
set_redirect_rewrite_mode Sets the HTTP redirect/rewrite mode for the responses. BIG-IP_v9.0
set_request_chunk_mode Sets the HTTP chunk mode for the requests. BIG-IP_v11.0.0
set_response_chunk_mode Sets the HTTP chunk mode for the responses. BIG-IP_v9.0
set_security_enabled_request_state This method has been deprecated (immediately) and should no longer be used. As of v11.5.0, there is separate HTTP Security profile, which is assigned to VS. Sets the state that if true, enable horizontal security for the specified HTTP profiles. BIG-IP_v9.4.5
set_send_proxy_via_header_host_name Sets the hostname appended to a Via header by the system in a request or response. BIG-IP_v11.0.0
set_send_proxy_via_header_type_in_request Sets the Via header configuration for requests to the OWS. For more information on Via header configurations see ViaHeader. BIG-IP_v11.0.0
set_send_proxy_via_header_type_in_response Sets the Via header configuration for responses from the OWS. For more information on Via header configurations see ViaHeader. BIG-IP_v11.0.0
set_server_agent_name Sets the server header name sent in responses that the BIG-IP itself generates. The default value is “BigIP”. If “” is set as the value, then no server header name will be added to such responses. BIG-IP_v11.4.0
set_sflow_poll_interval Sets the sFlow poll intervals for the specified HTTP profiles. This is the maximum interval in seconds between polling of the specified profiles. You should set the poll intervals for the profiles when you want the counters associated with these profiles to be sampled at an interval that is different than the global sFlow poll interval. Note: you will also need to set the polling type to SFLOW_GLOBAL_NO (see set_sflow_poll_interval_global). The default is 0 (zero). BIG-IP_v11.4.0
set_sflow_poll_interval_global Sets the sFlow polling types for the specified HTTP profiles. It allows you to specify whether the global sFlow poll interval overrides the object-level poll interval for the specified profiles. The default is SFLOW_GLOBAL_YES. BIG-IP_v11.4.0
set_sflow_sampling_rate Sets the sFlow sampling rates for the specified HTTP profiles. This is the ratio of packets observed at the virtual servers to which the HTTP profile is assigned to the number of samples you want the BIG-IP system to generate. For example, a sampling rate of 2000 specifies that 1 sample will be randomly generated for every 2000 packets observed. You should set the sampling rates for the profiles when you want the traffic flowing through the virtual servers to be sampled at a rate that is different than the global sFlow sampling rate. Note: you will also need to set the sampling type to SFLOW_GLOBAL_NO (see set_sflow_sampling_rate_global). The default is 0 (zero). BIG-IP_v11.4.0
set_sflow_sampling_rate_global Sets the sFlow sampling types for the specified HTTP profiles. It allows you to specify whether the global sFlow sampling rate overrides the object-level sampling rate for the specified profiles. The default is SFLOW_GLOBAL_YES. BIG-IP_v11.4.0
set_truncated_redirect_mode Sets the truncated redirect mode for the specified profiles, which specifies the action taken if a truncated redirect is seen from a server. If enabled, the redirect will be forwarded to the client; otherwise, the malformed HTTP will be silently ignored. BIG-IP_v11.5.0

Structures

Structure

Description

ProfileHTTPProxyType

A struct that describes HTTP proxy types and their default status.

ProfileHttpStatisticEntry

A struct that describes statistics for a particular HTTP profile.

ProfileHttpStatistics

A struct that describes profile statistics and timestamp.

ProfilePassthroughMode

A struct that describes HTTP passthrough modes and their default status.

ProfileViaHeader

A struct that describes Via header settings and their default status.


Enumerations

Enumeration Description
HTTPProxyType An enum that specifies the HTTP proxy type.
PassthroughMode An enum that specifies the system behavior when accepting HTTP traffic.
ViaHeader The Via header concatenates information for each intermediate router in a response or request. This information can be used to identify intermediate routers that forward messages or protocols used by those routers. This option can be configured for both requests to the OWS and responses from the OWS. The Via header includes both required and optional protocol information such as: the protocol used (required except when the HTTP protocol is used), the protocol version used (required, such as 1.0, 1.1, and so on for HTTP), the hostname (required, though an alias may be used), the port number used (optional, though when omitted, the default port applies), and a comment describing the router (optional).

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ProfileHTTPProxyTypeSequence ProfileHTTPProxyType [] A sequence of profile HTTP proxy types.
ProfileHttpStatisticEntrySequence ProfileHttpStatisticEntry [] A sequence of ProfileHttp statistics.
ProfilePassthroughModeSequence ProfilePassthroughMode [] A sequence of profile passthrough modes.
ProfileViaHeaderSequence ProfileViaHeader [] A sequence of via header types.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.