.. _slb_template_persist_cookie:

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

Cookie persistence


cookie Specification
--------------------

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

	===================================== ===========================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`3010_cookie_list`

	 **Collection URI**                    /axapi/v3/slb/template/persist/cookie

	                                       

	 **Element Name**                      cookie

	 **Element URI**                       /axapi/v3/slb/template/persist/cookie/{name}

	 **Element Attributes**                cookie_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`cookie schema <slb-template-persist-cookie/slb-template-persist-cookie.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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/slb/template/persist/cookie



.. raw:: html

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


:ref:`3010_cookie_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/slb_template_persist_cookie_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/slb/template/persist/cookie



.. raw:: html

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


:ref:`3010_cookie_attributes`



.. raw:: html

   </td><td></td></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/cookie/{name}



.. raw:: html

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


:ref:`3010_cookie_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/slb_template_persist_cookie_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/slb/template/persist/cookie



.. raw:: html

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


:ref:`3010_cookie_list`



.. raw:: html

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




.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/slb/template/persist/cookie/{name}



.. raw:: html

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


:ref:`3010_cookie_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/slb/template/persist/cookie/{name}



.. raw:: html

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


:ref:`3010_cookie_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/slb_template_persist_cookie_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/slb/template/persist/cookie



.. raw:: html

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


:ref:`3010_cookie_list`



.. raw:: html

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




.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/slb/template/persist/cookie/{name}



.. raw:: html

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


:ref:`3010_cookie_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/slb_template_persist_cookie_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3010_cookie_list:

cookie-list
-----------


    cookie-list is **JSON List** of :ref:`3010_cookie_attributes` 

        cookie-list : [

             { :ref:`3010_cookie_attributes` },

             { :ref:`3010_cookie_attributes` },

             ...

         ]

.. _3010_cookie_attributes:

cookie attributes
-----------------

    **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