Introduced : BIG-IP_v11.4.0
Sets the volume threshold, in total octets, for the specified rules. The report is generated if the amount of total octets exceeds the threshold. The default value is 0 which indicates this feature is disabled. If the reporting destination is set, at least one of the following reporting properties must be set to non-zero: octets uplink, octets downlink, total octets (sum of the previous two), and/or interval. If any one of these thresholds is met, the report will be generated. If multiple thresholds are met, reports will be generated for all of them. For example, if interval is set to 5 seconds, octets uplink volume threshold is set to 8, and total octets volume threshold is set to 10, then reports will be generated every 5 seconds, when octets uplink reach 8, and when total octets reach 10.


    in String [] policies,
    in String [] [] rules,
    in long [] [] thresholds


Parameter Type Description
policies String [] The names of the policies.
rules String [] [] The rules for the specified policies.
thresholds long [] []  

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.