.. _ddos_template_encap:

ddos template encap
===================

Encapsulation template Configuration


encap Specification
-------------------

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

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

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

	 **Collection Name**                   :ref:`1187_encap_list`

	 **Collection URI**                    /axapi/v3/ddos/template/encap

	                                       

	 **Element Name**                      encap

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

	 **Element Attributes**                encap_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1187_encap_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_encap_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/encap



.. raw:: html

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


:ref:`1187_encap_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/encap/{encap-tmpl-name}



.. raw:: html

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


:ref:`1187_encap_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_encap_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/encap



.. raw:: html

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


:ref:`1187_encap_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/encap/{encap-tmpl-name}



.. raw:: html

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


:ref:`1187_encap_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/encap/{encap-tmpl-name}



.. raw:: html

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


:ref:`1187_encap_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_encap_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/encap



.. raw:: html

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


:ref:`1187_encap_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/encap/{encap-tmpl-name}



.. raw:: html

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


:ref:`1187_encap_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_encap_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1187_encap_list:

encap-list
----------


    encap-list is **JSON List** of :ref:`1187_encap_attributes` 

        encap-list : [

             { :ref:`1187_encap_attributes` },

             { :ref:`1187_encap_attributes` },

             ...

         ]

.. _1187_encap_attributes:

encap attributes
----------------

    **encap-tmpl-name**

        **Description** DDOS Tunnel Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **preserve-source-ip**

        **Description** Use original source ip for encapsulation

        **Type:** boolean

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

        **Default:** 0

    **tunnel-encap**

        **Description:** tunnel-encap is a **JSON Block**.  Please see below for :ref:`1187_tunnel-encap` 

        **Type:** Object

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

.. _1187_tunnel-encap:

tunnel-encap
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **gre-cfg**

        **Description:** gre-cfg is a **JSON Block**.  Please see below for :ref:`1187_tunnel-encap_gre-cfg` 

        **Type:** Object

    **ip-cfg**

        **Description:** ip-cfg is a **JSON Block**.  Please see below for :ref:`1187_tunnel-encap_ip-cfg` 

        **Type:** Object

.. _1187_tunnel-encap_ip-cfg:

tunnel-encap_ip-cfg
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **always**

        **Description:** always is a **JSON Block**.  Please see below for :ref:`1187_tunnel-encap_ip-cfg_always` 

        **Type:** Object

    **ip-encap**

        **Description** Enable Tunnel encap for IP packets

        **Type:** boolean

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

        **Default:** 0

.. _1187_tunnel-encap_ip-cfg_always:

tunnel-encap_ip-cfg_always
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv4-addr**

        **Description** IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)

        **Type:** string

        **Format:** ipv4-address

    **ipv6-addr**

        **Description** IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)

        **Type:** string

        **Format:** ipv6-address

.. _1187_tunnel-encap_gre-cfg:

tunnel-encap_gre-cfg
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **gre-always**

        **Description:** gre-always is a **JSON Block**.  Please see below for :ref:`1187_tunnel-encap_gre-cfg_gre-always` 

        **Type:** Object

    **gre-encap**

        **Description** Enable Tunnel encap for GRE packets

        **Type:** boolean

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

        **Default:** 0

.. _1187_tunnel-encap_gre-cfg_gre-always:

tunnel-encap_gre-cfg_gre-always
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **gre-ipv4**

        **Description** IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)

        **Type:** string

        **Format:** ipv4-address

    **gre-ipv6**

        **Description** IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)

        **Type:** string

        **Format:** ipv6-address

    **key-ipv4**

        **Description** Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)

        **Type:** string

        **Maximum Length:** 10 characters

        **Maximum Length:** 1 characters

    **key-ipv6**

        **Description** Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)

        **Type:** string

        **Maximum Length:** 10 characters

        **Maximum Length:** 1 characters