.. _system_ipmi_user:

system ipmi user
================

Add, Change or Disable IPMI users


user Specification
------------------

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

	===================================== =========================================================
	 **Type**                              *operational*

	 **Element Name**                      user

	 **Element URI**                       /axapi/v3/system/ipmi/user

	 **Element Attributes**                user_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`user schema <system-ipmi-user/system-ipmi-user.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'>


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/system/ipmi/user



.. raw:: html

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


:ref:`3308_user_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3308_user_attributes:

user attributes
---------------

    **add**

        **Description** Add a new IPMI user (IPMI User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **administrator**

        **Description** Full control

        **Type:** boolean

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

        **Default:** 0

    **callback**

        **Description** Lowest privilege level

        **Type:** boolean

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

        **Default:** 0

    **disable**

        **Description** Disable an existing IPMI user (IPMI User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **newname**

        **Description** New IPMI User Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **newpass**

        **Description** New Password

        **Type:** string

        **Format:** password

        **Maximum Length:** 17 characters

        **Maximum Length:** 1 characters

    **operator**

        **Description** Most BMC commands are allowed

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** Password

        **Type:** string

        **Format:** password

        **Maximum Length:** 17 characters

        **Maximum Length:** 1 characters

    **privilege**

        **Description** Change an existing IPMI user privilege (IPMI User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **setname**

        **Description** Change User Name (Current IPMI User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **setpass**

        **Description** Change Password (IPMI User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **user**

        **Description** Only 'benign' commands are allowed

        **Type:** boolean

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

        **Default:** 0