.. _partition_admin:

partition-admin
===============

Partition admin user configuration


partition-admin Specification
-----------------------------

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

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

	 **Object Key(s)**                     *user*

	 **Collection Name**                   :ref:`2534_partition-admin_list`

	 **Collection URI**                    /axapi/v3/partition-admin

	                                       

	 **Element Name**                      partition-admin

	 **Element URI**                       /axapi/v3/partition-admin/{user}

	 **Element Attributes**                partition-admin_attributes

	 **Partition Visibility**              private

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



.. raw:: html

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


:ref:`2534_partition-admin_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-admin



.. raw:: html

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


:ref:`2534_partition-admin_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-admin/{user}



.. raw:: html

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


:ref:`2534_partition-admin_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-admin



.. raw:: html

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


:ref:`2534_partition-admin_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-admin/{user}



.. raw:: html

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


:ref:`2534_partition-admin_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/partition-admin/{user}



.. raw:: html

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


:ref:`2534_partition-admin_attributes`



.. raw:: html

   </td><td></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/partition-admin



.. raw:: html

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


:ref:`2534_partition-admin_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/partition-admin/{user}



.. raw:: html

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


:ref:`2534_partition-admin_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2534_partition-admin_list:

partition-admin-list
--------------------


    partition-admin-list is **JSON List** of :ref:`2534_partition-admin_attributes` 

        partition-admin-list : [

             { :ref:`2534_partition-admin_attributes` },

             { :ref:`2534_partition-admin_attributes` },

             ...

         ]

.. _2534_partition-admin_attributes:

partition-admin attributes
--------------------------

    **access-type**

        **Description** 

        **Type:** string

        **Format:** enum-list

        **Default:** axapi,cli,web

    **action**

        **Description** 'enable': Enable user; 'disable': Disable user; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **encrypted**

        **Description** Specify an ENCRYPTED password string (User password)

    **passwd-string**

        **Description** Config user password

        **Type:** string

        **Format:** password

    **privilege-partition**

        **Description** 'partition-enable-disable': Set per-partition enable/disable privilege; 'partition-read': Set per-partition read privilege; 'partition-write': Set per-partition write privilege; 

        **Type:** string

        **Supported Values:** partition-enable-disable, partition-read, partition-write

        **Default:** partition-read

    **trusted-host**

        **Description** Set trusted network administrator can login in

        **Type:** boolean

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

        **Default:** 0

    **trusted-host-cidr**

        **Description** Trusted IP Address with network mask

        **Type:** string

        **Format:** ipv4-cidr

    **user**

        **Description** Partition admin user name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

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