.. _partition:

partition
=========

Create/unload a Network partition


partition Specification
-----------------------

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

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

	 **Object Key(s)**                     *partition-name*

	 **Collection Name**                   :ref:`1667_partition_list`

	 **Collection URI**                    /axapi/v3/partition

	                                       

	 **Element Name**                      partition

	 **Element URI**                       /axapi/v3/partition/{partition-name}

	 **Element Attributes**                partition_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/partition/{partition-name}/stats

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



.. raw:: html

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


:ref:`1667_partition_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/partition



.. raw:: html

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


:ref:`1667_partition_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/partition/{partition-name}



.. raw:: html

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


:ref:`1667_partition_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/partition



.. raw:: html

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


:ref:`1667_partition_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/partition/{partition-name}



.. raw:: html

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


:ref:`1667_partition_attributes`



.. 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/partition/{partition-name}



.. raw:: html

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


:ref:`1667_partition_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1667_partition_list:

partition-list
--------------


    partition-list is **JSON List** of :ref:`1667_partition_attributes` 

        partition-list : [

             { :ref:`1667_partition_attributes` },

             { :ref:`1667_partition_attributes` },

             ...

         ]

.. _1667_partition_attributes:

partition attributes
--------------------

    **application-type**

        **Description** 'adc': Application type ADC; 'cgnv6': Application type CGNv6; 

        **Type:** string

        **Supported Values:** adc, cgnv6

    **id**

        **Description** Specify unique Partition id

        **Type:** number

    **partition-name**

        **Description** Object partition name

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

    **shared-vlan**

        **Description:** shared-vlan is a **JSON Block**.  Please see below for :ref:`1667_shared-vlan` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/partition/{partition-name}/shared-vlan <partition>`

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1667_template` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/partition/{partition-name}/template <partition>`

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

.. _1667_shared-vlan:

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

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

    **allowable-ip-range**

        **Type:** List

    **allowable-ipv6-range**

        **Type:** List

    **mgmt-floating-ip-address**

        **Description** IPv4 Address for Shared VLAN Mgmt IP Address

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vlan**

        **Description** 

        **Type:** number

        **Range:** 2-4094

    **vrid**

        **Description** Specify VRRP-A vrid

        **Type:** number

        **Range:** 0-31

.. _1667_template:

template
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **resource-accounting**

        **Description** Attach a resource accounting template (Name of the template)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters