.. _system_ipmi:

system ipmi
===========

Perform IPMI related operations


ipmi Specification
------------------

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

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

	 **Element Name**                      ipmi

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

	 **Element Attributes**                ipmi_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3309_ipmi_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3309_ipmi_attributes:

ipmi attributes
---------------

    **ip**

        **Description:** ip is a **JSON Block**.  Please see below for :ref:`3309_ip` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/ipmi/ip <system_ipmi_ip>`

    **ipsrc**

        **Description:** ipsrc is a **JSON Block**.  Please see below for :ref:`3309_ipsrc` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/ipmi/ipsrc <system_ipmi_ipsrc>`

    **reset**

        **Description** Reset IPMI Controller

        **Type:** boolean

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

        **Default:** 0

    **tool**

        **Description:** tool is a **JSON Block**.  Please see below for :ref:`3309_tool` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/ipmi/tool <system_ipmi_tool>`

    **user**

        **Description:** user is a **JSON Block**.  Please see below for :ref:`3309_user` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/ipmi/user <system_ipmi_user>`

.. _3309_ip:

ip
^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **default-gateway**

        **Description** Default gateway address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-address**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-netmask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

.. _3309_ipsrc:

ipsrc
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dhcp**

        **Description** IP addr obtained by BMC running DHCP

        **Type:** boolean

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

        **Default:** 0

    **static**

        **Description** Manually configured static IP address

        **Type:** boolean

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

        **Default:** 0

.. _3309_tool:

tool
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cmd**

        **Description** Command to execute in double quotes

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _3309_user:

user
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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