DPU Machine

Retrieve a DPU Machine

Changed on

Retrieve a DPU Machine by ID. By default, DPU network configuration is not included. Set includeNetworkConfig query parameter to true to retrieve the network configuration fields.

User must have authorization role with PROVIDER_ADMIN suffix on the org that owns the Site.

get/v2/org/{org}/nico/dpu/{dpuMachineId}

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/dpu/{dpuMachineId}
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid required

ID of the Site

includeNetworkConfigboolean

Include network configuration fields exposed by the REST API

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 required

Version of the DPU agent running on the DPU

labelsobject nullable required

Labels associated with the DPU

statestring required

Lifecycle state of the DPU

lastRebootedstring date-time nullable required

Last reboot timestamp

Example response

{
  "bmcInfo": {
    "ip": "2001:db8::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
  },
  "lldpNeighbors": [
    {
      "macAddress": "02:00:00:00:01:b0",
      "localPort": "enp1s0np0",
      "name": "leaf-switch-01",
      "description": "Cumulus Linux",
      "ipAddresses": [
        "10.0.2.194",
        "fe80::ff:fe00:1d4"
      ],
      "chassisIdType": "mac",
      "chassisIdValue": "02:00:00:00:01:d4",
      "remotePortType": "ifname",
      "remotePortValue": "swp1",
      "medInventory": {
        "serial": "SN0000000002",
        "manufacturer": "https://www.mellanox.com",
        "model": "BlueField-3 DPU"
      }
    }
  ]
}

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 83b258e4c402Revision changes
    • info

      added the required property to the response with the status