APIRef_tm_ltm_persistence_hash¶

mgmt/tm/ltm/persistence/hash

Virtual server Hash persistence profile configuration

REST Endpoints

Collection URI: /mgmt/tm/ltm/persistence/hash
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/ltm/persistence/hash/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key: name, partition, subPath

Properties

Name	Type	Default Value	Required	Access	Description
`appService`	string		optional	read/write	The application service to which the object belongs.
`defaultsFrom`	string		optional	read/write	Specifies the existing profile from which the system imports settings for the new profile.
`description`	string		optional	read/write	User defined description.
`hashAlgorithm`	string	default	optional	read/write	Specifies the algorithm the system uses for hash persistence load balancing. The hash result is the input for the algorithm. The default value is default. carp specifies to use the Cache Array Routing Protocol (CARP) to obtain the hash result for the input to the algorithm. default specifies to use the index of pool members to obtain the hash result for the input to the algorithm.
`hashBufferLimit`	integer	0	optional	read/write	Specifies the maximum buffer length the system collects to locate the hashing pattern for hash persistence load balancing. The default value is 0.
`hashEndPattern`	string		optional	read/write	Specifies the string that describes the ending location of the hash pattern that the system uses to perform hash persistence load balancing. The default value is none.
`hashLength`	integer	0	optional	read/write	Specifies the length of data within the packet in bytes that the system uses to calculate the hash value when performing hash persistence load balancing. The default value is 0 bytes.
`hashOffset`	integer	0	optional	read/write	Specifies the start offset within the packet from which the system begins the hash when performing hash persistence load balancing. The default value is 0.
`hashStartPattern`	string		optional	read/write	Specifies the string that describes the start location of the hash pattern that the system uses to perform hash persistence load balancing. The default value is none.
`matchAcrossPools`	string	disabled	optional	read/write	Specifies, when enabled, that the system can use any pool that contains this persistence record. The default value is disabled.
`matchAcrossServices`	string	disabled	optional	read/write	Specifies, when enabled, that all persistent connections from a client IP address, which go to the same virtual IP address, also go to the same node. The default value is disabled.
`matchAcrossVirtuals`	string	disabled	optional	read/write	Specifies, when enabled, that all persistent connections from the same client IP address go to the same node. The default value is disabled.
`mirror`	string	disabled	optional	read/write	Specifies whether the system mirrors persistence records to the high-availability peer. The default value is disabled.
`mode`	string		optional	read/write
`overrideConnectionLimit`	string	disabled	optional	read/write	Specifies, when enabled, that the pool member connection limits are not enforced for persisted clients. Per-virtual connection limits remain hard limits and are not disabled. The default value is disabled.
`tmPartition`	string	Common	optional	read/write	Displays the administrative partition within which the profile resides.
`rule`	string		optional	read/write	Specifies a rule name if you are using a rule for universal persistence.
`timeout`	string	180	optional	read/write	Specifies the duration of the persistence entries. The default value is 180 seconds.

iControl Reference Index

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.