ApplicationPersistenceProfile

ApplicationPersistenceProfile
ApplicationPersistenceProfile
JSON Example
{
    "_last_modified": "string",
    "app_cookie_persistence_profile": {
        "encryption_key": "string",
        "prst_hdr_name": "string",
        "timeout": 0
    },
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "hdr_persistence_profile": {
        "prst_hdr_name": "string"
    },
    "http_cookie_persistence_profile": {
        "always_send_cookie": false,
        "cookie_name": "string",
        "encryption_key": "string",
        "http_only": false,
        "is_persistent_cookie": false,
        "key": [
            {
                "aes_key": "string",
                "hmac_key": "string",
                "name": "string"
            }
        ],
        "timeout": 0
    },
    "ip_persistence_profile": {
        "ip_mask": 0,
        "ip_persistent_timeout": 0
    },
    "is_federated": false,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "persistence_type": "string",
    "server_hm_down_recovery": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

app_cookie_persistence_profile
Optional

app_cookie_persistence_profile

configpb_attributes
Optional

configpb_attributes

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

hdr_persistence_profile
Optional

hdr_persistence_profile

http_cookie_persistence_profile
Optional

http_cookie_persistence_profile

ip_persistence_profile
Optional

ip_persistence_profile

boolean
is_federated
Optional

This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

A user-friendly name for the persistence profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
persistence_type
Required
Constraints: default: PERSISTENCE_TYPE_CLIENT_IP_ADDRESS

Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE), Basic edition(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE), Enterprise with Cloud Services edition.

string
server_hm_down_recovery
Optional
Constraints: default: HM_DOWN_PICK_NEW_SERVER

Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- HM_DOWN_PICK_NEW_SERVER), Basic edition(Allowed values- HM_DOWN_PICK_NEW_SERVER), Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the persistence profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.