WebAccelerator::Applications¶
Introduced : BIG-IP_v10.0
Allows manipulation of applications.
Methods¶
| Method | Description | Introduced |
| add_host | Add to the list of hosts that may appear in HTTP requests for your application. An asterisk (*) may be used at the beginning of a host name to indicate a group or range of hosts with the same ending. | BIG-IP_v11.0.0 |
| create | This method is deprecated. Please use create_v2 instead. Create a new application. | BIG-IP_v10.0 |
| create_v2 | Create new applications. | BIG-IP_v11.0.0 |
| delete_all_applications | Deletes all applications. | BIG-IP_v11.0.0 |
| delete_application | Deletes a list of named applications. | BIG-IP_v10.0 |
| get_all_statistics | Gets the statistics for all applications. | BIG-IP_v11.0.0 |
| get_code | Gets the identifying codes for the given applications. | BIG-IP_v11.0.0 |
| get_content_expiration_time | Gets the content expiration time for the given applications. There is no complementary “set” function for this attribute as it should be expired using the invalidate_content function. | BIG-IP_v11.0.0 |
| get_description | Gets the description of the given applications. | BIG-IP_v11.0.0 |
| get_etag | Gets the ETag configuration for the given applications. See ETag for more information. | BIG-IP_v11.0.0 |
| get_host | Get the list of hosts that may appear in HTTP requests for your application. | BIG-IP_v11.0.0 |
| get_host_http_subdomain_count | Gets the number of HTTP subdomain prefixes allowed for the given hosts of the given applications. Example: if the requested host is http://www.example.com, and you have 2 HTTP subdomains enabled, then qualifying embedded links and URLs will be changed to use the following domains: http://wa1.www.example.com and http://wa2.www.example.com. | BIG-IP_v11.0.0 |
| get_host_https_subdomain_count | Gets the number of HTTPS subdomain prefixes allowed for the given hosts of the given applications. Example: if the requested host is https://www.example.com, and you have 2 HTTPS subdomains enabled, then qualifying embedded links and URLs will be changed to use the following domains: https://wa1.www.example.com and https://wa2.www.example.com. | BIG-IP_v11.0.0 |
| get_host_subdomain_prefixes | Gets the subdomain prefixes for the given hosts of the given applications. Example: if the requested host is www.example.com, and you have 2 HTTP subdomains enabled, then qualifying embedded links and URLs will be changed to use the following domains: wa1.www.example.com and wa2.www.example.com. | BIG-IP_v11.0.0 |
| get_ibr_default_lifetime | Gets the default lifetime of the IBR link or URL in seconds for the given applications. | BIG-IP_v11.0.0 |
| get_ibr_prefix | Gets the IBR prefix for the given applications. | BIG-IP_v11.0.0 |
| get_info_header | Gets the X-WA-Info header configuration for the given applications. See InfoHeader for more details. | BIG-IP_v11.0.0 |
| get_list | Get a list of all applications present on this WebAccelerator. | BIG-IP_v10.0 |
| get_local_policy | Gets the local policy for your applications. | BIG-IP_v11.0.0 |
| get_maximum_etag_cache_size | Gets the maximum ETag cache sizes in megabytes for the given applications when IBR or MultiConnect is enabled. | BIG-IP_v11.0.0 |
| get_performance_monitor_data_retention_period | Gets the amount of time in days that the data recorded by the performance monitor will be stored for each application. | BIG-IP_v11.0.0 |
| get_performance_monitor_state | Gets the state of the performance monitor for the given applications. | BIG-IP_v11.0.0 |
| get_remote_policy | Gets the remote policy for your applications. | BIG-IP_v11.0.0 |
| get_statistics | Gets the statistics for the specified applications. | BIG-IP_v11.0.0 |
| get_statistics_by_virtual | Gets the statistics for the given applications by the virtual server they are attached to through a web acceleration profile. | BIG-IP_v11.0.0 |
| get_unmapped_state | Gets the state that, if enabled, allows the application to process unmapped hosts. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v10.0 |
| invalidate_content | Invalidates all cached objects associated with a given application. This requires the WebAccelerator to re-request all objects for the application. | BIG-IP_v11.0.0 |
| is_predefined | Checks if the applications listed are predefined. If they are predefined, then they cannot be deleted in a call to delete_application. This setting cannot be changed by the user. | BIG-IP_v11.0.0 |
| remove_all_hosts | Remove all the hosts that may appear in HTTP requests for your application. | BIG-IP_v11.0.0 |
| remove_host | Remove the list of hosts that may appear in HTTP requests for your application. | BIG-IP_v11.0.0 |
| reset_statistics | Resets the statistics for the given applications. | BIG-IP_v11.0.0 |
| reset_statistics_by_virtual | Resets the statistics for the given applications by the virtual server they are attached to through a web acceleration profile. | BIG-IP_v11.0.0 |
| set_code | Sets the identifying codes for the given applications. The code must be numeric, nonzero, and unique. The code will be used for troubleshooting and performance reporting. | BIG-IP_v11.0.0 |
| set_description | Sets the description of the given applications. This will not change the behavior of the applications, but may be used to store notes on a given application. | BIG-IP_v11.0.0 |
| set_etag | Gets the ETag configuration for the given applications. See ETag for more information. | BIG-IP_v11.0.0 |
| set_host_http_subdomain_count | Sets the number of HTTP subdomain prefixes allowed for the given hosts of the given applications. Example: if the requested host is http://www.example.com, and you have 2 HTTP subdomains enabled, then qualifying embedded links and URLs will be changed to use the following domains: http://wa1.www.example.com and http://wa2.www.example.com. note: The subdomain prefix will be appended with a number for multiple prefixes. | BIG-IP_v11.0.0 |
| set_host_https_subdomain_count | Sets the number of HTTPS subdomain prefixes allowed for the given hosts of the given applications. Example: if the requested host is https://www.example.com, and you have 2 HTTPS subdomains enabled, then qualifying embedded links and URLs will be changed to use the following domains: https://wa1.www.example.com and https://wa2.www.example.com. | BIG-IP_v11.0.0 |
| set_host_subdomain_prefixes | Sets the subdomain prefixes for the given hosts of the given applications. Example: if the requested host is www.example.com, and you have 2 HTTP subdomains enabled, then qualifying embedded links and URLs will be changed to use the following domains: wa1.www.example.com and wa2.www.example.com. | BIG-IP_v11.0.0 |
| set_ibr_default_lifetime | Sets the lifetime of the IBR link or URL in seconds for the given applications. | BIG-IP_v11.0.0 |
| set_ibr_prefix | Sets the IBR prefix for the given applications. These are the characters prepended to the hash of the URL referenced in the web page. If the object referenced in the URL changes, then the hash of the object will also change. This will force downstream clients to request fresh copies of the objects cached. | BIG-IP_v11.0.0 |
| set_info_header | Sets the X-WA-Info header configuration for the given applications. See InfoHeader for more details. | BIG-IP_v11.0.0 |
| set_local_policy | Sets the local policy for your applications. In order to get the precise names to use for the policies, use the get_list method from the WebAccelerator::Policies module. | BIG-IP_v11.0.0 |
| set_maximum_etag_cache_size | Sets the maximum ETag cache sizes in megabytes for the given applications when IBR or MultiConnect is enabled. | BIG-IP_v11.0.0 |
| set_performance_monitor_data_retention_period | Sets the amount of time in days that the data recorded by the performance monitor will be stored by each application. | BIG-IP_v11.0.0 |
| set_performance_monitor_state | Sets the state of the performance monitor for the given applications. If performance monitoring is enabled for many applications, then overall performance of the WebAccelerator system may be affected. | BIG-IP_v11.0.0 |
| set_remote_policy | Sets the remote policy for your applications. This option is applicable only if you have a symmetric deployment configured. We recommend that you use the predefined acceleration policy, Symmetric Deployment, if you have configured an optional symmetric deployment. In order to get the precise names to use for the policies, use the get_list method from the WebAccelerator::Policies module. | BIG-IP_v11.0.0 |
| set_unmapped_state | Sets the state that, if enabled, allows the application to process unmapped hosts. Do not enable the unmapped hosts setting unless you understand the security implications. Refer to the WebAccelerator documentation for more details. | BIG-IP_v11.0.0 |
Structures¶
Structure
Description
A struct that describes statistics for a particular application.
A struct that describes application statistics and timestamp.
ApplicationStatisticsByVirtual
A struct that describes application statistics by virtual and a timestamp.
Enumerations¶
| Enumeration | Description |
| ETag | This setting determines whether and how the WebAccelerator system performs ETag caching for responses. The WebAccelerator system&aposs Policies cache ETag responses with Intelligent Browser Referencing (IBR) or MultiConnect enabled in the matching node. Cached content includes the request URL, content signature of the response body, application name for the matching request, and metadata this includes the expiration time, read time, and update time for content. |
| InfoHeader | This setting determines if and what type of X-WA-Info headers will be added to an HTTP response served. The info header will be of the form: X-WA-Info: [S10101.C99998.A7820.RA0.U0].[OT/html.OG/pages]. This header can be translated into user readable format using the wainfodecode utility from the command line interface on the BIG-IP. To use this utility run wainfodecode “[S10101.C99998.A7820.RA0.U0].[OT/html.OG/pages]”. |
Aliases¶
| Alias | Type | Description |
| ApplicationStatisticEntrySequence | ApplicationStatisticEntry [] | A sequence of application statistics. |
| ETagSequence | ETag [] | A sequence of ETag configurations. |
| InfoHeaderSequence | InfoHeader [] | A sequence of info header types. |
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.