.. _overlay_tunnel_options:

overlay-tunnel options
======================

Global overlay-tunnel configuration options


options Specification
---------------------

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

	===================================== ===============================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      options

	 **Element URI**                       /axapi/v3/overlay-tunnel/options

	 **Element Attributes**                options_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`options schema <overlay-tunnel-options/overlay-tunnel-options.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/overlay-tunnel/options



.. raw:: html

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


:ref:`2403_options_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/overlay_tunnel_options_POST.txt
   :literal:




.. raw:: html

   </div></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/overlay-tunnel/options



.. raw:: html

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


:ref:`2403_options_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/overlay_tunnel_options_GET.txt
   :literal:




.. raw:: html

   </div></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/overlay-tunnel/options



.. raw:: html

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


:ref:`2403_options_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/overlay-tunnel/options



.. raw:: html

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


:ref:`2403_options_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/overlay_tunnel_options_PUT.txt
   :literal:




.. raw:: html

   </div></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/overlay-tunnel/options



.. raw:: html

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


:ref:`2403_options_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/overlay_tunnel_options_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2403_options_attributes:

options attributes
------------------

    **fragmentation-mode-inner**

        **Description** Enable the inner-fragmentation

        **Type:** boolean

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

        **Default:** 0

    **gateway-mac**

        **Description** MAC to be used with Gateway segment Id (MAC Address for the Gateway segment)

        **Type:** string

        **Format:** mac-address

    **ip-dscp-preserve**

        **Description** Copy DSCP bits from inner IP to outer IP header

        **Type:** boolean

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

        **Default:** 0

    **nvgre-disable-flow-id**

        **Description** Disable Flow-ID computation for NVGRE

        **Type:** boolean

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

        **Default:** 0

    **nvgre-key-mode-lower24**

        **Description** Use the lower 24-bits of the GRE key as the VSID

        **Type:** boolean

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

        **Default:** 0

    **src-port-range**

        **Description:** src-port-range is a **JSON Block**.  Please see below for :ref:`2403_src-port-range` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/options/src-port-range <overlay_tunnel_options_src_port_range>`

    **tcp-mss-adjust-disable**

        **Description** Disable TCP MSS adjustment in SYN packet for tunnels

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vxlan-dest-port**

        **Description** VXLAN UDP Destination Port (UDP Port Number (default 4789))

        **Type:** number

        **Range:** 1-65535

.. _2403_src-port-range:

src-port-range
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **max-port**

        **Description** Maximum Port Number

        **Type:** number

        **Range:** 1-65535

        **Default:** 65535

    **min-port**

        **Description** Minimum Port Number

        **Type:** number

        **Range:** 1-65535

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters