.. _slb_template_quic:

slb template quic
=================

QUIC template


quic Specification
------------------

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

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

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

	 **Collection Name**                   :ref:`3038_quic_list`

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

	                                       

	 **Element Name**                      quic

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

	 **Element Attributes**                quic_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3038_quic_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_quic_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/quic



.. raw:: html

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


:ref:`3038_quic_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/quic/{name}



.. raw:: html

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


:ref:`3038_quic_attributes`



.. raw:: html

   </td><td></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/quic



.. raw:: html

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


:ref:`3038_quic_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/quic/{name}



.. raw:: html

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


:ref:`3038_quic_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/quic/{name}



.. raw:: html

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


:ref:`3038_quic_attributes`



.. raw:: html

   </td><td></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/quic



.. raw:: html

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


:ref:`3038_quic_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/quic/{name}



.. raw:: html

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


:ref:`3038_quic_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3038_quic_list:

quic-list
---------


    quic-list is **JSON List** of :ref:`3038_quic_attributes` 

        quic-list : [

             { :ref:`3038_quic_attributes` },

             { :ref:`3038_quic_attributes` },

             ...

         ]

.. _3038_quic_attributes:

quic attributes
---------------

    **burst-len**

        **Description** Number of burst packet, default 16

        **Type:** number

        **Range:** 16-360

    **connection-id-length**

        **Description** Connection id length in byte, default 8 bytes

        **Type:** number

        **Range:** 1-20

    **idle-timeout**

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

        **Type:** number

        **Range:** 1-3600

    **initial-wnd**

        **Description** Initial window size in byte, default 10000 (Initial window size, default 10000)

        **Type:** number

        **Range:** 10000-100000

    **key-update-to-client**

        **Description** Initiate key update on the client-side

        **Type:** boolean

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

        **Default:** 0

    **key-update-to-server**

        **Description** Initiate key update on the server-side

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** QUIC Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **receive-buffer**

        **Description** Receive buffer size in byte, default 200000 (Receive buffer size, default 200000)

        **Type:** number

        **Range:** 30000-400000

    **server-retry**

        **Description** Enable server retry

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