SoftLayer Hardware Server::powerCycle

From SoftLayer Development Network Wiki

powerCycle is a member of the SoftLayer_Hardware_Server service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers

Overview

Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

User Access

Users wishing to execute powerCycle must have the following permissions assigned to their account:

• Reboot
• View Hardware Details

Return Type

powerCycle returns the bool data type.

Headers

Required Headers

powerCycle requires the following headers set:

• authenticate
• SoftLayer_Hardware_ServerInitParameter