Introduced : BIG-IP_v9.4.0
Gets the states that if true, use the route-metrics cache in order to jump-start congestion-control parameters. When this parameter is disabled, the system slow-starts to the peer every time (assuming, of course, that slow-start is enabled), resulting in a much more conservative ramp-up in bandwidth utilization. This may be required in cases where an intermediate device is NATing multiple distinct clients to the same IP address, yet each of these hosts has distinctly different bandwidth and jitter parameters. It may also be required when the link is heavily oversubscribed and dropping packets due to overdriving.


ProfileEnabledState [] get_cmetrics_cache_state(
    in String [] profile_names


Parameter Type Description
profile_names String [] The names of the TCP profiles.

Return Type

Type Description
ProfileEnabledState [] Returns the states for the specified TCP profiles.


Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also


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.