.. _slb_template_persist:

slb template persist
====================

Persistence


persist Specification
---------------------

	===================================== =============================================================
	 **Parameter**                         **Value** 

	===================================== =============================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      persist

	 **Element URI**                       /axapi/v3/slb/template/persist

	 **Element Attributes**                persist_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`persist schema <slb-template-persist/slb-template-persist.txt>`
	===================================== =============================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/template/persist



.. raw:: html

   </td><td valign = 'top'>


persist_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _3014_persist_attributes:

persist attributes
------------------

    **cookie-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/persist/cookie/{name} <slb_template_persist_cookie>`

    **destination-ip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/persist/destination-ip/{name} <slb_template_persist_destination_ip>`

    **source-ip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip/{name} <slb_template_persist_source_ip>`

    **ssl-sid-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/persist/ssl-sid/{name} <slb_template_persist_ssl_sid>`

.. _3014_destination-ip-list:

destination-ip-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **dont-honor-conn-rules**

        **Description** Do not observe connection rate rules

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **hash-persist**

        **Description** Use hash value of destination IP address

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **match-type**

        **Description** Persistence type

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **name**

        **Description** Destination IP persistence template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **netmask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

        **Default:** 255.255.255.255

    **netmask6**

        **Description** IPV6 subnet mask

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **scan-all-members**

        **Description** Persist with SCAN of all members

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **server**

        **Description** Persist to the same server, default is port

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** server and service-group are mutually exclusive

    **service-group**

        **Description** Persist within the same service group

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** service-group and server are mutually exclusive

    **timeout**

        **Description** Persistence timeout (in minutes)

        **Type:** number

        **Range:** 1-2000

        **Default:** 5

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3014_source-ip-list:

source-ip-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **dont-honor-conn-rules**

        **Description** Do not observe connection rate rules

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **enforce-higher-priority**

        **Description** Enforce to use high priority node if available

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **hash-persist**

        **Description** Use hash value of source IP address

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **incl-dst-ip**

        **Description** Include destination IP on the persist

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **incl-sport**

        **Description** Include source port on the persist

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **match-type**

        **Description** Persistence type

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **name**

        **Description** Source IP persistence template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **netmask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

        **Default:** 255.255.255.255

    **netmask6**

        **Description** IPV6 subnet mask

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **primary-port**

        **Description** Primary port to create the persist session

        **Type:** number

        **Range:** 1-65534

    **scan-all-members**

        **Description** Persist with SCAN of all members

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **server**

        **Description** Persist to the same server, default is port

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** server and service-group are mutually exclusive

    **service-group**

        **Description** Persist within the same service group

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** service-group and server are mutually exclusive

    **timeout**

        **Description** Persistence timeout (in minutes)

        **Type:** number

        **Range:** 1-4321

        **Default:** 5

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3014_cookie-list:

cookie-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **cookie-name**

        **Description** Set cookie name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** sto-id

    **domain**

        **Description** Set cookie domain

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **dont-honor-conn-rules**

        **Description** Do not observe connection rate rules

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **encrypt-level**

        **Description** Encryption level for cookie name / value

        **Type:** number

        **Range:** 0-1

        **Default:** 1

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **expire**

        **Description** Set cookie expiration time (Expiration in seconds)

        **Type:** number

        **Range:** 0-31536000

        **Default:** 31536000

    **httponly**

        **Description** Enable HttpOnly attribute

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **insert-always**

        **Description** Insert persist cookie to every reponse

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **match-type**

        **Description** Persist for server, default is port

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **name**

        **Description** Cookie persistence (Cookie persistence template name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **pass-phrase**

        **Description** Set passphrase for encryption

        **Type:** string

        **Format:** password

        **Maximum Length:** 8 characters

        **Maximum Length:** 8 characters

        **Default:** ACOS4KEY

    **pass-thru**

        **Description** Pass thru mode - Server sends the persist cookie

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **path**

        **Description** Set cookie path (Cookie path, default is "/")

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Default:** /

    **prefix**

        **Description** 'host': the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; 'secure': the cookie will have been set with a Secure attribute; 

        **Type:** string

        **Supported Values:** host, secure

    **samesite**

        **Description** 'none': none; 'lax': lax; 'strict': strict; 

        **Type:** string

        **Supported Values:** none, lax, strict

    **scan-all-members**

        **Description** Persist within the same server SCAN

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **secure**

        **Description** Enable secure attribute

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **server**

        **Description** Persist to the same server, default is port

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** server and service-group are mutually exclusive

    **server-service-group**

        **Description** Persist to the same server and within the same service group

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **service-group**

        **Description** Persist within the same service group

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** service-group and server are mutually exclusive

    **use-attribute**

        **Description** 'max-age': Use the Max-Age attribute; 'expires': Use the Expires attribute; 'all': Use all attributes; 

        **Type:** string

        **Supported Values:** max-age, expires, all

        **Default:** expires

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3014_ssl-sid-list:

ssl-sid-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **dont-honor-conn-rules**

        **Description** Do not observe connection rate rules

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **name**

        **Description** SSL session ID persistence template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **timeout**

        **Description** Persistence timeout (in minutes)

        **Type:** number

        **Range:** 1-2000

        **Default:** 5

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters