.. _slb_template_persist_source_ip:

slb template persist source-ip
==============================

Source IP persistence


source-ip Specification
-----------------------

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

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

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

	 **Collection Name**                   :ref:`3012_source-ip_list`

	 **Collection URI**                    /axapi/v3/slb/template/persist/source-ip

	                                       

	 **Element Name**                      source-ip

	 **Element URI**                       /axapi/v3/slb/template/persist/source-ip/{name}

	 **Element Attributes**                source-ip_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3012_source-ip_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_source_ip_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/source-ip



.. raw:: html

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


:ref:`3012_source-ip_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/source-ip/{name}



.. raw:: html

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


:ref:`3012_source-ip_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_source_ip_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/source-ip



.. raw:: html

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


:ref:`3012_source-ip_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/source-ip/{name}



.. raw:: html

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


:ref:`3012_source-ip_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/source-ip/{name}



.. raw:: html

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


:ref:`3012_source-ip_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_source_ip_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/source-ip



.. raw:: html

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


:ref:`3012_source-ip_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/source-ip/{name}



.. raw:: html

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


:ref:`3012_source-ip_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_source_ip_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3012_source-ip_list:

source-ip-list
--------------


    source-ip-list is **JSON List** of :ref:`3012_source-ip_attributes` 

        source-ip-list : [

             { :ref:`3012_source-ip_attributes` },

             { :ref:`3012_source-ip_attributes` },

             ...

         ]

.. _3012_source-ip_attributes:

source-ip attributes
--------------------

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