Introduced : BIG-IP_v11.2.1
Sets the rate limit modes of the specified virtual servers. Indicates whether the rate limit is applied per virtual object, per source address, per destination address, or some combination thereof. The default value is &aposRATE_LIMIT_MODE_OBJECT&apos, which does not use the source or destination address as part of the key.


    in String [] virtual_servers,
    in RateLimitMode [] modes


Parameter Type Description
virtual_servers String [] A sequence of virtual servers to apply the rate limits to.
modes RateLimitMode [] The rate limit modes for the specified virtual servers.

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.