.. _overlay_tunnel_vtep_remote_ip_address:

overlay-tunnel vtep remote-ip-address
=====================================

Configure remote tunnel end point parameters


remote-ip-address Specification
-------------------------------

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

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

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

	 **Collection Name**                   :ref:`2412_remote-ip-address_list`

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

	                                       

	 **Element Name**                      remote-ip-address

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

	 **Element Attributes**                remote-ip-address_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2412_remote-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}/remote-ip-address



.. raw:: html

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


:ref:`2412_remote-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}/remote-ip-address/{ip-address}



.. raw:: html

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


:ref:`2412_remote-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}/remote-ip-address



.. raw:: html

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


:ref:`2412_remote-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}/remote-ip-address/{ip-address}



.. raw:: html

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


:ref:`2412_remote-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}/remote-ip-address/{ip-address}



.. raw:: html

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


:ref:`2412_remote-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}/remote-ip-address



.. raw:: html

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


:ref:`2412_remote-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}/remote-ip-address/{ip-address}



.. raw:: html

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


:ref:`2412_remote-ip-address_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2412_remote-ip-address_list:

remote-ip-address-list
----------------------


    remote-ip-address-list is **JSON List** of :ref:`2412_remote-ip-address_attributes` 

        remote-ip-address-list : [

             { :ref:`2412_remote-ip-address_attributes` },

             { :ref:`2412_remote-ip-address_attributes` },

             ...

         ]

.. _2412_remote-ip-address_attributes:

remote-ip-address attributes
----------------------------

    **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:`2412_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:`2412_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:`2412_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>`

.. _2412_gre-keepalive:

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

.. _2412_use-lif:

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

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

.. _2412_use-gre-key:

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