Retrieve a Machine | NVIDIA Infra Controller

curl https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/machine/machineId \
     -H "Authorization: Bearer <token>"

{
  "id": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "instanceTypeId": "2e016c02-2c67-48aa-b289-5d3ca6320c52",
  "instanceId": "59bdaaff-3998-4fd9-a140-8749beeb605e",
  "tenantId": "99819e6e-4017-4021-9edd-ea1bdf4dbd59",
  "controllerMachineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
  "controllerMachineType": "x86_64",
  "hwSkuDeviceType": "cpu",
  "vendor": "Lenovo",
  "productName": "ThinkSystem SR670 V2",
  "serialNumber": "J1060ACR.D3KS2CS001G",
  "machineCapabilities": [
    {
      "type": "CPU",
      "name": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
      "frequency": "3.0GHz",
      "cores": 18,
      "threads": 36,
      "count": 2
    },
    {
      "type": "Memory",
      "name": "Corsair Vengeance LPX",
      "capacity": "32GB",
      "count": 4
    },
    {
      "type": "Network",
      "name": "MT42822 BlueField-2 integrated ConnectX-6 Dx network controller",
      "count": 2,
      "deviceType": "DPU"
    },
    {
      "type": "Storage",
      "name": "Dell Ent NVMe CM6 RI 1.92TB",
      "capacity": "1.92TB",
      "count": 2
    },
    {
      "type": "GPU",
      "name": "NVIDIA A100 PCIe",
      "capacity": "80GB",
      "count": 2
    },
    {
      "type": "InfiniBand",
      "name": "MT28908 Family [ConnectX-6]",
      "vendor": "Mellanox Technologies",
      "count": 2
    }
  ],
  "machineInterfaces": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "controllerInterfaceId": "ad3dac49-741d-4c1f-815c-c020127c532f",
      "controllerSegmentId": "f2207a3c-1847-42e5-bf2c-cd015f87a2bc",
      "attachedDpuMachineID": "fm100dsg4ekcb4sdi6hkqn0iojhj18okrr8vct64luh8957lfe8e69vme20,",
      "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
      "hostname": "example.com",
      "isPrimary": true,
      "macAddress": "00:00:5e:00:53:af",
      "ipAddresses": [
        "192.156.7.23",
        "202.88.37.112"
      ],
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "maintenanceMessage": null,
  "health": {
    "source": "aggregate-host-health",
    "observedAt": null,
    "successes": [
      {
        "id": "BgpDaemonEnabled",
        "target": null
      },
      {
        "id": "BgpStats",
        "target": null
      },
      {
        "id": "DhcpServer",
        "target": null
      },
      {
        "id": "DpuDiskUtilizationCheck",
        "target": null
      },
      {
        "id": "FanSpeed",
        "target": "System Board Fan1A"
      },
      {
        "id": "PowerSupply",
        "target": "PS1 Status"
      },
      {
        "id": "Temperature",
        "target": "CPU1 Temp"
      },
      {
        "id": "Temperature",
        "target": "System Board Exhaust Temp"
      },
      {
        "id": "Voltage",
        "target": "CPU1 1P8 PG"
      }
    ],
    "alerts": []
  },
  "labels": {
    "RackIdentifier": "GVX11F01C02",
    "ServerName": "SITE1-C03-Server-02"
  },
  "status": "Ready",
  "isUsableByTenant": true,
  "statusHistory": [
    {
      "status": "Ready",
      "message": "Machine is online and ready",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Org must have either an Infrastructure Provider entity or a Tenant entity.

If org has an Infrastructure Provider entity, then a user with FORGE_PROVIDER_ADMIN role can request details for any Machine on any Site owned by the Provider.

If org has a Tenant entity, then a user with FORGE_TENANT_ADMIN role can request details for any Machine associated with Tenant’s active Instances.

Org must have either an Infrastructure Provider entity or a Tenant entity. If org has an Infrastructure Provider entity, then a user with `FORGE_PROVIDER_ADMIN` role can request details for any Machine on any Site owned by the Provider. If org has a Tenant entity, then a user with `FORGE_TENANT_ADMIN` role can request details for any Machine associated with Tenant's active Instances.

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

machineIdstringRequired

Query parameters

includeRelationenumOptional

Related entity to expand

Allowed values:

includeMetadatabooleanOptional

Include Machine metadata e.g. BMC, DPU, GPU and Interface data. Can only be requested by Provider.

Response

idstringRead-only

Unique ID of Machine

infrastructureProviderIdstringRead-onlyformat: "uuid"

ID of the Provider that owns the Machine

siteIdstringformat: "uuid"

ID of the Site the Machine belongs to

instanceTypeIdstring or nullformat: "uuid"

ID of the Instance Type, if assigned

instanceIdstring or nullformat: "uuid"

ID of the Instance if this Machine is assigned to one

tenantIdstring or nullformat: "uuid"

ID of the Tenant that owns the Instance if the Machine is assigned to one

controllerMachineIdstring

ID of the Machine at Site, now same as the primary ID

controllerMachineTypestring

Denotes architecture (x86 vs ARM) of the Machine

hwSkuDeviceTypestring or null

SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

vendorstring

Name of the vendor of the Machine

productNamestring

Product name of the Machine

serialNumberstring

Serial number of the Machine, only visible to Provider

machineCapabilitieslist of objects

machineInterfaceslist of objects

maintenanceMessagestring or null

If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

healthobject

Describes results of various Machine health probes and alerts

metadataobject

Only available to Providers. Returned if includeMetadata query param is specified. Otherwise attribute is omitted from response.

labelsmap from strings to strings

statusenum

Status values for Machine objects

isUsableByTenantbooleanRead-only

Indicates whether the machine is usable by or currently in use by a tenant.

statusHistorylist of objects

createddatetimeRead-only

updateddatetimeRead-only

Errors

403

Forbidden Error