Sign in
Machine

Retrieve DPU Machines attached to a host Machine

Retrieve DPU Machines attached to the host Machine, including network configuration fields exposed by the REST API. Internal-only and sensitive fields from the Core configuration are omitted.

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.
get/v2/org/{org}/nico/machine/{machineId}/dpu

Response

OK

idstring required

ID of the DPU Machine

infrastructureProviderIdstring uuid required

ID of the Infrastructure Provider that owns the host Machine

siteIdstring uuid required

ID of the Site that the host Machine belongs to

hostMachineIdstring required

ID of the host Machine that this DPU is attached to

dpuAgentVersionstring

Version of the DPU agent running on the DPU

labelsobject

Labels associated with the DPU

statestring required

Lifecycle state of the DPU

lastRebootedstring date-time nullable

Last reboot timestamp

Example response

[
  {
    "bmcInfo": {
      "ip": "10.217.133.5",
      "mac": "C8:4B:D6:7A:C9:8A",
      "version": "1",
      "firmwareRevision": "6.00"
    },
    "dmiData": {
      "boardName": "7Z23CTOLWB",
      "boardSerial": ".C1KS2CS002G.",
      "boardVersion": "06",
      "biosDate": "03/30/2023",
      "biosVersion": "U8E122J-1.51",
      "productSerial": "J1050ACR",
      "chassisSerial": "J1050ACR"
    },
    "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": [
        {
          "id": "FailedValidationTest",
          "target": "DcgmFullShort",
          "inAlertSince": null,
          "message": "Failed validation test:\nName:DcgmFullShort\nCommand:dcgmi\nArgs:diag -r 2",
          "tenantMessage": null,
          "classifications": [
            "PreventAllocations"
          ]
        }
      ]
    },
    "dpuNetworkConfig": {
      "adminInterface": {
        "networkSecurityGroup": {
          "rules": [
            {
              "rule": {
                "direction": "INGRESS",
                "sourcePortRange": "80-81",
                "destinationPortRange": "80-81",
                "protocol": "TCP",
                "action": "PERMIT",
                "sourcePrefix": "10.5.44.0/24",
                "destinationPrefix": "10.5.44.0/24"
              }
            }
          ]
        }
      },
      "tenantInterfaces": [
        {
          "networkSecurityGroup": {
            "rules": [
              {
                "rule": {
                  "direction": "INGRESS",
                  "sourcePortRange": "80-81",
                  "destinationPortRange": "80-81",
                  "protocol": "TCP",
                  "action": "PERMIT",
                  "sourcePrefix": "10.5.44.0/24",
                  "destinationPrefix": "10.5.44.0/24"
                }
              }
            ]
          }
        }
      ]
    },
    "placementInRack": {
      "slotNumber": 1,
      "trayIndex": 0
    }
  }
]

Changes

Changed in 2 of the 90 revisions of this API.14

  • 6c8dcd576e4b13See the full diff
    • ▲

      the items/health/alerts/items/inAlertSince response's property type/format changed from string null/ to string null/date-time for status 200

      response-property-type-changed

    • ○

      the response property items/health/alerts/items/id became required for the status 200

      response-property-became-required

    • ○

      the response property items/health/alerts/items/message became required for the status 200

      response-property-became-required

    • ○

      the response property items/health/successes/items/id became required for the status 200

      response-property-became-required

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7e87e84ae9f91See the full diff
    • ○

      endpoint added

      endpoint-added