Apache CloudStack 4.23.0.0 Root Admin API Reference

issueOutOfBandManagementPowerAction

Initiates the specified power action to the host's out-of-band management interface

Request parameters

Parameter NameDescriptionRequired
actionOut-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUStrue
hostidThe ID of the hosttrue
timeoutOptional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout settingfalse

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