Retrieve DPU Machines attached to a host Machine

GET

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

GET

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

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

1 [
2   {
3     "id": "fm100dsg4ekcb4sdi6hkqn0iojhj18okrr8vct64luh8957lfe8e69vme20",
4     "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
5     "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
6     "hostMachineId": "fm200hkq8xncf7tgm9plurt4smono52pqvv2gxt97pyk2398qjk2a73qjf64",
7     "state": "Ready",
8     "dpuNetworkConfig": {
9       "asn": 65001,
10       "vniDevice": "pf0hpf",
11       "managedHostConfigVersion": "v1.2.3",
12       "useAdminNetwork": true,
13       "remoteId": "host-machine-123",
14       "vpcIsolationBehavior": "VPC_ISOLATION_MUTUAL",
15       "statefulAclsEnabled": true,
16       "enableDhcp": false,
17       "isPrimaryDpu": true,
18       "datacenterAsn": 65000,
19       "dhcpServers": [
20         "192.168.1.1"
21       ],
22       "managedHostConfig": {
23         "loopbackIp": "10.0.0.1"
24       },
25       "tenantInterfaces": [
26         {
27           "functionType": "VIRTUAL_FUNCTION",
28           "vlanId": 100,
29           "vni": 5000,
30           "gateway": "192.168.10.1",
31           "ip": "192.168.10.10",
32           "interfacePrefix": "eth0",
33           "prefix": "192.168.10.0/24",
34           "fqdn": "tenant-vm.example.com",
35           "vpcVni": 6000,
36           "isL2Segment": false
37         }
38       ],
39       "instanceNetworkConfigVersion": "v2.0.1",
40       "routeServers": [
41         "192.168.2.1"
42       ]
43     },
44     "dpuAgentVersion": "1.0.0",
45     "labels": {
46       "env": "prod"
47     }
48   }
49 ]

Retrieve DPU Machines attached to the host Machine, including the full network configuration sent to the DPU agent.

The response is built by scheduling a synchronous Temporal GetDpuMachines workflow against the Machine’s Site for the DPU Machine IDs referenced by the host Machine’s interfaces.

Authorization:

Access is restricted to users associated with the Machine’s Site. Either of the following grants access:

The caller’s org has an Infrastructure Provider entity that owns the Machine’s Site, and the user has authorization role with PROVIDER_ADMIN suffix on that org.
The caller’s org has a Tenant entity with TargetedInstanceCreation enabled and an active Tenant Account on the Machine’s Site’s Infrastructure Provider, and the user has authorization role with TENANT_ADMIN suffix on that org.

Retrieve DPU Machines attached to the host Machine, including the full network configuration sent to the DPU agent. The response is built by scheduling a synchronous Temporal `GetDpuMachines` workflow against the Machine's Site for the DPU Machine IDs referenced by the host Machine's interfaces. **Authorization:** Access is restricted to users associated with the Machine's Site. Either of the following grants access: * The caller's org has an Infrastructure Provider entity that owns the Machine's Site, and the user has authorization role with `PROVIDER_ADMIN` suffix on that org. * The caller's org has a Tenant entity with `TargetedInstanceCreation` enabled and an active Tenant Account on the Machine's Site's Infrastructure Provider, and the user has authorization role with `TENANT_ADMIN` suffix on that org.

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 host Machine

Response

idstring

ID of the DPU Machine (matches the host Machine ID for the DPU as reported by NICo Core)

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider that owns the host Machine

siteIdstringformat: "uuid"

ID of the Site that the host Machine belongs to

hostMachineIdstring

ID of the host Machine that this DPU is attached to

statestring

Lifecycle state of the DPU as reported by NICo Core

dpuNetworkConfigobject

Complete network configuration sent to the DPU agent

dpuAgentVersionstring

Version of the DPU agent running on the DPU

bmcInfoobject

BMC (Baseboard Management Controller) information for the DPU

dmiDataobject

DMI (Desktop Management Interface) data reported for the DPU

interfaceslist of objects

Interfaces reported on the DPU

softwareComponentslist of objects

Software components reported on the DPU

healthobject

Health information for the DPU

labelsmap from strings to strings

Labels associated with the DPU

lastRebooteddatetime or null

Last reboot timestamp reported by NICo Core

placementInRackobject

Physical placement of the DPU Machine within its Rack, when known

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error