{
"additionalProperties": false,
"extends": {
"$ref": "LbPersistenceProfile
},
"id": "LbCookiePersistenceProfile",
"module_id": "LoadBalancer",
"polymorphic-type-descriptor": {
"type-identifier": "LbCookiePersistenceProfile"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"cookie_domain": {
"description": "HTTP cookie domain could be configured, only available for insert mode.",
"required": false,
"title": "cookie domain",
"type": "string"
},
"cookie_fallback": {
"default": true,
"description": "If fallback is true, once the cookie points to a server that is down (i.e. admin state DISABLED or healthcheck state is DOWN), then a new server is selected by default to handle that request. If fallback is false, it will cause the request to be rejected if cookie points to a server",
"required": false,
"title": "cookie persistence fallback",
"type": "boolean"
},
"cookie_garble": {
"default": true,
"description": "If garble is set to true, cookie value (server IP and port) would be encrypted. If garble is set to false, cookie value would be plain text.",
"required": false,
"title": "cookie persistence garble",
"type": "boolean"
},
"cookie_httponly": {
"default": false,
"description": "If cookie httponly flag is true, it prevents a script running in the browser from accessing the cookie. Only available for insert mode.",
"required": false,
"title": "Cookie httponly flag",
"type": "boolean"
},
"cookie_mode": {
"$ref": "CookiePersistenceModeType,
"default": "INSERT",
"required": false,
"title": "cookie persistence mode"
},
"cookie_name": {
"required": true,
"title": "cookie name",
"type": "string"
},
"cookie_path": {
"description": "HTTP cookie path could be set, only available for insert mode.",
"required": false,
"title": "cookie path",
"type": "string"
},
"cookie_secure": {
"default": false,
"description": "If cookie secure flag is true, it prevents the browser from sending a cookie over http. The cookie is sent only over https. Only available for insert mode.",
"required": false,
"title": "Cookie secure flag",
"type": "boolean"
},
"cookie_time": {
"$ref": "LbCookieTime,
"description": "Both session cookie and persistence cookie are supported, if not specified, it's a session cookie. It expires when the browser is closed.",
"required": false,
"title": "cookie time setting"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"persistence_shared": {
"default": false,
"description": "The persistence shared flag identifies whether the persistence table is shared among virtual-servers referring this profile. If persistence shared flag is not set in the cookie persistence profile bound to a virtual server, it defaults to cookie persistence that is private to each virtual server and is qualified by the pool. This is accomplished by load balancer inserting a cookie with name in the format <name>.<virtual_server_id>.<pool_id>. If persistence shared flag is set in the cookie persistence profile, in cookie insert mode, cookie persistence could be shared across multiple virtual servers that are bound to the same pools. The cookie name would be changed to <name>.<profile-id>.<pool-id>. If persistence shared flag is not set in the sourceIp persistence profile bound to a virtual server, each virtual server that the profile is bound to maintains its own private persistence table. If persistence shared flag is set in the sourceIp persistence profile, all virtual servers the profile is bound to share the same persistence table. If persistence shared flag is not set in the generic persistence profile, the persistence entries are matched and stored in the table which is identified using both virtual server ID and profile ID. If persistence shared flag is set in the generic persistence profile, the persistence entries are matched and stored in the table which is identified using profile ID. It means that virtual servers which consume the same profile in the LbRule with this flag enabled are sharing the same persistence table.",
"required": false,
"title": "Persistence shared flag",
"type": "boolean"
},
"resource_type": {
"$ref": "PersistenceProfileType,
"description": "The resource_type property identifies persistence profile type.",
"required": true,
"title": "Persistence profile type"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"search_dsl_name": [
"lb cookie persistence profile (manager)"
],
"type": "object"
}