LocalLB::ProfileWebAcceleration¶
Introduced : BIG-IP_v11.0.0
The ProfileWebAcceleration interface enables you to manipulate a local
load balancer&aposs web acceleration profiles.
Methods¶
| Method | Description | Introduced |
| add_application | Adds to the list of applications attached to the specified web acceleration profiles. It is possible to create and modify applications in Webaccelerator::Applications if WAM is provisioned on this system. | BIG-IP_v11.0.0 |
| add_cache_uri_exclude | 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 caching 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_cache_uri_include | 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_v11.0.0 |
| add_cache_uri_include_override | Adds the lists of regular expressions used to match the request URI part of the client requests during caching even if the cache object might be excluded for a reason other than being explicitly on the exclude list. (see section 5.1 of RFC2616). A match must be found in at least one of the “include override” fields as well as in the “include” fields to force caching of the object always. For example, to include requests ending in “.txt”, “.htm” and “.html”, one would use the following in the uri include field: “.txt” “.htm” “*.html”. To cache filename.txt that would otherwise be excluded for being too large, one would use the following in the uri include override field: “filename.txt”. | BIG-IP_v11.0.0 |
| add_cache_uri_pinned | Adds to the lists of cachable document URIs that will never be evicted from the cache. | BIG-IP_v11.0.0 |
| create | Creates the specified web acceleration profiles. | BIG-IP_v11.0.0 |
| delete_all_profiles | Deletes all web acceleration profiles. | BIG-IP_v11.0.0 |
| delete_profile | Deletes the specified web acceleration profiles. | BIG-IP_v11.0.0 |
| evict_all_cache_entries | Resets/evicts all cache entries. | BIG-IP_v11.0.0 |
| evict_cache_entry | Resets/evicts the cache entries associated with the specified keys. Note: The “max_responses” field in each CacheKey key is ignored in this method. | BIG-IP_v11.0.0 |
| get_all_statistics | Gets the statistics for all web acceleration profiles. | BIG-IP_v11.0.0 |
| get_application | Gets the lists of applications attached to the specified web acceleration profiles. | BIG-IP_v11.0.0 |
| get_cache_aging_rate | Gets the object aging rate for the cache. | BIG-IP_v11.0.0 |
| get_cache_entry | Gets the cache entries associated with the specified keys. The “profile_name” in the key is required, however, other fields in each key are optionally specified. “max_response” is recommended to be set to avoid possible large amount of entries. | BIG-IP_v11.0.0 |
| get_cache_entry_exact_match | Gets the cache entries associated with the specified keys. Each field in the key must be provided, and together the key is used to extract a specific entry. However, since each entry with the same profile/hostname/URI can still vary based on the User-Agent or Accept-Encoding headers, a separate entry will be returned for each variation, with also the specific header string that causes the variation. | BIG-IP_v11.0.0 |
| get_cache_ignore_client_cache_control_mode | Gets the mode to indicate whether to ignore the client cache control headers. | BIG-IP_v11.0.0 |
| get_cache_insert_age_header_state | Gets the state that indicates whether to insert the Age headers for the specified profiles. | BIG-IP_v11.0.0 |
| get_cache_maximum_age | Gets the maximum age for objects in the cache. | BIG-IP_v11.0.0 |
| get_cache_maximum_entries | Gets the maximum number of entries allowed in the cache. | BIG-IP_v11.0.0 |
| get_cache_object_maximum_size | Gets the maximum size requirement for objects in the cache. | BIG-IP_v11.0.0 |
| get_cache_object_minimum_size | Gets the minimum size requirement for objects in the cache. | BIG-IP_v11.0.0 |
| get_cache_size | Gets the size of the cache (in MB). | BIG-IP_v11.0.0 |
| get_cache_uri_exclude | 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 caching 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_cache_uri_include | 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_v11.0.0 |
| get_cache_uri_include_override | Gets the lists of regular expressions used to match the request URI part of the client requests during caching even if the cache object might be excluded for a reason other than being explicitly on the exclude list. (see section 5.1 of RFC2616). A match must be found in at least one of the “include override” fields as well as in the “include” fields to force caching of the object always. For example, to include requests ending in “.txt”, “.htm” and “.html”, one would use the following in the uri include field: “.txt” “.htm” “.html”. To cache filename.txt that would otherwise be excluded for being too large, one would use the following in the uri include override field: “filename.txt”. | BIG-IP_v11.0.0 |
| get_cache_uri_pinned | Gets the lists of cachable document URIs that will never be evicted from the cache. | 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 its attributes. | BIG-IP_v11.0.0 |
| get_description | Gets the descriptions for a set of web acceleration profiles. | BIG-IP_v11.0.0 |
| get_list | Gets a list of all web acceleration profiles. | BIG-IP_v11.0.0 |
| get_maximum_mtag_cache_size | Gets the maximum MTag cache sizes in megabytes for the given profiles when IBR or MultiConnect is enabled. | BIG-IP_v11.4.0 |
| get_statistics | Gets the statistics for the specified web acceleration 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_version | Gets the version information for this interface. | BIG-IP_v11.0.0 |
| is_base_profile | Determines whether the specified web acceleration 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 web acceleration 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_applications | Removes all applications attached to the web acceleration profiles. | BIG-IP_v11.0.0 |
| remove_application | Removes from the lists of applications attached to the web acceleration profiles. | BIG-IP_v11.0.0 |
| remove_cache_uri_exclude | 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 caching 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_cache_uri_include | 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_v11.0.0 |
| remove_cache_uri_include_override | Removes from the lists of regular expressions used to match the request URI part of the client requests during caching even if the cache object might be excluded for a reason other than being explicitly on the exclude list. (see section 5.1 of RFC2616). A match must be found in at least one of the “include override” fields as well as in the “include” fields to force caching of the object always. For example, to include requests ending in “.txt”, “.htm” and “.html”, one would use the following in the uri include field: “.txt” “.htm” “*.html”. To cache filename.txt that would otherwise be excluded for being too large, one would use the following in the uri include override field: “filename.txt”. | BIG-IP_v11.0.0 |
| remove_cache_uri_pinned | Removes from the lists of cachable document URIs that will never be evicted from the cache. | BIG-IP_v11.0.0 |
| reset_statistics | Resets the statistics for the specified web acceleration 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_cache_aging_rate | Sets the object aging rate for the cache. | BIG-IP_v11.0.0 |
| set_cache_ignore_client_cache_control_mode | Sets the mode to indicate whether to ignore the client cache control headers. | BIG-IP_v11.0.0 |
| set_cache_insert_age_header_state | Sets the state that indicates whether to insert the Age headers for the specified profiles. | BIG-IP_v11.0.0 |
| set_cache_maximum_age | Sets the maximum age for objects in the cache. | BIG-IP_v11.0.0 |
| set_cache_maximum_entries | Sets the maximum number of entries allowed in the cache. | BIG-IP_v11.0.0 |
| set_cache_object_maximum_size | Sets the maximum size requirement for objects in the cache. | BIG-IP_v11.0.0 |
| set_cache_object_minimum_size | Sets the minimum size requirement for objects in the cache. | BIG-IP_v11.0.0 |
| set_cache_size | Sets the size of the cache (in MB). | BIG-IP_v11.0.0 |
| set_default_application | Resets the attached application lists to parent defaults. | BIG-IP_v11.0.0 |
| set_default_cache_uri_exclude | Resets the URI exclude lists to parent defaults. | BIG-IP_v11.0.0 |
| set_default_cache_uri_include | Resets the URI include lists to the parent defaults. | BIG-IP_v11.0.0 |
| set_default_cache_uri_include_override | Resets the URI include override lists to the parent defaults. | BIG-IP_v11.0.0 |
| set_default_cache_uri_pinned | Resets the pinned URI 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 its attributes. | BIG-IP_v11.0.0 |
| set_description | Sets the description for a set of web acceleration profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_maximum_mtag_cache_size | Sets the maximum MTag cache sizes in megabytes for the given profiles when IBR or MultiConnect is enabled. | BIG-IP_v11.4.0 |
Structures¶
Structure
Description
A struct that describes a cache entry and related statistics.
A struct that describes a detailed cache entry and related statistics.
A struct that describes a key used to query/evict cache entries.
ProfileWebAccelerationStatisticEntry
A struct that describes statistics for a particular web acceleration profile.
ProfileWebAccelerationStatistics
A struct that describes profile statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| CacheVaryType | A list of types that indicate what type of content is cached. |
Aliases¶
| Alias | Type | Description |
| CacheEntryExactMatchSequence | CacheEntryExactMatch [] | A list of CacheEntryExactMatch structs. |
| CacheEntryExactMatchSequenceSequence | CacheEntryExactMatch [] [] | A sequence of sequence of CacheEntryExactMatch. |
| CacheEntrySequence | CacheEntry [] | A list of cacheEntries. |
| CacheEntrySequenceSequence | CacheEntry [] [] | A sequence of sequence of cacheEntries. |
| CacheKeySequence | CacheKey [] | A list of CacheKey structs. |
| CacheVaryTypeSequence | CacheVaryType [] | A sequence of cache vary types. |
| ProfileWebAccelerationStatisticEntrySequence | ProfileWebAccelerationStatisticEntry [] | A sequence of web acceleration 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.