Introduced : BIG-IP_v11.2.1
Sets the rate limit source masks of the specified virtual servers. The mask is applied against the source address when the mode specifies using the source address as part of the rate limiting categorization. Setting this value to &apos0&apos is the equivalent of using the entire IP address.


    in String [] virtual_servers,
    in long [] masks


Parameter Type Description
virtual_servers String [] A sequence of virtual servers to apply the rate limit source masks to.
masks long [] The rate limit source masks 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.