LocalLB::RateClass::get_ceiling_rate_v2

Introduced : BIG-IP_v12.1.0
Gets the ceiling rates for the specified rate classes. The ceiling rate specifies how far beyond the base rate the traffic is allowed to flow when bursting. The ceiling rate is an absolute limit - it is impossible for traffic to flow at a higher rate than the ceiling rate, even when bursting. If the ceiling rate is omitted or is equal to the base rate, the traffic may not exceed the base rate. It is illegal for the ceiling rate to be less than the base rate.

Prototype

RateUnitV2 [] get_ceiling_rate_v2(
    in String [] rate_classes
);

Parameters

Parameter Type Description
rate_classes String [] The names of the rate classes.

Return Type

Type Description
RateUnitV2 [] The ceiling rates of the specified rate classes.

Exceptions

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

iControl ::
iControl :: LocalLB :: RateClass

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.