Retrieve a Machine

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/machine/:machineId

GET

/v2/org/:org/nico/machine/:machineId

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

1 {
2   "id": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
3   "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
4   "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
5   "instanceTypeId": "2e016c02-2c67-48aa-b289-5d3ca6320c52",
6   "instanceId": "59bdaaff-3998-4fd9-a140-8749beeb605e",
7   "tenantId": "99819e6e-4017-4021-9edd-ea1bdf4dbd59",
8   "controllerMachineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
9   "controllerMachineType": "x86_64",
10   "hwSkuDeviceType": "cpu",
11   "vendor": "Lenovo",
12   "productName": "ThinkSystem SR670 V2",
13   "serialNumber": "J1060ACR.D3KS2CS001G",
14   "machineCapabilities": [
15     {
16       "type": "CPU",
17       "name": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
18       "frequency": "3.0GHz",
19       "cores": 18,
20       "threads": 36,
21       "count": 2
22     },
23     {
24       "type": "Memory",
25       "name": "Corsair Vengeance LPX",
26       "capacity": "32GB",
27       "count": 4
28     },
29     {
30       "type": "Network",
31       "name": "MT42822 BlueField-2 integrated ConnectX-6 Dx network controller",
32       "count": 2,
33       "deviceType": "DPU"
34     },
35     {
36       "type": "Storage",
37       "name": "Dell Ent NVMe CM6 RI 1.92TB",
38       "capacity": "1.92TB",
39       "count": 2
40     },
41     {
42       "type": "GPU",
43       "name": "NVIDIA A100 PCIe",
44       "capacity": "80GB",
45       "count": 2
46     },
47     {
48       "type": "InfiniBand",
49       "name": "MT28908 Family [ConnectX-6]",
50       "vendor": "Mellanox Technologies",
51       "count": 2
52     }
53   ],
54   "machineInterfaces": [
55     {
56       "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
57       "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
58       "controllerInterfaceId": "ad3dac49-741d-4c1f-815c-c020127c532f",
59       "controllerSegmentId": "f2207a3c-1847-42e5-bf2c-cd015f87a2bc",
60       "attachedDpuMachineID": "fm100dsg4ekcb4sdi6hkqn0iojhj18okrr8vct64luh8957lfe8e69vme20,",
61       "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
62       "hostname": "example.com",
63       "isPrimary": true,
64       "macAddress": "00:00:5e:00:53:af",
65       "ipAddresses": [
66         "192.156.7.23",
67         "202.88.37.112"
68       ],
69       "created": "2019-08-24T14:15:22Z",
70       "updated": "2019-08-24T14:15:22Z"
71     }
72   ],
73   "maintenanceMessage": null,
74   "health": {
75     "source": "aggregate-host-health",
76     "observedAt": null,
77     "successes": [
78       {
79         "id": "BgpDaemonEnabled",
80         "target": null
81       },
82       {
83         "id": "BgpStats",
84         "target": null
85       },
86       {
87         "id": "DhcpServer",
88         "target": null
89       },
90       {
91         "id": "DpuDiskUtilizationCheck",
92         "target": null
93       },
94       {
95         "id": "FanSpeed",
96         "target": "System Board Fan1A"
97       },
98       {
99         "id": "PowerSupply",
100         "target": "PS1 Status"
101       },
102       {
103         "id": "Temperature",
104         "target": "CPU1 Temp"
105       },
106       {
107         "id": "Temperature",
108         "target": "System Board Exhaust Temp"
109       },
110       {
111         "id": "Voltage",
112         "target": "CPU1 1P8 PG"
113       }
114     ],
115     "alerts": []
116   },
117   "labels": {
118     "RackIdentifier": "GVX11F01C02",
119     "ServerName": "SITE1-C03-Server-02"
120   },
121   "status": "Ready",
122   "isUsableByTenant": true,
123   "statusHistory": [
124     {
125       "status": "Ready",
126       "message": "Machine is online and ready",
127       "created": "2019-08-24T14:15:22Z",
128       "updated": "2019-08-24T14:15:22Z"
129     }
130   ],
131   "created": "2019-08-24T14:15:22Z",
132   "updated": "2019-08-24T14:15:22Z"
133 }

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

If org has an Infrastructure Provider entity, then a user with 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 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 `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 `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://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/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://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

machineIdstringRequired

ID of the Machine

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 or null

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 or null

Name of the vendor of the Machine

productNamestring or null

Product name of the Machine

serialNumberstring or null

Serial number of the Machine, only visible to Provider

machineCapabilitieslist of objects

List of capabilities of the machine

machineInterfaceslist of objects

List of admin interfaces of the machine

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

Health information about the machine

metadataobject

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

labelsmap from strings to strings

User-specified Machine labels

statusenum

Status represents the status of the machine

isUsableByTenantbooleanRead-only

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

statusHistorylist of objects

Chronological status history for the Machine

createddatetimeRead-only

Date/time when the Machine was created

updateddatetimeRead-only

Date/time when the Machine was last updated

Errors

403

Forbidden Error