Introduced : BIG-IP_v10.1.0
Sets the length of payload data whose hashed value is used for the persistence value for a set of persistence profiles. The start of the data is specified via set_hash_offset. The hash payload data is either delimited by this offset and length or the starting and ending string pattern, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.


    in String [] profile_names,
    in LocalLB__ProfileULong [] lengths


Parameter Type Description
profile_names String [] Names of the persistence profiles to modify
lengths ProfileULong [] Hashed payload data length (bytes) for each specified persistence profile (default: 0). If zero, the hashed payload data is not specified by an offset and length.

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.