.. _overlay_tunnel_vtep_destination_ip_address:

overlay-tunnel vtep destination-ip-address
==========================================

Configure remote tunnel end point parameters


destination-ip-address Specification
------------------------------------

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

	 **Object Key(s)**                     *ip-address*

	 **Collection Name**                   :ref:`812_destination-ip-address_list`

	 **Collection URI**                    /axapi/v3/overlay-tunnel/vtep/{id}/destination-ip-address

	                                       

	 **Element Name**                      destination-ip-address

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

	 **Element Attributes**                destination-ip-address_attributes

	 **Schema**                             :download:`destination-ip-address schema <overlay-tunnel-vtep-destination-ip-address/overlay-tunnel-vtep-destination-ip-address.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/{id}/destination-ip-address



.. raw:: html

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


:ref:`812_destination-ip-address_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/{id}/destination-ip-address



.. raw:: html

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


:ref:`812_destination-ip-address_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}/destination-ip-address/{ip-address}



.. raw:: html

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


:ref:`812_destination-ip-address_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/{id}/destination-ip-address



.. raw:: html

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


:ref:`812_destination-ip-address_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}/destination-ip-address/{ip-address}



.. raw:: html

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


:ref:`812_destination-ip-address_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}/destination-ip-address/{ip-address}



.. raw:: html

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


:ref:`812_destination-ip-address_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/{id}/destination-ip-address



.. raw:: html

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


:ref:`812_destination-ip-address_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}/destination-ip-address/{ip-address}



.. raw:: html

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


:ref:`812_destination-ip-address_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _812_destination-ip-address_list:

destination-ip-address-list
---------------------------


    destination-ip-address-list is **JSON List** of :ref:`812_destination-ip-address_attributes` 

        destination-ip-address-list : [

             { :ref:`812_destination-ip-address_attributes` },

             { :ref:`812_destination-ip-address_attributes` },

             ...

         ]

.. _812_destination-ip-address_attributes:

destination-ip-address attributes
---------------------------------

    **encap**

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

        **Type:** string

        **Supported Values:** nvgre, vxlan

    **ip-address**

        **Description** IP Address of the remote VTEP

        **Type:** string

        **Format:** ipv4-address

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

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

.. _812_vni-list:

vni-list
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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