---
title: Catalog.Persistence
slug: ps/help/en_us/vtm/controlapi/catalogpersistence
docTags: 
createdAt: 2026-08-02T08:52:21.968Z
---

URI: http\://soap.zeus.com/zxtm/1.0/Catalog/Persistence/

The Catalog.Persistence interface allows management of Persistence classes. Using this interface, you can create, delete and rename persistence classes, and manage their configuration.

### Methods

### addPersistence( class\_names ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError

Add new persistence classes.

```bash
void addPersistence(
String[] class_names
)
```

### copyPersistence( class\_names, new\_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError

Copy the named persistence classes.

```bash
void copyPersistence(
String[] class_names
String[] new_names
)
```

### deletePersistence( class\_names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError

Delete the named persistence classes.

```bash
void deletePersistence(
String[] class_names
)
```

### getCookie( class\_names ) throws ObjectDoesNotExist

Get the name of the cookie used to track session persistence.

```bash
String[] getCookie(
String[] class_names
)
```

### getCookieByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the name of the cookie used to track session persistence. This is a location specific function, any action will operate on the specified location.

```bash
String[] getCookieByLocation(
String location
String[] class_names
)
```

### getDelete( class\_names ) throws ObjectDoesNotExist

Get whether the session should be deleted if a failure occurs.

```bash
Boolean[] getDelete(
String[] class_names
)
```

### getDeleteByLocation( location, class\_names ) throws ObjectDoesNotExist

Get whether the session should be deleted if a failure occurs. This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getDeleteByLocation(
String location
String[] class_names
)
```

### getFailureMode( class\_names ) throws ObjectDoesNotExist

Get the action that should be taken if the session data is invalid or the node specified cannot be contacted.

```bash
Catalog.Persistence.FailureMode[] getFailureMode(
String[] class_names
)
```

### getFailureModeByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the action that should be taken if the session data is invalid or the node specified cannot be contacted. This is a location specific function, any action will operate on the specified location.

```bash
Catalog.Persistence.FailureMode[] getFailureModeByLocation(
String location
String[] class_names
)
```

### getNote( class\_names ) throws ObjectDoesNotExist

Get the note for each of the named Session Persistence classes.

```bash
String[] getNote(
String[] class_names
)
```

### getPersistenceNames()

Get the names of all the configured persistence classes.

```bash
String[] getPersistenceNames()
```

### getSubnetPrefixLengthV4( class\_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node.

```bash
Integer[] getSubnetPrefixLengthV4(
String[] class_names
)
```

### getSubnetPrefixLengthV4ByLocation( location, class\_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

```bash
Integer[] getSubnetPrefixLengthV4ByLocation(
String location
String[] class_names
)
```

### getSubnetPrefixLengthV6( class\_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node.

```bash
Integer[] getSubnetPrefixLengthV6(
String[] class_names
)
```

### getSubnetPrefixLengthV6ByLocation( location, class\_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

```bash
Integer[] getSubnetPrefixLengthV6ByLocation(
String location
String[] class_names
)
```

### getTransparentAlwaysSetCookie( class\_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, whether or not to insert the cookie in every response

```bash
Boolean[] getTransparentAlwaysSetCookie(
String[] class_names
)
```

### getTransparentAlwaysSetCookieByLocation( location, class\_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, whether or not to insert the cookie in every response This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getTransparentAlwaysSetCookieByLocation(
String location
String[] class_names
)
```

### getTransparentDirectives( class\_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, the directives to include when the cookie is sent

```bash
String[] getTransparentDirectives(
String[] class_names
)
```

### getTransparentDirectivesByLocation( location, class\_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, the directives to include when the cookie is sent This is a location specific function, any action will operate on the specified location.

```bash
String[] getTransparentDirectivesByLocation(
String location
String[] class_names
)
```

### getType( class\_names ) throws ObjectDoesNotExist

Gets the session method type.

```bash
Catalog.Persistence.Type[] getType(
String[] class_names
)
```

### getTypeByLocation( location, class\_names ) throws ObjectDoesNotExist

Gets the session method type. This is a location specific function, any action will operate on the specified location.

```bash
Catalog.Persistence.Type[] getTypeByLocation(
String location
String[] class_names
)
```

### getUrl( class\_names ) throws ObjectDoesNotExist

Get the URL to send to clients if the session persistence is configured to redirect users when a node dies.

```bash
String[] getUrl(
String[] class_names
)
```

### getUrlByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the URL to send to clients if the session persistence is configured to redirect users when a node dies. This is a location specific function, any action will operate on the specified location.

```bash
String[] getUrlByLocation(
String location
String[] class_names
)
```

### renamePersistence( class\_names, new\_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidOperation

Rename the named persistence classes.

```bash
void renamePersistence(
String[] class_names
String[] new_names
)
```

### setCookie( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the name of the cookie used to track session persistence.

```bash
void setCookie(
String[] class_names
String[] values
)
```

### setCookieByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the name of the cookie used to track session persistence. This is a location specific function, any action will operate on the specified location.

```bash
void setCookieByLocation(
String location
String[] class_names
String[] values
)
```

### setDelete( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set whether the session should be deleted if a failure occurs.

```bash
void setDelete(
String[] class_names
Boolean[] values
)
```

### setDeleteByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set whether the session should be deleted if a failure occurs. This is a location specific function, any action will operate on the specified location.

```bash
void setDeleteByLocation(
String location
String[] class_names
Boolean[] values
)
```

### setFailureMode( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the action that should be taken if the session data is invalid or the node specified cannot be contacted.

```bash
void setFailureMode(
String[] class_names
Catalog.Persistence.FailureMode[] values
)
```

### setFailureModeByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the action that should be taken if the session data is invalid or the node specified cannot be contacted. This is a location specific function, any action will operate on the specified location.

```bash
void setFailureModeByLocation(
String location
String[] class_names
Catalog.Persistence.FailureMode[] values
)
```

### setNote( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the note for each of the named Session Persistence classes.

```bash
void setNote(
String[] class_names
String[] values
)
```

### setSubnetPrefixLengthV4( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node.

```bash
void setSubnetPrefixLengthV4(
String[] class_names
Integer[] values
)
```

### setSubnetPrefixLengthV4ByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

```bash
void setSubnetPrefixLengthV4ByLocation(
String location
String[] class_names
Integer[] values
)
```

### setSubnetPrefixLengthV6( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node.

```bash
void setSubnetPrefixLengthV6(
String[] class_names
Integer[] values
)
```

### setSubnetPrefixLengthV6ByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

```bash
void setSubnetPrefixLengthV6ByLocation(
String location
String[] class_names
Integer[] values
)
```

### setTransparentAlwaysSetCookie( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, whether or not to insert the cookie in every response

```bash
void setTransparentAlwaysSetCookie(
String[] class_names
Boolean[] values
)
```

### setTransparentAlwaysSetCookieByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, whether or not to insert the cookie in every response This is a location specific function, any action will operate on the specified location.

```bash
void setTransparentAlwaysSetCookieByLocation(
String location
String[] class_names
Boolean[] values
)
```

### setTransparentDirectives( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, the directives to include when the cookie is sent

```bash
void setTransparentDirectives(
String[] class_names
String[] values
)
```

### setTransparentDirectivesByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, the directives to include when the cookie is sent This is a location specific function, any action will operate on the specified location.

```bash
void setTransparentDirectivesByLocation(
String location
String[] class_names
String[] values
)
```

### setType( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Sets the session method type.

```bash
void setType(
String[] class_names
Catalog.Persistence.Type[] values
)
```

### setTypeByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Sets the session method type. This is a location specific function, any action will operate on the specified location.

```bash
void setTypeByLocation(
String location
String[] class_names
Catalog.Persistence.Type[] values
)
```

### setUrl( class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the URL to send to clients if the session persistence is configured to redirect users when a node dies.

```bash
void setUrl(
String[] class_names
String[] values
)
```

### setUrlByLocation( location, class\_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the URL to send to clients if the session persistence is configured to redirect users when a node dies. This is a location specific function, any action will operate on the specified location.

```bash
void setUrlByLocation(
String location
String[] class_names
String[] values
)
```

### Enumerations

### Catalog.Persistence.FailureMode

```bash
enum Catalog.Persistence.FailureMode {
# Choose a new node to use
newnode,
# Redirect the user to a given URL
url,
# Close the connection (using error_file on Virtual Servers > Edit > Protocol
# Settings)
close
}
```

### Catalog.Persistence.Type

```bash
enum Catalog.Persistence.Type {
# IP-based persistence
ip,
# Universal session persistence
universal,
# Named Node session persistence
named,
# Transparent session affinity
transparent,
# Monitor application cookies
monitor-cookies,
# J2EE session persistence
j2ee,
# ASP and ASP.NET session persistence
asp,
# X-Zeus-Backend cookies
x-zeus,
# SSL Session ID persistence
ssl,
# Deprecated. Use 'monitor-cookies' instead.
kipper,
# Deprecated. Use 'transparent' instead.
sardine
}
```