slb template persist cookie¶
Cookie persistence
cookie Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name cookie-list Collection URI /axapi/v3/slb/template/persist/cookie Element Name cookie Element URI /axapi/v3/slb/template/persist/cookie/{name} Element Attributes cookie_attributes Partition Visibility shared Schema cookie schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/persist/cookie | ||
Create List | POST | /axapi/v3/slb/template/persist/cookie | ||
Get Object | GET | /axapi/v3/slb/template/persist/cookie/{name} | ||
Get List | GET | /axapi/v3/slb/template/persist/cookie | ||
Modify Object | POST | /axapi/v3/slb/template/persist/cookie/{name} | ||
Replace Object | PUT | /axapi/v3/slb/template/persist/cookie/{name} | ||
Replace List | PUT | /axapi/v3/slb/template/persist/cookie | ||
Delete Object | DELETE | /axapi/v3/slb/template/persist/cookie/{name} |
cookie-list¶
cookie-list is JSON List of cookie attributes
cookie-list : [
]
cookie attributes¶
cookie-name
Description Set cookie name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Default: sto-id
domain
Description Set cookie domain
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
dont-honor-conn-rules
Description Do not observe connection rate rules
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
encrypt-level
Description Encryption level for cookie name / value
Type: number
Range: 0-1
Default: 1
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)expire
Description Set cookie expiration time (Expiration in seconds)
Type: number
Range: 0-31536000
Default: 31536000
httponly
Description Enable HttpOnly attribute
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
insert-always
Description Insert persist cookie to every reponse
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-type
Description Persist for server, default is port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description Cookie persistence (Cookie persistence template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
pass-phrase
Description Set passphrase for encryption
Type: string
Format: password
Maximum Length: 8 characters
Maximum Length: 8 characters
Default: ACOS4KEY
pass-thru
Description Pass thru mode - Server sends the persist cookie
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
path
Description Set cookie path (Cookie path, default is “/”)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Default: /
prefix
Description ‘host’: the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; ‘secure’: the cookie will have been set with a Secure attribute;
Type: string
Supported Values: host, secure
samesite
Description ‘none’: none; ‘lax’: lax; ‘strict’: strict;
Type: string
Supported Values: none, lax, strict
scan-all-members
Description Persist within the same server SCAN
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
secure
Description Enable secure attribute
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server
Description Persist to the same server, default is port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: server and service-group are mutually exclusive
server-service-group
Description Persist to the same server and within the same service group
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
service-group
Description Persist within the same service group
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: service-group and server are mutually exclusive
use-attribute
Description ‘max-age’: Use the Max-Age attribute; ‘expires’: Use the Expires attribute; ‘all’: Use all attributes;
Type: string
Supported Values: max-age, expires, all
Default: expires
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters