LocalLB::ProfileICAP¶
Introduced : BIG-IP_v11.3.0
The ProfileICAP interface enables you to manipulate a local load
balancer&aposs ICAP (Internet Content Adaptation Protocol) profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified ICAP profiles. | BIG-IP_v11.3.0 |
| delete_all_profiles | Deletes all ICAP profiles. | BIG-IP_v11.3.0 |
| delete_profile | Deletes the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_all_statistics | Gets the statistics for all ICAP profiles. | BIG-IP_v11.3.0 |
| get_default_profile | Gets the names of the default profiles from which the specified profiles will derive default values for attributes. | BIG-IP_v11.3.0 |
| get_description | Gets the descriptions for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_header_from | Gets the header from attribute for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_host | Gets the host for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_list | Gets a list of all ICAP profiles. | BIG-IP_v11.3.0 |
| get_preview_length | Gets the preview length for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_referer | Gets the referer for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_statistics | Gets the statistics for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_statistics_by_virtual | Gets the statistics for the specified ICAP profiles, by virtual server. | BIG-IP_v11.3.0 |
| get_uri | Gets the URI for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_user_agent | Gets the user agent for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.3.0 |
| is_base_profile | Determines whether the specified ICAP 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.3.0 |
| is_system_profile | Determines whether the specified ICAP 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.3.0 |
| reset_statistics | Resets the statistics for the specified ICAP profiles. | BIG-IP_v11.3.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified ICAP profiles, for specified virtual servers. | BIG-IP_v11.3.0 |
| set_default_profile | Sets the names of the default profiles from which the specified profiles will derive default values for attributes. | BIG-IP_v11.3.0 |
| set_description | Sets the description for the specified ICAP profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_header_from | Sets the header from attribute for the specified ICAP profiles. Indicates the email address for the user who controls the requesting user agent and is used for identifying the source of invalid or unwanted requests. Please refer to RFC 3507 section 4.3.2. | BIG-IP_v11.3.0 |
| set_host | Sets the host for the specified ICAP profiles. Specifies the host attribute to use in the ICAP header. Please refer to RFC 3507 section 4.3.2. | BIG-IP_v11.3.0 |
| set_preview_length | Sets the preview length for the specified ICAP profiles. The preview length attribute specifies the number of bytes of the http payload to be sent to the ICAP server as a preview of the http message. Upon sending the preview, the ICAP client will wait for the ICAP server either to request the remainder of the HTTP payload or report that it does not wish to modify the HTTP request or response. Please refer to RFC 3507 section 4.5. | BIG-IP_v11.3.0 |
| set_referer | Sets the referer for the specified ICAP profiles. Indicates the address (URI) of the resource from which the Request-URI was obtained by the client for the server&aposs benefit. Please refer to RFC 3507 section 4.3.2. | BIG-IP_v11.3.0 |
| set_uri | Sets the URI for the specified ICAP profiles. Indicates the ICAP resource being requested from the server for the ICAP request. Please refer to RFC 3507 section 4.2. Macro expansion has been implemented for all attribute values in the ICAP header. If an ICAP header attribute value contains ${SERVER_IP}, the macro will be replaced with the IP address of the ICAP server selected from the internal virtual server&aposs pool. If an ICAP header attribute contains ${SERVER_PORT}, the macro will be replaced with the port of the ICAP server selected from the internal virtual server&aposs pool. For example, the URI attribute in an ICAP profile could be set to icap://${SERVER_IP}:${SERVER_PORT}/videoOptimization. | BIG-IP_v11.3.0 |
| set_user_agent | Sets the user agent for the specified ICAP profiles. Indicates the information about the user agent originating the request and is used for the tracing of protocol violations and statistical purposes. Please refer to RFC 3507 section 4.3.2. | BIG-IP_v11.3.0 |
Structures¶
Structure
Description
A struct that describes statistics for a particular profile.
A struct that describes ICAP profile statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| ICAPProfileStatisticEntrySequence | ICAPProfileStatisticEntry [] | A sequence of ICAP 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.
