APIRef_tm_ltm_persistence_cookie¶

mgmt/tm/ltm/persistence/cookie

Virtual server Cookie persistence profile

REST Endpoints

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

Properties

Name	Type	Default Value	Required	Access	Description
`alwaysSend`	string	disabled	optional	read/write	Specifies, when enabled, that the cookie persistence entry will be sent to the client on every response, rather than only on the first response. The default value is disabled.
`appService`	string		optional	read/write	The application service to which the object belongs.
`cookieEncryption`	string	disabled	optional	read/write	Specifies the way in which cookie format will be used: “disabled”: generate old format,unencrypted, “preferred”: generate encrypted cookie but accept both encrypted and old format, and “required”: cookie format must be encrypted. Default is required.
`cookieEncryptionPassphrase`	string		optional	read/write	Specifies a passphrase to be used for cookie encryption.
`cookieName`	string		optional	read/write	Specifies a unique name for the profile.
`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.
`expiration`	string	0	optional	read/write	Specifies the cookie expiration date in the format d:h:m:s, h:m:s, m:s or seconds. Hours 0-23, minutes 0-59, seconds 0-59. The time period must be less than 24856 days. You can use “session-cookie” (0 seconds) to indicate that the cookie expires when the browser closes.
`hashLength`	integer	0	optional	read/write	Specifies the cookie hash length. The length is the number of bytes to use when calculating the hash value. The default value is 0 bytes.
`hashOffset`	integer	0	optional	read/write	Specifies the cookie hash offset. The offset is the number of bytes in the cookie to skip before calculating the hash value. The default value is 0 bytes.
`httponly`	string	enabled	optional	read/write	Specifies whether the httponly attribute should be enabled or disabled for the inserted cookies. The default value is enabled.
`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.
`method`	string		optional	read/write	Specifies the type of cookie processing that the system uses. The default value is insert.
`mirror`	string	disabled	optional	read/write	Specifies whether the system mirrors persistence records to the high-availability peer. This option is applicable only when the value of the method option is hash. 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.
`secure`	string	enabled	optional	read/write	Specifies whether the secure attribute should be enabled or disabled for the inserted cookies. The default value is enabled.
`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.