.. _slb_template_virtual_server:

slb template virtual-server
===========================

Virtual server template


virtual-server Specification
----------------------------

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

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

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

	 **Collection Name**                   :ref:`3054_virtual-server_list`

	 **Collection URI**                    /axapi/v3/slb/template/virtual-server

	                                       

	 **Element Name**                      virtual-server

	 **Element URI**                       /axapi/v3/slb/template/virtual-server/{name}

	 **Element Attributes**                virtual-server_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`virtual-server schema <slb-template-virtual-server/slb-template-virtual-server.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/virtual-server



.. raw:: html

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


:ref:`3054_virtual-server_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_virtual_server_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/virtual-server



.. raw:: html

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


:ref:`3054_virtual-server_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/virtual-server/{name}



.. raw:: html

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


:ref:`3054_virtual-server_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_virtual_server_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/virtual-server



.. raw:: html

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


:ref:`3054_virtual-server_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/virtual-server/{name}



.. raw:: html

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


:ref:`3054_virtual-server_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/virtual-server/{name}



.. raw:: html

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


:ref:`3054_virtual-server_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_virtual_server_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/virtual-server



.. raw:: html

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


:ref:`3054_virtual-server_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/virtual-server/{name}



.. raw:: html

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


:ref:`3054_virtual-server_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_virtual_server_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3054_virtual-server_list:

virtual-server-list
-------------------


    virtual-server-list is **JSON List** of :ref:`3054_virtual-server_attributes` 

        virtual-server-list : [

             { :ref:`3054_virtual-server_attributes` },

             { :ref:`3054_virtual-server_attributes` },

             ...

         ]

.. _3054_virtual-server_attributes:

virtual-server attributes
-------------------------

    **conn-limit**

        **Description** Connection limit

        **Type:** number

        **Range:** 1-64000000

        **Default:** 64000000

    **conn-limit-no-logging**

        **Description** Do not log connection over limit event

        **Type:** boolean

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

        **Default:** 0

    **conn-limit-reset**

        **Description** Send client reset when connection over limit

        **Type:** boolean

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

        **Default:** 0

    **conn-rate-limit**

        **Description** Connection rate limit

        **Type:** number

        **Range:** 1-1048575

    **conn-rate-limit-no-logging**

        **Description** Do not log connection over limit event

        **Type:** boolean

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

        **Default:** 0

    **conn-rate-limit-reset**

        **Description** Send client reset when connection rate over limit

        **Type:** boolean

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

        **Default:** 0

    **disable-when-all-ports-down**

        **Description** Disable Virtual Server when all member ports are down

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** disable-when-all-ports-down and disable-when-any-port-down are mutually exclusive

    **disable-when-any-port-down**

        **Description** Disable Virtual Server when any member port is down

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** disable-when-any-port-down and disable-when-all-ports-down are mutually exclusive

    **icmp-lockup**

        **Description** Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)

        **Type:** number

        **Range:** 1-65535

    **icmp-lockup-period**

        **Description** Lockup period (second)

        **Type:** number

        **Range:** 1-16383

    **icmp-rate-limit**

        **Description** ICMP rate limit (Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit)

        **Type:** number

        **Range:** 1-65535

    **icmpv6-lockup**

        **Description** Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)

        **Type:** number

        **Range:** 1-65535

    **icmpv6-lockup-period**

        **Description** Lockup period (second)

        **Type:** number

        **Range:** 1-16383

    **icmpv6-rate-limit**

        **Description** ICMPv6 rate limit (Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit)

        **Type:** number

        **Range:** 1-65535

    **name**

        **Description** Virtual server template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **rate-interval**

        **Description** '100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; 

        **Type:** string

        **Supported Values:** 100ms, second

        **Default:** second

    **subnet-gratuitous-arp**

        **Description** Send gratuitous ARP for every IP in the subnet virtual server

        **Type:** boolean

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

        **Default:** 0

    **tcp-stack-tfo-active-conn-limit**

        **Description** The allowed active layer 7 tcp fast-open connection limit, default is zero (number)

        **Type:** number

        **Range:** 0-10000

        **Default:** 0

    **tcp-stack-tfo-backoff-time**

        **Description** The time tcp stack will wait before allowing new fast-open requests after security condition, default 600 seconds (number)

        **Type:** number

        **Range:** 1-14400

        **Default:** 600

    **tcp-stack-tfo-cookie-time-limit**

        **Description** The time limit (in seconds) that a layer 7 tcp fast-open cookie is valid, default is 60 seconds (number)

        **Type:** number

        **Range:** 1-14400

        **Default:** 60

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