.. _system_ipmi_tool:

system ipmi tool
================

Command to execute in double quotes


tool Specification
------------------

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

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

	 **Element Name**                      tool

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

	 **Element Attributes**                tool_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3307_tool_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3307_tool_attributes:

tool attributes
---------------

    **cmd**

        **Description** Command to execute in double quotes

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters