.. _vrrp_a_interface_ethernet:

vrrp-a interface ethernet
=========================

VRRP-A interface ethernet


ethernet Specification
----------------------

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

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

	 **Object Key(s)**                     *ethernet-val*

	 **Collection Name**                   :ref:`4105_ethernet_list`

	 **Collection URI**                    /axapi/v3/vrrp-a/interface/ethernet

	                                       

	 **Element Name**                      ethernet

	 **Element URI**                       /axapi/v3/vrrp-a/interface/ethernet/{ethernet-val}

	 **Element Attributes**                ethernet_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ethernet schema <vrrp-a-interface-ethernet/vrrp-a-interface-ethernet.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/vrrp-a/interface/ethernet



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp_a_interface_ethernet_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/vrrp-a/interface/ethernet



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp-a/interface/ethernet/{ethernet-val}



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp_a_interface_ethernet_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/vrrp-a/interface/ethernet



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp-a/interface/ethernet/{ethernet-val}



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp-a/interface/ethernet/{ethernet-val}



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp_a_interface_ethernet_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/vrrp-a/interface/ethernet



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp-a/interface/ethernet/{ethernet-val}



.. raw:: html

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


:ref:`4105_ethernet_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/vrrp_a_interface_ethernet_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4105_ethernet_list:

ethernet-list
-------------


    ethernet-list is **JSON List** of :ref:`4105_ethernet_attributes` 

        ethernet-list : [

             { :ref:`4105_ethernet_attributes` },

             { :ref:`4105_ethernet_attributes` },

             ...

         ]

.. _4105_ethernet_attributes:

ethernet attributes
-------------------

    **both**

        **Description** both a router and server interface

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** both, router-interface, and server-interface are mutually exclusive

    **ethernet-val**

        **Description** Ethernet Interface

        **Type:** number

        **Format:** interface

    **no-heartbeat**

        **Description** do not send out heartbeat packet from this interface

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** no-heartbeat and vlan are mutually exclusive

    **router-interface**

        **Description** interface to upstream router

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** router-interface, server-interface, and both are mutually exclusive

    **server-interface**

        **Description** interface to real server

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** server-interface, router-interface, and both are mutually exclusive

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

    **vlan-cfg**

        **Type:** List

.. _4105_vlan-cfg:

vlan-cfg
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **vlan**

        **Description** VLAN ID

        **Type:** number

        **Range:** 2-4094

        **Mutual Exclusion:** vlan and no-heartbeat are mutually exclusive