Edit the data evacuation rate limit

Edit online

Change or remove the rate limit for any source devices with device evacuation.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit Data Evacuation Rate Limit (editDataEvacuationRateLimit) API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/editDataEvacuationRateLimit.adm HTTP/1.1
Host:{manager.dsnet} rateLimitEnabled[{deviceId}]={true|false} &rateLimitSizes[{deviceId}]={limitInMB}

Curl method

Edit online

curl -u {admin}:{password} -k
”https://{manager.dsnet}/manager/api/json/1.0/editDataEvacuationRateLimit.adm“ -d
”rateLimitEnabled[{deviceId}]={true|false}&rateLimitSizes[{deviceId}]={limitInMB}“

Parameters

Edit online
Table 2. Request Parameters for Edit Data Evacuation Rate Limit (editDataEvacuationRateLimit) API method
Parameter Type Usage Default Description
rateLimitSizes Map[{deviceId}] Optional  
  • Map containing IDs and rate limits for any source devices on which device evacuation is ongoing.
  • A rate limit might be wanted when there is a desire to lower the impact that device data evacuation has on the rest of the system and overall network.
  • If not provided for a device, the current value for the bandwidth limit on the device is retained.
  • The value that is passed is the rate limit in megabytes.
  • Device evacuation with no rate limit is limited only by the underlying hardware.
rateLimitEnabled Map[{deviceId}] Required