.. _overlay_tunnel_vtep:

overlay-tunnel vtep
===================

Virtual Tunnel end point Configuration


vtep Specification
------------------

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

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

	 **Object Key(s)**                     *id*

	 **Collection Name**                   :ref:`1210_vtep_list`

	 **Collection URI**                    /axapi/v3/overlay-tunnel/vtep

	                                       

	 **Element Name**                      vtep

	 **Element URI**                       /axapi/v3/overlay-tunnel/vtep/{id}

	 **Element Attributes**                vtep_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/overlay-tunnel/vtep/{id}/stats

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



.. raw:: html

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


:ref:`1210_vtep_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/overlay-tunnel/vtep



.. raw:: html

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


:ref:`1210_vtep_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/overlay-tunnel/vtep/{id}



.. raw:: html

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


:ref:`1210_vtep_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/overlay-tunnel/vtep



.. raw:: html

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


:ref:`1210_vtep_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/overlay-tunnel/vtep/{id}



.. raw:: html

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


:ref:`1210_vtep_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/vtep/{id}



.. raw:: html

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


:ref:`1210_vtep_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/overlay-tunnel/vtep



.. raw:: html

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


:ref:`1210_vtep_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/overlay-tunnel/vtep/{id}



.. raw:: html

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


:ref:`1210_vtep_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1210_vtep_list:

vtep-list
---------


    vtep-list is **JSON List** of :ref:`1210_vtep_attributes` 

        vtep-list : [

             { :ref:`1210_vtep_attributes` },

             { :ref:`1210_vtep_attributes` },

             ...

         ]

.. _1210_vtep_attributes:

vtep attributes
---------------

    **encap**

        **Description** 'gre': Tunnel encapsulation type is GRE; 'vxlan': Tunnel Encapsulation Type is VXLAN; 

        **Type:** string

        **Supported Values:** gre, vxlan

    **host-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{destination-vtep} <overlay_tunnel_vtep>`

    **id**

        **Description** VTEP Identifier

        **Type:** number

        **Range:** 1-190

    **local-ip-address**

        **Description:** local-ip-address is a **JSON Block**.  Please see below for :ref:`1210_local-ip-address` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address <overlay_tunnel_vtep>`

    **remote-ip-address-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address} <overlay_tunnel_vtep>`

    **src-port-range**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/src-port-range <overlay_tunnel_vtep>`

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

.. _1210_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

.. _1210_remote-ip-address-list:

remote-ip-address-list
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **gre-keepalive**

        **Description:** gre-keepalive is a **JSON Block**.  Please see below for :ref:`1210_remote-ip-address-list_gre-keepalive` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/gre-keepalive <overlay_tunnel_vtep>`

    **ip-address**

        **Description** IP Address of the remote VTEP

        **Type:** string

        **Format:** ipv4-address

    **use-gre-key**

        **Description:** use-gre-key is a **JSON Block**.  Please see below for :ref:`1210_remote-ip-address-list_use-gre-key` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/use-gre-key <overlay_tunnel_vtep>`

    **use-lif**

        **Description:** use-lif is a **JSON Block**.  Please see below for :ref:`1210_remote-ip-address-list_use-lif` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/use-lif <overlay_tunnel_vtep>`

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

    **vni-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/vni/{segment} <overlay_tunnel_vtep>`

.. _1210_remote-ip-address-list_gre-keepalive:

remote-ip-address-list_gre-keepalive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **retry-count**

        **Description** Keepalive multiplier

        **Type:** number

        **Range:** 2-100

    **retry-time**

        **Description** Keepalive interval in seconds

        **Type:** number

        **Range:** 1-60

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1210_remote-ip-address-list_use-lif:

remote-ip-address-list_use-lif
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **lif**

        **Description** Logical interface binding the Provider Partition to the User Partition (logical interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1210_remote-ip-address-list_vni-list:

remote-ip-address-list_vni-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **segment**

        **Description** VNI configured for the remote VTEP

        **Type:** number

        **Range:** 1-16777215

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1210_remote-ip-address-list_use-gre-key:

remote-ip-address-list_use-gre-key
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **gre-key**

        **Description** key

        **Type:** number

        **Range:** 0-4294967295

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1210_local-ip-address:

local-ip-address
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-address**

        **Description** Source Tunnel End Point IPv4 address

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vni-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address/vni/{segment} <overlay_tunnel_vtep>`

.. _1210_local-ip-address_vni-list:

local-ip-address_vni-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **lif**

        **Description** Logical interface binding the Provider Partition to the User Partition (logical interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **segment**

        **Description** Id of the segment that is being extended

        **Type:** number

        **Range:** 1-16777215

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1210_host-list:

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

	 **Block object keys**             

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

    **destination-vtep**

        **Description** Configure the VTEP IP address (IPv4 address of the VTEP for the remote host)

        **Type:** string

        **Format:** ipv4-address

    **ip-addr**

        **Description** IPv4 address of the overlay host

        **Type:** string

        **Format:** ipv4-address

    **overlay-mac-addr**

        **Description** MAC Address of the overlay host

        **Type:** string

        **Format:** mac-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vni**

        **Description**  Configure the segment id ( VNI of the remote host)

        **Type:** number

        **Range:** 1-16777215