Apache CloudStack 4.23.0.0 Root Admin API Reference

configureOutOfBandManagement

Configures a host's out-of-band management interface

Request parameters

Parameter NameDescriptionRequired
addressThe host management interface IP addresstrue
driverThe host management interface driver, for example: ipmitooltrue
hostidThe ID of the hosttrue
passwordThe host management interface passwordtrue
portThe host management interface porttrue
usernameThe host management interface usertrue

Response Tags

Response NameDescription
actionThe out-of-band management action (if issued)
addressThe out-of-band management interface address
descriptionThe operation result description
driverThe out-of-band management driver for the host
enabledTrue if out-of-band management is enabled for the host
hostidThe ID of the host
passwordThe out-of-band management interface password
portThe out-of-band management interface port
powerstateThe out-of-band management interface powerState of the host
statusThe operation result
usernameThe out-of-band management interface username