.. _ddos_zone_template_quic:

ddos zone-template quic
=======================

QUIC template Configuration


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

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

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

	 **Object Key(s)**                     *quic-tmpl-name*

	 **Collection Name**                   :ref:`1332_quic_list`

	 **Collection URI**                    /axapi/v3/ddos/zone-template/quic

	                                       

	 **Element Name**                      quic

	 **Element URI**                       /axapi/v3/ddos/zone-template/quic/{quic-tmpl-name}

	 **Element Attributes**                quic_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1332_quic_attributes`



.. raw:: html

   </td><td></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/ddos/zone-template/quic



.. raw:: html

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


:ref:`1332_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/ddos/zone-template/quic/{quic-tmpl-name}



.. raw:: html

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


:ref:`1332_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/ddos/zone-template/quic



.. raw:: html

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


:ref:`1332_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/ddos/zone-template/quic/{quic-tmpl-name}



.. raw:: html

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


:ref:`1332_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/ddos/zone-template/quic/{quic-tmpl-name}



.. raw:: html

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


:ref:`1332_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/ddos/zone-template/quic



.. raw:: html

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


:ref:`1332_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/ddos/zone-template/quic/{quic-tmpl-name}



.. raw:: html

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


:ref:`1332_quic_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1332_quic_list:

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


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

        quic-list : [

             { :ref:`1332_quic_attributes` },

             { :ref:`1332_quic_attributes` },

             ...

         ]

.. _1332_quic_attributes:

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

    **action-on-initial**

        **Description:** action-on-initial is a **JSON Block**.  Please see below for :ref:`1332_action-on-initial` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-template/quic/{quic-tmpl-name}/action-on-initial <ddos_zone_template_quic>`

    **create-conn-on-initial-only**

        **Description** Create connection on QUIC Initial Packets Only

        **Type:** boolean

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

        **Default:** 0

    **fixed-bit-check-disable**

        **Description** Disable fixed-bit malform check

        **Type:** boolean

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

        **Default:** 0

    **pkt-rate-cfg**

        **Description:** pkt-rate-cfg is a **JSON Block**.  Please see below for :ref:`1332_pkt-rate-cfg` 

        **Type:** Object

    **quic-tmpl-name**

        **Description** DDOS QUIC Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

    **version-supported-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-template/quic/{quic-tmpl-name}/version-supported/{version-start}+{version-end} <ddos_zone_template_quic>`

.. _1332_version-supported-list:

version-supported-list
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **malformed-check**

        **Description:** malformed-check is a **JSON Block**.  Please see below for :ref:`1332_version-supported-list_malformed-check` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-template/quic/{quic-tmpl-name}/version-supported/{version-start}+{version-end}/malformed-check <ddos_zone_template_quic>`

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

    **version-action**

        **Description** 'drop': Drop packets; 'blacklist-src': Blacklist-src; 

        **Type:** string

        **Supported Values:** drop, blacklist-src

        **Mutual Exclusion:** version-action and version-action-list-name are mutually exclusive

    **version-action-list-name**

        **Description** Configure action-list to take

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** version-action-list-name and version-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **version-end**

        **Description** Version supported range end

        **Type:** string

        **Format:** time

        **Maximum Length:** 4294967295 characters

        **Maximum Length:** 1 characters

    **version-start**

        **Description** Configure versions supported

        **Type:** string

        **Format:** time

        **Maximum Length:** 4294967295 characters

        **Maximum Length:** 1 characters

.. _1332_version-supported-list_malformed-check:

version-supported-list_malformed-check
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **malformed-check-action**

        **Description** 'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 

        **Type:** string

        **Supported Values:** drop, blacklist-src

        **Mutual Exclusion:** malformed-check-action and malformed-check-action-list-name are mutually exclusive

    **malformed-check-action-list-name**

        **Description** Configure action-list to take. Overwrites version action

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** malformed-check-action-list-name and malformed-check-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **malformed-enable**

        **Description** 'enable': Enable malformed check; 

        **Type:** string

        **Supported Values:** enable

        **Default:** enable

    **max-destination-cid-length**

        **Description** Set the maximum destination CID length

        **Type:** number

        **Range:** 0-255

        **Default:** 255

    **max-source-cid-length**

        **Description** Set the maximum source CID length

        **Type:** number

        **Range:** 0-255

        **Default:** 255

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1332_pkt-rate-cfg:

pkt-rate-cfg
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **per**

        **Description** 'aead-tag': AEAD Tag; 'dcid': Destination Connection ID; 

        **Type:** string

        **Supported Values:** aead-tag, dcid

    **quic-pkt-rate**

        **Description** Limiting rate (Range: 5-16000000)

        **Type:** number

        **Range:** 5-16000000

    **quic-pkt-rate-limit**

        **Description** QUIC Packet Rate Limit

        **Type:** boolean

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

        **Default:** 0

.. _1332_action-on-initial:

action-on-initial
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **retry-token-authentication-dynamic**

        **Description** 'cid-hash': Dynamic retry token based on Destination and Source CID; 

        **Type:** string

        **Supported Values:** cid-hash

        **Mutual Exclusion:** retry-token-authentication-dynamic and retry-token-authentication-static are mutually exclusive

    **retry-token-authentication-static**

        **Description** Static retry token (Maximum of 4 bytes)

        **Type:** string

        **Format:** time

        **Maximum Length:** 4294967295 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** retry-token-authentication-static and retry-token-authentication-dynamic are mutually exclusive

    **retry-unauthenticated-initial-decrypt**

        **Description** Decrypt incoming initial packets for unauthenticated clients

        **Type:** boolean

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

        **Default:** 0

    **scid-length**

        **Description** Set Max SCID length for SCID generation

        **Type:** number

        **Range:** 8-20

        **Default:** 20

    **unauth-short-hdr-action**

        **Description** 'drop': Drop short header packet; 

        **Type:** string

        **Supported Values:** drop

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters