.. _vrrp_a_interface:

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

VRRP-A interface


interface Specification
-----------------------

	===================================== =========================================================
	===================================== =========================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      interface

	 **Element URI**                       /axapi/v3/vrrp-a/interface

	 **Element Attributes**                interface_attributes

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/vrrp-a/interface



.. raw:: html

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


interface_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2087_interface_attributes:

interface attributes
--------------------

    **ethernet-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/vrrp-a/interface/ethernet/{ethernet-val} <vrrp_a_interface_ethernet>`

    **trunk-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/vrrp-a/interface/trunk/{trunk-val} <vrrp_a_interface_trunk>`

.. _2087_trunk-list:

trunk-list
^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **both**

        **Description** both a router and server interface

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion**: both is mutually exclusive with  router-interface and server-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 is mutually exclusive with  server-interface and both 

    **server-interface**

        **Description** interface to real server

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion**: server-interface is mutually exclusive with  router-interface and both 

    **trunk-val**

        **Description** Ethernet Interface

        **Type:** number

        **Range:** 1-4096

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

.. _2087_trunk-list_vlan-cfg:

trunk-list_vlan-cfg
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **vlan**

        **Description** VLAN ID

        **Type:** number

        **Range:** 2-4094

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

.. _2087_ethernet-list:

ethernet-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **both**

        **Description** both a router and server interface

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion**: both is mutually exclusive with  router-interface and server-interface 

    **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 is mutually exclusive with  server-interface and both 

    **server-interface**

        **Description** interface to real server

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion**: server-interface is mutually exclusive with  router-interface and both 

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

.. _2087_ethernet-list_vlan-cfg:

ethernet-list_vlan-cfg
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **vlan**

        **Description** VLAN ID

        **Type:** number

        **Range:** 2-4094

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