Retrieve a Tray

View as Markdown

Get a Tray by ID.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired
Name of the Org
idstringRequiredformat: "uuid"
ID of the Tray

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site

Response

OK
idstringformat: "uuid"
Unique identifier of the Tray
componentIdstring
ID of the component
typeenum
Type of the tray
namestring
Name of the tray
manufacturerstring
Manufacturer of the tray
modelstring
Model of the tray
serialNumberstring
Serial number of the tray
descriptionstring
Description of the tray
firmwareVersionstring
Firmware version of the tray
powerStatestring
Current power state of the tray
operationStatusenum

Flow-derived operability phase of the tray

leakStatusenum
Whether the tray is considered leaking coolant
positionobject
Position of the Tray within the Rack
bmcslist of objects

BMC (Baseboard Management Controller) entries for the tray

rackIdstringformat: "uuid"
ID of the rack this tray belongs to

Errors

403
Forbidden Error
404
Not Found Error