Edit a cabinet

How to modify a cabinet.

Request

Security

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

HTTP method

POST /manager/api/{apiResponseType}/editCabinet.adm HTTP/1.1 HOST: {manager.dsnet} id={vaultTemplateId}

Curl method

curl -u {admin}:{password} -k “https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editCabinet.adm” -d “id={cabinetId}”

Parameters

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

The ID of the cabinet to be modified.

name String Optional  

The name of the cabinet to be created. The name of the cabinet cannot be empty and cannot match the name of a preexisting cabinet.

height Long Optional  

The height of the cabinet. The new height must respect the currently racked items in the cabinet.

siteId Integer Optional  

The site ID of where the cabinet exists.

description String Optional  

A description of the cabinet.

slots Map[{slot}] Optional  

An array of slots, containing rackable items The array index maps to the slot number of the cabinet. For example, slots[2] corresponds to slot 2 of the cabinet. The value of slots element can be 1 of three forms: device:<deviceId>, generic:<genericDeviceName>, or '', which means empty.

.Slot device with ID 3 into slot 5 of cabinet 4 [example] ==== [source,console] —— id=4&slots[5]=device:3. —— ====

.Slot generic device called PowerSupply to slot 23 of cabinet 4 [example] ==== [source,console] —— id=4&slots[23]=generic:PowerSupply —— ====

.Empty slot 25 of cabinet 6 [example] ==== [source,console] —— id=6&slots[25]= —— ====

.Rack device 4 and device 5 to slots 6 and 7 or cabinet 8 [example] ==== [source,console] —— id=8&slots[6]=device:4&slots[7]=device:5 —— ====

Note: Racking a device to a particular slot via the API unracks any device already occupying said slot.