LocalLB::ProfileHttpCompression¶
Introduced : BIG-IP_v11.0
The ProfileHttpCompression interface enables you to manipulate a local
load balancer&aposs HTTP compression profile.
Methods¶
| Method | Description | Introduced |
| add_content_type_exclude | 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_v11.0.0 |
| add_content_type_include | 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_v11.0.0 |
| add_uri_exclude | 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_v11.0.0 |
| add_uri_include | 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_v11.0.0 |
| create | Creates the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| delete_all_profiles | Deletes all HTTP compression profiles. | BIG-IP_v11.0.0 |
| delete_profile | Deletes the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| get_all_statistics | Gets the statistics for all HTTP compression profiles. | BIG-IP_v11.0.0 |
| get_allow_http_10_state | Sets the states that specify whether compression will be allowed on responses to HTTP 1.0 requests. | BIG-IP_v11.0.0 |
| get_browser_workaround_state | Gets the states that specify whether to workaround browser bugs when doing compression. | BIG-IP_v11.0.0 |
| get_buffer_size | Gets the values that specify the maximum number of uncompressed bytes that compression 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_v11.0.0 |
| get_content_type_exclude | 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_v11.0.0 |
| get_content_type_include | 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_v11.0.0 |
| get_cpu_saver_high_threshold | Gets the CPU saver high threshold that basically switches to NULL compression when CPU utilization exceeds this value. | BIG-IP_v11.0.0 |
| get_cpu_saver_low_threshold | Gets the CPU saver low threshold that basically enables full throttle on compression when CPU utilization drops below this value. | BIG-IP_v11.0.0 |
| get_cpu_saver_state | Gets the states that specify whether to enable CPU saving mode when doing compression. | BIG-IP_v11.0.0 |
| get_default_profile | Gets the names of the default profiles from which the specified profiles will derive default values for their attributes. | BIG-IP_v11.0.0 |
| get_description | Gets the descriptions for a set of HTTP compression profiles. | BIG-IP_v11.0.0 |
| get_keep_accept_encoding_header_state | Gets the states that specify how the “Accept-Encoding” header will be handled. If set to false, the “Accept-Encoding” header will be removed before passing the request on to the server (so that the server doesn&apost compress the response). If set to true, the Accept-Encoding header will be left in the request so that servers are able to do compression. Responses compressed by the server will not be compressed by BIG-IP compression. | BIG-IP_v11.0.0 |
| get_level | Gets the compression level used by the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| get_list | Gets a list of all HTTP compression profiles. | BIG-IP_v11.0.0 |
| get_memory_level | 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). | BIG-IP_v11.0.0 |
| get_minimum_size | Gets the values that specify the minimmum length of the server responses (in bytes) to be considered acceptable for compression. | BIG-IP_v11.0.0 |
| get_preferred_method | Gets the preferred compression methods. | BIG-IP_v11.0.0 |
| get_selective_state | Gets the selective compression states for the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| get_statistics | Gets the statistics for the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v11.0.0 |
| get_uri_exclude | 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_v11.0.0 |
| get_uri_include | 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_v11.0.0 |
| get_vary_header_state | Sets the states that specify whether a Vary header will be inserted into responses that have been compressed by the specified profiles. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.0.0 |
| get_window_size | 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). | BIG-IP_v11.0.0 |
| is_base_profile | Determines whether the specified HTTP compression 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_v11.0.0 |
| is_system_profile | Determines whether the specified HTTP compression 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_content_type_exclude | 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_v11.0.0 |
| remove_content_type_include | 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_v11.0.0 |
| remove_uri_exclude | 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_v11.0.0 |
| remove_uri_include | 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_v11.0.0 |
| reset_statistics | Resets the statistics for the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.0.0 |
| set_allow_http_10_state | Sets the states that specify whether compression will be allowed on responses to HTTP 1.0 requests. | BIG-IP_v11.0.0 |
| set_browser_workaround_state | Sets the states that specify whether to workaround browser bugs when doing compression. | BIG-IP_v11.0.0 |
| set_buffer_size | Sets the values that specify the maximum number of uncompressed bytes that compression 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_v11.0.0 |
| set_cpu_saver_high_threshold | Sets the CPU saver high threshold that basically switches to NULL compression when CPU utilization exceeds this value. | BIG-IP_v11.0.0 |
| set_cpu_saver_low_threshold | Sets the CPU saver low threshold that basically enables full throttle on compression when CPU utilization drops below this value. | BIG-IP_v11.0.0 |
| set_cpu_saver_state | Sets the states that specify whether to enable CPU saving mode when doing compression. | BIG-IP_v11.0.0 |
| set_default_content_type_exclude | Resets the content type exclude lists to parent defaults. | BIG-IP_v11.0.0 |
| set_default_content_type_include | Resets the content type include lists to parent defaults. | BIG-IP_v11.0.0 |
| set_default_profile | Sets the names of the default profiles from which the specified profiles will derive default values for their attributes. | BIG-IP_v11.0.0 |
| set_default_uri_exclude | Resets the URI exclude lists to parent defaults. | BIG-IP_v11.0.0 |
| set_default_uri_include | Resets the URI include lists to the parent defaults. | BIG-IP_v11.0.0 |
| set_description | Sets the description for a set of HTTP compression profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_keep_accept_encoding_header_state | Sets the states that specify how the “Accept-Encoding” header will be handled. If set to false, the “Accept-Encoding” header will be removed before passing the request on to the server (so that the server doesn&apost compress the response). If set to true, the Accept-Encoding header will be left in the request so that servers are able to do compression. Responses compressed by the server will not be compressed by BIG-IP compression. | BIG-IP_v11.0.0 |
| set_level | Sets the compression level used by the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| set_memory_level | 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). | BIG-IP_v11.0.0 |
| set_minimum_size | Sets the values that specify the minimmum length of the server responses (in bytes) to be considered acceptable for compression. | BIG-IP_v11.0.0 |
| set_preferred_method | Sets the preferred compression methods. | BIG-IP_v11.0.0 |
| set_selective_state | Sets the selective compression states for the specified HTTP compression profiles. | BIG-IP_v11.0.0 |
| set_vary_header_state | Sets the states that specify whether a Vary header will be inserted into responses that have been compressed by the specified profiles. | BIG-IP_v11.0.0 |
| set_window_size | 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). | BIG-IP_v11.0.0 |
Structures¶
Structure
Description
ProfileHttpCompressionStatisticEntry
A struct that describes statistics for a particular HTTP compression profile.
ProfileHttpCompressionStatistics
A struct that describes profile statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| ProfileHttpCompressionStatisticEntrySequence | ProfileHttpCompressionStatisticEntry [] | A sequence of HTTP compression profile statistics. |
See Also¶
iControl ::
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.