Retrieve a Rack | NVIDIA Infra Controller

curl -G https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/rack/id \
     -H "Authorization: Bearer <token>" \
     -d siteId=siteId

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Rack-01",
  "manufacturer": "Dell",
  "model": "PowerEdge R750",
  "serialNumber": "SN-RACK-001",
  "description": "Primary compute rack",
  "location": {
    "region": "us-east-1",
    "datacenter": "DC-01",
    "room": "Room-A",
    "position": "A1"
  },
  "components": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "componentId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "type": "ComponentTypeCompute",
      "name": "Server-01",
      "serialNumber": "SN-SRV-001",
      "manufacturer": "Dell",
      "firmwareVersion": "2.1.0",
      "slotId": 1,
      "trayIdx": 0,
      "hostId": 0,
      "bmcs": [
        {
          "type": "BmcTypeHost",
          "macAddress": "AA:BB:CC:DD:EE:01",
          "ipAddress": "10.0.0.101"
        }
      ],
      "powerState": "on"
    }
  ]
}

Get a Rack by ID.

Org must have an Infrastructure Provider entity. User must have FORGE_PROVIDER_ADMIN authorization role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current

``` 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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

idstringRequired

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site

includeComponentsbooleanOptional

Include rack components in response

Response

idstringformat: "uuid"

Unique identifier of the Rack

namestring

Name of the Rack

manufacturerstring

Manufacturer of the Rack

modelstring

Model of the Rack

serialNumberstring

Serial number of the Rack

descriptionstring

Description of the Rack

locationobject

Physical location of a Rack

componentslist of objects

Components within the Rack. Only returned when includeComponents is true.

Errors

403

Forbidden Error

404

Not Found Error