massSparePool

Classes SoftLayer_Hardware_SecurityModule750
Tags method sldn hardware

SoftLayer_Hardware_SecurityModule750::massSparePool

Allows multiple servers to be added to or removed from the spare pool.

Description

The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.

Parameters

Name Type Description
hardwareIds string[] List of hardware ids to be added/removed from spare pool
action string Action to ‘add’ server to spare pool or remove (use ‘activate’) from spare pool
newOrder boolean Set to true if a Spare Pool Server was ordered; otherwise false

Required Headers

Optional Headers

  • None

Return Values

Error Handling

  • Throws the exception ‘You do not have permission to this service.’ when a user does not have permission to Issue OS Reloads.
  • Throws the exception ‘There is currently an outstanding transaction for this server.’ when there is a current hardware update. 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, boolean]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/massSparePool'