.. _overlay_tunnel_vtep:

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

Virtual Tunnel end point Configuration


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

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

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

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

	 **Collection Name**                   :ref:`2417_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:`2417_vtep_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_vtep_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/overlay-tunnel/vtep



.. raw:: html

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


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



.. raw:: html

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


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



.. raw:: html

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


:ref:`2417_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:`2417_vtep_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_vtep_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2417_vtep_list:

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


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

        vtep-list : [

             { :ref:`2417_vtep_attributes` },

             { :ref:`2417_vtep_attributes` },

             ...

         ]

.. _2417_vtep_attributes:

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

    **dest-port**

        **Description** Layer-4 Destination Port (Port Number)

        **Type:** number

        **Range:** 1-65535

    **encap**

        **Description** 'ip-encap': Tunnel encapsulation type is IP; 'gre': Tunnel encapsulation type is GRE; 'nvgre': Tunnel Encapsulation Type is NVGRE; 'vxlan': Tunnel Encapsulation Type is VXLAN; 

        **Type:** string

        **Supported Values:** ip-encap, gre, nvgre, vxlan

    **host-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-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:`2417_local-ip-address` 

        **Type:** Object

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

    **local-ipv6-address**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/local-ipv6-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>`

    **remote-ipv6-address-list**

        **Type:** List

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

    **sampling-enable**

        **Type:** List

    **src-port-range**

        **Description:** src-port-range is a **JSON Block**.  Please see below for :ref:`2417_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

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

.. _2417_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>`

.. _2417_local-ip-address_vni-list:

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

	 **Block object keys**             

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

    **gateway**

        **Description** This is a Gateway segment id

        **Type:** boolean

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

        **Default:** 0

    **lif**

        **Description** Logical interface (logical interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **partition**

        **Description** Name of the Partition with the L2 segment being extended (Name of the User Partition with the L2 segment being extended)

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

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

.. _2417_local-ipv6-address:

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

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

    **ipv6-address**

        **Description** Source Tunnel End Point IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2417_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'cfg_err_count': Config errors; 'flooded_pkt_count': Flooded packet count; 'encap_unresolved_count': Encap unresolved failures; 'unknown_encap_rx_pkt': Encap miss rx pkts; 'unknown_encap_tx_pkt': Encap miss tx pkts; 'arp_req_sent': Arp request sent; 'vtep_host_learned': Hosts learned; 'vtep_host_learn_error': Host learn error; 'invalid_lif_rx': Invalid Lif pkts in; 'invalid_lif_tx': Invalid Lif pkts out; 'unknown_vtep_tx': Vtep unknown tx; 'unknown_vtep_rx': Vtep Unkown rx; 'unhandled_pkt_rx': Unhandled packets in; 'unhandled_pkt_tx': Unhandled packets out; 'total_pkts_rx': Total packets out; 'total_bytes_rx': Total packet bytes in; 'unicast_pkt_rx': Total unicast packets in; 'bcast_pkt_rx': Total broadcast packets in; 'mcast_pkt_rx': Total multicast packets in; 'dropped_pkt_rx': Dropped received packets; 'encap_miss_pkts_rx': Encap missed in received packets; 'bad_chksum_pks_rx': Bad checksum in received packets; 'requeue_pkts_in': Requeued packets in; 'pkts_out': Packets out; 'total_bytes_tx': Packet bytes out; 'unicast_pkt_tx': Unicast packets out; 'bcast_pkt_tx': Broadcast packets out; 'mcast_pkt_tx': Multicast packets out; 'dropped_pkts_tx': Dropped packets out; 'large_pkts_rx': Too large packets in; 'dot1q_pkts_rx': Dot1q packets in; 'frag_pkts_tx': Frag packets out; 'reassembled_pkts_rx': Reassembled packets in; 'bad_inner_ipv4_len_rx': bad inner ipv4 packet len; 'bad_inner_ipv6_len_rx': Bad inner ipv6 packet len; 'frag_drop_pkts_tx': Frag dropped packets out; 'lif_un_init_rx': Lif uninitialized packets in; 

        **Type:** string

        **Supported Values:** all, cfg_err_count, flooded_pkt_count, encap_unresolved_count, unknown_encap_rx_pkt, unknown_encap_tx_pkt, arp_req_sent, vtep_host_learned, vtep_host_learn_error, invalid_lif_rx, invalid_lif_tx, unknown_vtep_tx, unknown_vtep_rx, unhandled_pkt_rx, unhandled_pkt_tx, total_pkts_rx, total_bytes_rx, unicast_pkt_rx, bcast_pkt_rx, mcast_pkt_rx, dropped_pkt_rx, encap_miss_pkts_rx, bad_chksum_pks_rx, requeue_pkts_in, pkts_out, total_bytes_tx, unicast_pkt_tx, bcast_pkt_tx, mcast_pkt_tx, dropped_pkts_tx, large_pkts_rx, dot1q_pkts_rx, frag_pkts_tx, reassembled_pkts_rx, bad_inner_ipv4_len_rx, bad_inner_ipv6_len_rx, frag_drop_pkts_tx, lif_un_init_rx

.. _2417_remote-ip-address-list:

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

	 **Block object keys**             

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

    **encap**

        **Description** 'nvgre': Tunnel Encapsulation Type is NVGRE; 'vxlan': Tunnel Encapsulation Type is VXLAN; 

        **Type:** string

        **Supported Values:** nvgre, vxlan

    **gre-keepalive**

        **Description:** gre-keepalive is a **JSON Block**.  Please see below for :ref:`2417_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:`2417_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:`2417_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>`

.. _2417_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 retry 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

.. _2417_remote-ip-address-list_use-lif:

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

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

    **lif**

        **Description** Logical interface (logical interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **partition**

        **Description** Name of the Partition with the L2 segment being extended (Name of the User Partition with the L2 segment being extended)

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

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

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

.. _2417_remote-ipv6-address-list:

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

	 **Block object keys**             

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

    **ipv6-address**

        **Description** IPv6 Address of the remote VTEP

        **Type:** string

        **Format:** ipv6-address

    **use-lif**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/overlay-tunnel/vtep/{id}/remote-ipv6-address/{ipv6-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

.. _2417_remote-ipv6-address-list_use-lif:

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

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

    **lif**

        **Description** Logical interface (logical interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **partition**

        **Description** Name of the Partition with the L2 segment being extended (Name of the User Partition with the L2 segment being extended)

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2417_host-list:

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

	 **Block object keys**             

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

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

    **remote-vtep**

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

        **Type:** string

        **Format:** ipv4-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