Deployment using the API

Edit online

Replace Storage Pool Device

Replaces a device in a storage pool.

Note: Data evacuation will start shortly after a successful request, if there are vaults on the storage pool.

Request

Security

Table 1. Roles capable of executing the Replace Storage Pool Device (replaceStoragePoolDevice) API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP Method


POST /manager/api/{apiResponseType}/1.0/replaceStoragePoolDevice.adm HTTP/1.1
Host:{manager.dsnet}
sourceId={deviceId}&destinationId={destinationId}

Curl Method


curl -u {admin}:{password} -k
"https://{manager.dsnet}/manager/api/json/1.0/replaceStoragePoolDevice.adm" -d
"sourceId={deviceId}&destinationId={destinationId}"
Table 2. Request Parameters for Replace Storage Pool Device (replaceStoragePoolDevice) API method
Parameter Type Usage Default Description
sourceId Long Required   Slicestor device ID to be replaced in Storage Pool.
destinationId Long Required  
  • Slicestor device ID of the device being replaced.
  • This device cannot already be in a storage pool.
  • If this device has recently been replaced and is currently in the evacuation stage, it cannot be used for replacement.
evacuationEnabled Boolean Optional   Start (true) data evacuation immediately after the device is replaced or enable data evacuation later (false).
rateLimitEnabled Boolean Optional false Enable (true) or disable (false) a transfer bandwidth rate limit for the evacuation.
  • If provided and true, rateLimit is required.
  • If provided and false, a rateLimit is provided, but the rate limit is not enabled when device evacuation begins.
rateLimit Optional Optional  
  • Value to set for the bandwidth limit for the evacuation from sourceId to destinationId
  • A rate limit can be set to prevent device data evacuation from having an impact on the rest of the system Manager.
  • If not provided, there will not be a rate limit

Response

Returns success or failure status.

JSON Response Example

The default JSON success or failure response is shown in Default JSON Success Response and Default JSON Failure Response.

Parameters

None other than the default response parameters are shown in the Common Response Parameters.