.. _zone_interface:

zone interface
==============

Interface


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

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

	===================================== ==============================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      interface

	 **Element URI**                       /axapi/v3/zone/{name}/interface

	 **Element Attributes**                interface_attributes

	 **Partition Visibility**              shared

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


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/zone/{name}/interface



.. raw:: html

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


:ref:`4179_interface_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/zone_interface_POST.txt
   :literal:




.. raw:: html

   </div></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/zone/{name}/interface



.. raw:: html

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


:ref:`4179_interface_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/zone_interface_GET.txt
   :literal:




.. raw:: html

   </div></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/zone/{name}/interface



.. raw:: html

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


:ref:`4179_interface_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/zone/{name}/interface



.. raw:: html

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


:ref:`4179_interface_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/zone_interface_PUT.txt
   :literal:




.. raw:: html

   </div></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/zone/{name}/interface



.. raw:: html

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


:ref:`4179_interface_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/zone_interface_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4179_interface_attributes:

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

    **ethernet-list**

        **Type:** List

    **lif-list**

        **Type:** List

    **trunk-list**

        **Type:** List

    **tunnel-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-list**

        **Type:** List

.. _4179_tunnel-list:

tunnel-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface-tunnel-end**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/tunnel <interface_tunnel>`

    **interface-tunnel-start**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/tunnel <interface_tunnel>`

.. _4179_ve-list:

ve-list
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface-ve-end**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/network/vlan <network_vlan>`

    **interface-ve-start**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/network/vlan <network_vlan>`

.. _4179_ethernet-list:

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

	 **Block object keys**             

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

    **interface-ethernet-end**

        **Description** 

        **Type:** number

        **Format:** interface

        **Reference Object:** :doc:`/axapi/v3/interface/ethernet <interface_ethernet>`

    **interface-ethernet-start**

        **Description** 

        **Type:** number

        **Format:** interface

        **Reference Object:** :doc:`/axapi/v3/interface/ethernet <interface_ethernet>`

.. _4179_lif-list:

lif-list
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface-lif-end**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/lif <interface_lif>`

    **interface-lif-start**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/lif <interface_lif>`

.. _4179_trunk-list:

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

	 **Block object keys**             

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

    **interface-trunk-end**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/trunk <interface_trunk>`

    **interface-trunk-start**

        **Description** 

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/trunk <interface_trunk>`