1.1. Description
Powercycle a host. This method immediately executes a powercycle of the host. No graceful shutdown is run on the host at the operating system level. It is recommended that this method only be run when the normal operating shutdown/reboot sequence has failed or is unavailable. You can only powercycle machines in the Allocated , Free , and Immutable states.
1.2. URL
/cubit_api/1/powercycle
1.3. Authentication
This method requires authentication using an API key.
1.4. Parameters
force ( zero or once )
If the machine being powercycled is a virtual host, the force option is required. The only valid value for this parameter is True.
Type: String
host ( Required, once )
Fully qualified hostname to powercycle.
Type: String
sig ( Required, once )
API authentication hash signature.
Type: String
userid ( Required, once )
The login name of the user initiating the request.
Type: String
1.5. Example Response
Successful completion of powercycle:
<?xml version='1.0'?>
<cubit version='1'>
<status>OK</status>
</cubit>
If the user is unauthorized, or the host does not exist:
<?xml version='1.0'?>
<cubit version='1'>
<error>You are not authorized to powercycle this host.</error>
</cubit>
1.6. Response Codes
- 200 - ok
- 400 - Login failed / Insufficient permissions
