.. _slb_template_virtual_port:

slb template virtual-port
=========================

Virtual port template


virtual-port Specification
--------------------------

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

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

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

	 **Collection Name**                   :ref:`3053_virtual-port_list`

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

	                                       

	 **Element Name**                      virtual-port

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

	 **Element Attributes**                virtual-port_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3053_virtual-port_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_port_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-port



.. raw:: html

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


:ref:`3053_virtual-port_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-port/{name}



.. raw:: html

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


:ref:`3053_virtual-port_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_port_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-port



.. raw:: html

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


:ref:`3053_virtual-port_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-port/{name}



.. raw:: html

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


:ref:`3053_virtual-port_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-port/{name}



.. raw:: html

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


:ref:`3053_virtual-port_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_port_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-port



.. raw:: html

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


:ref:`3053_virtual-port_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-port/{name}



.. raw:: html

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


:ref:`3053_virtual-port_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_port_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3053_virtual-port_list:

virtual-port-list
-----------------


    virtual-port-list is **JSON List** of :ref:`3053_virtual-port_attributes` 

        virtual-port-list : [

             { :ref:`3053_virtual-port_attributes` },

             { :ref:`3053_virtual-port_attributes` },

             ...

         ]

.. _3053_virtual-port_attributes:

virtual-port attributes
-----------------------

    **aflow**

        **Description** Use aFlow to eliminate the traffic surge

        **Type:** boolean

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

        **Default:** 0

    **allow-syn-otherflags**

        **Description** Allow initial SYN packet with other flags

        **Type:** boolean

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

        **Default:** 0

    **allow-vip-to-rport-mapping**

        **Description** Allow mapping of VIP to real port

        **Type:** boolean

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

        **Default:** 0

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

    **drop-unknown-conn**

        **Description** Drop conection if receives TCP packet without SYN or RST flag and it does not belong to any existing connections

        **Type:** boolean

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

        **Default:** 0

    **dscp**

        **Description** Differentiated Services Code Point (DSCP to Real Server IP Mapping Value)

        **Type:** number

        **Range:** 1-63

    **ignore-tcp-msl**

        **Description** reclaim TCP resource immediately without MSL

        **Type:** boolean

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

        **Default:** 0

    **log-options**

        **Description** 'no-logging': Do not log over limit event; 'no-repeat-logging': log once for over limit event. Default is log once per minute; 

        **Type:** string

        **Supported Values:** no-logging, no-repeat-logging

    **name**

        **Description** Virtual port template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **non-syn-initiation**

        **Description** Allow initial TCP packet to be non-SYN

        **Type:** boolean

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

        **Default:** 0

    **pkt-rate-interval**

        **Description** '100ms': Source IP and port rate limit per 100ms; 'second': Source IP and port rate limit per second (default); 

        **Type:** string

        **Supported Values:** 100ms, second

        **Default:** second

    **pkt-rate-limit-reset**

        **Description** send client-side reset (reset after packet limit)

        **Type:** number

        **Range:** 0-1048575

        **Default:** 0

    **pkt-rate-type**

        **Description** 'src-ip-port': Source IP and port rate limit; 'src-port': Source port rate limit; 

        **Type:** string

        **Supported Values:** src-ip-port, src-port

    **rate**

        **Description** Source IP and port rate limit (Packet rate limit)

        **Type:** number

        **Range:** 1-1048575

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

    **reset-l7-on-failover**

        **Description** Send reset to L7 client and server connection upon a failover

        **Type:** boolean

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

        **Default:** 0

    **reset-unknown-conn**

        **Description** Send reset back if receives TCP packet without SYN or RST flag and it does not belong to any existing connections

        **Type:** boolean

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

        **Default:** 0

    **snat-msl**

        **Description** Source NAT MSL (Source NAT MSL value (seconds))

        **Type:** number

        **Range:** 1-1800

    **snat-port-preserve**

        **Description** Source NAT Port Preservation

        **Type:** boolean

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

        **Default:** 0

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

    **when-rr-enable**

        **Description** Only do rate limit if CPU RR triggered

        **Type:** boolean

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

        **Default:** 0