.. _ddos_template_icmp_v6:

ddos template icmp-v6
=====================

ICMPv6 template Configuration


icmp-v6 Specification
---------------------

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

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

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

	 **Collection Name**                   :ref:`1195_icmp-v6_list`

	 **Collection URI**                    /axapi/v3/ddos/template/icmp-v6

	                                       

	 **Element Name**                      icmp-v6

	 **Element URI**                       /axapi/v3/ddos/template/icmp-v6/{icmp-tmpl-name}

	 **Element Attributes**                icmp-v6_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`icmp-v6 schema <ddos-template-icmp-v6/ddos-template-icmp-v6.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/template/icmp-v6



.. raw:: html

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


:ref:`1195_icmp-v6_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/ddos_template_icmp_v6_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/ddos/template/icmp-v6



.. raw:: html

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


:ref:`1195_icmp-v6_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/template/icmp-v6/{icmp-tmpl-name}



.. raw:: html

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


:ref:`1195_icmp-v6_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/ddos_template_icmp_v6_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/ddos/template/icmp-v6



.. raw:: html

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


:ref:`1195_icmp-v6_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/template/icmp-v6/{icmp-tmpl-name}



.. raw:: html

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


:ref:`1195_icmp-v6_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/template/icmp-v6/{icmp-tmpl-name}



.. raw:: html

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


:ref:`1195_icmp-v6_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/ddos_template_icmp_v6_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/ddos/template/icmp-v6



.. raw:: html

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


:ref:`1195_icmp-v6_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/template/icmp-v6/{icmp-tmpl-name}



.. raw:: html

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


:ref:`1195_icmp-v6_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/ddos_template_icmp_v6_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1195_icmp-v6_list:

icmp-v6-list
------------


    icmp-v6-list is **JSON List** of :ref:`1195_icmp-v6_attributes` 

        icmp-v6-list : [

             { :ref:`1195_icmp-v6_attributes` },

             { :ref:`1195_icmp-v6_attributes` },

             ...

         ]

.. _1195_icmp-v6_attributes:

icmp-v6 attributes
------------------

    **icmp-tmpl-name**

        **Description** DDOS ICMPv6 Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/template/icmp-v6/{icmp-tmpl-name}/type/{type-number} <ddos_template_icmp_v6>`

    **type-other**

        **Description:** type-other is a **JSON Block**.  Please see below for :ref:`1195_type-other` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/template/icmp-v6/{icmp-tmpl-name}/type-other <ddos_template_icmp_v6>`

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

.. _1195_type-other:

type-other
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **type-other-deny**

        **Description** Deny all other type

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** type-other-deny and type-other-rate are mutually exclusive

    **type-other-rate**

        **Description** Specify rate with other type

        **Type:** number

        **Range:** 1-16000000

        **Mutual Exclusion:** type-other-rate and type-other-deny are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1195_type-list:

type-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **code**

        **Type:** List

    **code-other**

        **Description:** code-other is a **JSON Block**.  Please see below for :ref:`1195_type-list_code-other` 

        **Type:** Object

    **type-deny**

        **Description** Reject this ICMP type

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** type-deny, type-rate, and code-other-rate are mutually exclusive

    **type-number**

        **Description** Specify ICMP type number

        **Type:** number

        **Range:** 0-255

    **type-rate**

        **Description** Specify the whole rate with this type

        **Type:** number

        **Range:** 1-16000000

        **Mutual Exclusion:** type-rate and type-deny are mutually exclusive

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

.. _1195_type-list_code:

type-list_code
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **code-number**

        **Description** Specify the ICMP code

        **Type:** number

        **Range:** 0-255

    **code-rate**

        **Description** Specify the rate with the code

        **Type:** number

        **Range:** 1-16000000

.. _1195_type-list_code-other:

type-list_code-other
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **code-other-rate**

        **Description** Specify rate with other code

        **Type:** number

        **Range:** 1-16000000

        **Mutual Exclusion:** code-other-rate and type-deny are mutually exclusive