ApplicationPersistenceProfile

Description

API


    POST /api/applicationpersistenceprofile
    PUT /api/applicationpersistenceprofile/<key>
    DELETE /api/applicationpersistenceprofile/<key>
    GET /api/applicationpersistenceprofile
    GET /api/applicationpersistenceprofile/<key>

CLI


    configure applicationpersistenceprofile <key>
    show applicationpersistenceprofile <key>

Data

ApplicationPersistenceProfile

uuid

Type
string
Category
required
Description
UUID of the persistence profile.

name

Type
string
Category
required
Description
A user-friendly name for the persistence profile.

server_hm_down_recovery

Type
enum
Category
optional
Description
Specifies behavior when a persistent server has been marked down by a health monitor.
Default
HM_DOWN_PICK_NEW_SERVER
Choices
HM_DOWN_CONTINUE_PERSISTENT_SERVER, HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION

persistence_type

Type
enum
Category
required
Description
Method used to persist clients to the same server for a duration of time or a session.
Default
PERSISTENCE_TYPE_CLIENT_IP_ADDRESS
Choices
PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_TLS

ip_persistence_profile

Type
IPPersistenceProfile
Category
optional
Description
Specifies the Client IP Persistence profile parameters.

hdr_persistence_profile

Type
HdrPersistenceProfile
Category
optional
Description
Specifies the custom HTTP Header Persistence profile parameters.

app_cookie_persistence_profile

Type
AppCookiePersistenceProfile
Category
optional
Description
Specifies the Application Cookie Persistence profile parameters.

http_cookie_persistence_profile

Type
HttpCookiePersistenceProfile
Category
optional
Description
Specifies the HTTP Cookie Persistence profile parameters.

description

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description

IPPersistenceProfile

ip_persistent_timeout

Type
int32
Category
optional
Description
The length of time after a client's connections have closed before expiring the client's persistence to a server.
Default
5

HdrPersistenceProfile

prst_hdr_name

Type
string
Category
optional
Description
Header name for custom header persistence

AppCookiePersistenceProfile

prst_hdr_name

Type
string
Category
required
Description
Header or cookie name for application cookie persistence

timeout

Type
int32
Category
optional
Description
The length of time after a client's connections have closed before expiring the client's persistence to a server.
Default
20

encryption_key

Type
string
Category
optional
Description
Key to use for cookie encryption

HttpCookiePersistenceProfile

encryption_key

Type
string
Category
optional
Description
Key name to use for cookie encryption

cookie_name

Type
string
Category
optional
Description
HTTP cookie name for cookie persistence

key

Type
HttpCookiePersistenceKey
Category
repeated
Description

timeout

Type
int32
Category
optional
Description
The length of time after a client's connections have closed before expiring the client's persistence to a server. No value or 'zero' indicates no timeout.

always_send_cookie

Type
bool
Category
optional
Description
If no persistence cookie was received from the client, always send it.
Default
False

HttpCookiePersistenceKey

name

Type
string
Category
optional
Description
name to use for cookie encryption

aes_key

Type
Unknown
Category
optional
Description

hmac_key

Type
Unknown
Category
optional
Description

References

Tenant

Sub Objects