Introduced : BIG-IP_v12.0.0
Sets the metric limits for the specified terminal members of the specified pools. The metric limits let users configure the allowed metric maximums for virtual servers that back the given terminal pool members. If the allowed maximum for a given (enabled) limit is exceeded for a pool member, that pool member becomes unavailable until the virtual server backing it reports metrics that are less than the allowed maximums. Three types of limits can be set. These are the data throughput rate (in bits per second), the number of current connections, and the data transfer rate (in packets per second). The metric limits also allow the user to toggle the enforcement of these numerical limits between enabled and disabled. By default all three types of limits are disabled.


    in GlobalLB__PoolID [] pools,
    in GlobalLB__VirtualServerID [] [] members,
    in GlobalLB__MetricLimit [] [] [] limits


Parameter Type Description
pools PoolID [] The list of pools to which the specified terminal members belong.
members VirtualServerID [] [] Terminal members of each specified pool to modify.
limits MetricLimit [] [] [] Metric limits for each specified terminal member of each specified pool.

Return Type

Type Description


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.