API: Managing IPMI

server.ipmi.reset

Description

IPMI management interface reset.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.ipmi.start

Description

Enable IPMI access.

Command specific parameters
Name Description
serverId Server ID
sourceAddress IP address or network which is allowed to access IPMI interface, format aaa.aaa.aaa.aaa/bb.
Command specific response
Name Description
ipmi/status IPMI access status
ipmi/address IPMI interface IP address
ipmi/login IPMI login
ipmi/password IPMI password
ipmi/sourceAddress IP address or network allowed to access IPMI interface
ipmi/endTime IPMI session expiry time
Sample response
...
<ipmi>
  <status>active</status>
  <address>xxx.xxx.xxx.xxx</address>
  <login>yyy</login>
  <password>zzz</password>
  <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
  <endTime>ccc</endTime>
</ipmi>
...

server.ipmi.stop

Description

Disables IPMI access.

Command specific parameters
Name Description
serverId Server ID
sourceAddress IP address or network which is allowed to access IPMI interface
Command specific response

None.

server.ipmi.info

Description

Gets information about IPMI access.

Command specific parameters
Name Description
serverId Server ID
Command specific response
Name Description
ipmi/status IPMI access status
ipmi/address IPMI interface IP address
ipmi/login IPMI login
ipmi/password IPMI password
ipmi/sourceAddress IP address or network allowed to access IPMI interface
ipmi/endTime IPMI session expiry time
Sample response
...
<ipmi>
  <status>active</status>
  <address>xxx.xxx.xxx.xxx</address>
  <login>yyy</login>
  <password>zzz</password>
  <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
  <endTime>ccc</endTime>
</ipmi>
...

server.ipmi.change_password

Description

Gets information about IPMI access.

Command specific parameters
Name Description
serverId Server ID
Command specific response
Name Description
ipmi/status IPMI access status
ipmi/address IPMI interface IP address
ipmi/login IPMI login
ipmi/password New IPMI password
ipmi/sourceAddress IP address or network allowed to access IPMI interface
ipmi/endTime IPMI session expiry time
Sample response
...
<ipmi>
  <status>active</status>
  <address>xxx.xxx.xxx.xxx</address>
  <login>yyy</login>
  <password>zzz</password>
  <sourceAddress>aaa.aaa.aaa.aaa/bb</sourceAddress>
  <endTime>ccc</endTime>
</ipmi>
...