Apache CloudStack v4.9.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