conf/persistence
The conf/persistence directory contains configuration files for persistence classes. The name of a file is the name of the persistence class it defines. Persistence classes can be configured under the Catalogs > Persistence section of the Admin Server UI or by using functions under the Catalog.Persistence section of the SOAP API and CLI.
Key | Description |
|---|---|
delete | Whether or not the session should be deleted when a session failure occurs. (Note, setting a failure mode of 'choose a new node' implicitly deletes the session.) Value type: Yes / No Default value: "Yes" |
failuremode | The action the pool should take if the session data is invalid or it cannot contact the node specified by the session. Value type: enumeration Default value: "newnode" Permitted values: newnode: Choose a new node to use url: Redirect the user to a given URL close: Close the connection (using error_file on Virtual Servers > Edit > Protocol Settings) |
note | A description of the session persistence class. Value type: string Default value: <none> |
type | The type of session persistence to use. Value type: enumeration Default value: "ip" Permitted values: ip: IP-based persistence universal: Universal session persistence named: Named Node session persistence sardine: Transparent session affinity kipper: Monitor application cookies j2ee: J2EE session persistence asp: ASP and ASP.NET session persistence x-zeus: X-Zeus-Backend cookies ssl: SSL Session ID persistence |
url | The redirect URL to send clients to if the session persistence is configured to redirect users when a node dies. Requires: failuremode is set to "url" (case insensitive) Value type: string Default value: <none> |
Additional keys used when type is "ip" | |
subnet_prefix_length_v4 | When using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node. If set to 0, requests from different IPv4 addresses will be load-balanced individually. Requires: type is set to "ip" Value type: int Default value: "0" |
subnet_prefix_length_v6 | When using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node. If set to 0, requests from different IPv6 addresses will be load-balanced individually. Requires: type is set to "ip" Value type: int Default value: "0" |
Additional keys used when type is "kipper" | |
cookie | The cookie name to use for tracking session persistence. Requires: type is set to "kipper" Value type: string Default value: <none> |
Additional keys used when type is "sardine" | |
transparent_always_set_cookie | Whether or not the cookie should be inserted in every response sent to the client when using transparent session affinity. If set to <span>No then the cookie is inserted only if the corresponding request did not already contain a matching cookie. Requires: type is set to "sardine" Value type: Yes / No Default value: "No" |
transparent_directives | The cookie directives to include in the cookie sent when using transparent session affinity. If more than one directive is included, the semi-colon separator between them must be included in this string. The semi-colon separator between the cookie value and the first directive should not be included in this string. Requires: type is set to "sardine" Value type: string Default value: <none> |