Edit a device

Edit an approved device.

Request

Security

Table 1. Roles capable of executing the Edit Device API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

POST /manager/api/{apiResponseType}/1.0/editDevice.adm HTTP/1.1 Host:{manager.dsnet} id={deviceId}&alias={alias}

Curl method

curl -u {admin}:{password} -k “https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editDevice.adm” -d “id={deviceId}&alias={alias}”

Parameters

Table 2. Request Parameters for Edit Device (editDevice) API method
Parameter Type Usage Default Description
id Long Required  

ID of device.

alias String Optional  

Alias to assign to device.

description String Optional  

Description to assign to device.

siteId Long Optional  

ID of site on which to place device.

accessPoolId Long Accesser nodes only  

Access Pool ID to which device should point.

driveFailureWarningCount Integer Slicestor nodes only  

Quantity of drives that must be down for device to report a warning level.

driveFailureErrorCount Integer Slicestor nodes only  

Quantity of drives that must be down for device to report an error level.

managementVaultId Long Management Vault Configuration = manual  

Devices in storage pools must be set at the storage pool level.

Accessers and Managers can still be set individually.

advancedConfiguration String Advanced Configuration = enabled   key=value pairs for various advanced configuration options to set for the device.
tagMap String Optional   add or remove the tag.
tags String Optional  

Set of tag names to place on the device.

Response

Returns success or failure status.

Parameters

None other than the default response parameters shown in Common response parameters.

  • protocolType affects Accesser devices only.
  • driveFailureWarningCount and driveFailureErrorCount affects Slicestor devices only.
  • Individual drive health configuration must be enabled before modifying the driveFailureWarningCount and driveFailureErrorCount.