Introduced : BIG-IP_v11.1.0
Sets the sampling ratio for analytics. Specifies that every sampling-ratio transaction is sampled. Setting this attribute mainly affects performance - A high sampling ratio can improve analytics performance, but will also lower analytics accuracy. Note: the sampling ratio attribute can currently be set only for the analytics system profile.


    in String [] profile_names,
    in LocalLB__ProfileULong [] ratios


Parameter Type Description
profile_names String [] The names of the analytics profiles.
ratios ProfileULong [] The sampling ratios to set for each profile.

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.