.. _zone:

zone
====

Security zone


zone Specification
------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`4182_zone_list`

	 **Collection URI**                    /axapi/v3/zone

	                                       

	 **Element Name**                      zone

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

	 **Element Attributes**                zone_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`4182_zone_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_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/zone



.. raw:: html

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


:ref:`4182_zone_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/zone/{name}



.. raw:: html

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


:ref:`4182_zone_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_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/zone



.. raw:: html

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


:ref:`4182_zone_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/zone/{name}



.. raw:: html

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


:ref:`4182_zone_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}



.. raw:: html

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


:ref:`4182_zone_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_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/zone



.. raw:: html

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


:ref:`4182_zone_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/zone/{name}



.. raw:: html

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


:ref:`4182_zone_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_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4182_zone_list:

zone-list
---------


    zone-list is **JSON List** of :ref:`4182_zone_attributes` 

        zone-list : [

             { :ref:`4182_zone_attributes` },

             { :ref:`4182_zone_attributes` },

             ...

         ]

.. _4182_zone_attributes:

zone attributes
---------------

    **interface**

        **Description:** interface is a **JSON Block**.  Please see below for :ref:`4182_interface` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/zone/{name}/interface <zone>`

    **local-zone-cfg**

        **Description:** local-zone-cfg is a **JSON Block**.  Please see below for :ref:`4182_local-zone-cfg` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/zone/{name}/local-zone-cfg <zone>`

    **name**

        **Description** name of zone object

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Default:** any

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

        **Description:** vlan is a **JSON Block**.  Please see below for :ref:`4182_vlan` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/zone/{name}/vlan <zone>`

.. _4182_vlan:

vlan
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vlan-list**

        **Type:** List

.. _4182_vlan_vlan-list:

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

	 **Block object keys**             

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

    **vlan-end**

        **Description** 

        **Type:** number

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

    **vlan-start**

        **Description** VLAN ID

        **Type:** number

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

.. _4182_interface:

interface
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

.. _4182_interface_tunnel-list:

interface_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>`

.. _4182_interface_ve-list:

interface_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>`

.. _4182_interface_ethernet-list:

interface_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>`

.. _4182_interface_lif-list:

interface_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>`

.. _4182_interface_trunk-list:

interface_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>`

.. _4182_local-zone-cfg:

local-zone-cfg
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **local-type**

        **Description** Set to local zone

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters