.. _slb_template_udp:

slb template udp
================

L4 UDP switch config


udp Specification
-----------------

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

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

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

	 **Collection Name**                   :ref:`3052_udp_list`

	 **Collection URI**                    /axapi/v3/slb/template/udp

	                                       

	 **Element Name**                      udp

	 **Element URI**                       /axapi/v3/slb/template/udp/{name}

	 **Element Attributes**                udp_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3052_udp_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_udp_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/udp



.. raw:: html

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


:ref:`3052_udp_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/udp/{name}



.. raw:: html

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


:ref:`3052_udp_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_udp_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/udp



.. raw:: html

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


:ref:`3052_udp_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/udp/{name}



.. raw:: html

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


:ref:`3052_udp_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/udp/{name}



.. raw:: html

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


:ref:`3052_udp_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_udp_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/udp



.. raw:: html

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


:ref:`3052_udp_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/udp/{name}



.. raw:: html

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


:ref:`3052_udp_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_udp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3052_udp_list:

udp-list
--------


    udp-list is **JSON List** of :ref:`3052_udp_attributes` 

        udp-list : [

             { :ref:`3052_udp_attributes` },

             { :ref:`3052_udp_attributes` },

             ...

         ]

.. _3052_udp_attributes:

udp attributes
--------------

    **age**

        **Description** short age (in sec), default is 31

        **Type:** number

        **Range:** 1-31

    **avp**

        **Description** '4': NAS-IP-address; '8': Framed-IP-Address; 

        **Type:** string

        **Supported Values:** 4, 8

    **disable-clear-session**

        **Description** Disable immediate clearing of session

        **Type:** boolean

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

        **Default:** 0

    **idle-timeout**

        **Description** Idle Timeout value (Interval of 60 seconds), default 120 seconds (idle timeout in second, default 120)

        **Type:** number

        **Range:** 1-2097151

        **Default:** 120

    **immediate**

        **Description** Immediate Removal after Transaction

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** immediate and short are mutually exclusive

    **name**

        **Description** Fast UDP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **qos**

        **Description** QOS level (number)

        **Type:** number

        **Range:** 1-63

    **radius-lb-method-hash-type**

        **Description** 'ip': IP-Hash; 

        **Type:** string

        **Supported Values:** ip, ipv6

    **re-select-if-server-down**

        **Description** re-select another server if service port is down

        **Type:** boolean

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

        **Default:** 0

    **short**

        **Description** Short lived session

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** short and immediate are mutually exclusive

    **stateless-conn-timeout**

        **Description** Stateless Current Connection Timeout value (5 - 120 seconds) (idle timeout in second, default 120)

        **Type:** number

        **Range:** 5-120

        **Default:** 120

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

    **v6avp**

        **Description** '168': Framed-IPv6-Address; '97': Framed-IPv6-PrefixFramed-IPv6-Prefix; 

        **Type:** string

        **Supported Values:** 168, 97