.. _overlay_tunnel_vtep_host:

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

IP Address of the local tunnel end point


host Specification
------------------

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

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

	 **Object Key(s)**                     *ip-addr, overlay-mac-addr, vni, remote-vtep*

	 **Collection Name**                   :ref:`2404_host_list`

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

	                                       

	 **Element Name**                      host

	 **Element URI**                       /axapi/v3/overlay-tunnel/vtep/{id}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-vtep}

	 **Element Attributes**                host_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2404_host_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}/host



.. raw:: html

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


:ref:`2404_host_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}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-vtep}



.. raw:: html

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


:ref:`2404_host_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}/host



.. raw:: html

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


:ref:`2404_host_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}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-vtep}



.. raw:: html

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


:ref:`2404_host_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}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-vtep}



.. raw:: html

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


:ref:`2404_host_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}/host



.. raw:: html

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


:ref:`2404_host_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}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-vtep}



.. raw:: html

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


:ref:`2404_host_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2404_host_list:

host-list
---------


    host-list is **JSON List** of :ref:`2404_host_attributes` 

        host-list : [

             { :ref:`2404_host_attributes` },

             { :ref:`2404_host_attributes` },

             ...

         ]

.. _2404_host_attributes:

host attributes
---------------

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