---
title: "Retrieve a DPU Machine"
method: GET
path: "/v2/org/{org}/nico/dpu/{dpuMachineId}"
tags: ["DPU Machine"]
---

# Retrieve a DPU Machine

`GET /v2/org/{org}/nico/dpu/{dpuMachineId}`

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.

## Query parameters

- `siteId` string, uuid, required
- `includeNetworkConfig` boolean

## Response `200`

OK

- DpuMachineSummary — A DPU Machine returned by a site-scoped DPU lookup. Network configuration is null unless the endpoint supports and receives an explicit request for it.
  - `id` string, required — ID of the DPU Machine
  - `infrastructureProviderId` string, uuid, required — ID of the Infrastructure Provider that owns the host Machine
  - `siteId` string, uuid, required — ID of the Site that the host Machine belongs to
  - `hostMachineId` string, required — ID of the host Machine that this DPU is attached to
  - `dpuAgentVersion` string, required — Version of the DPU agent running on the DPU
  - `bmcInfo` MachineBMCInfo, required — Describes BMC information of a Machine
    - `ip` string, ipv4, nullable — IP address of the Machine BMC
    - `mac` string, nullable — MAC address of the Machine BMC
    - `version` string, nullable — Version reported by the Machine BMC
    - `firmwareRevision` string, nullable — Firmware revision reported by the Machine BMC
  - `dmiData` MachineDMIData, required — Describes DMI data of a Machine
    - `boardName` string, nullable — DMI board name reported by the Machine
    - `boardSerial` string, nullable — DMI board serial number reported by the Machine
    - `boardVersion` string, nullable — DMI board version reported by the Machine
    - `biosDate` string, nullable — DMI BIOS release date reported by the Machine
    - `biosVersion` string, nullable — DMI BIOS version reported by the Machine
    - `productName` string, nullable — DMI product name reported by the Machine
    - `productSerial` string, nullable — DMI product serial number reported by the Machine
    - `chassisSerial` string, nullable — DMI chassis serial number reported by the Machine
    - `sysVendor` string, nullable — DMI system vendor reported by the Machine
  - `interfaces` DpuMachineInterface[], nullable, required — Interfaces reported on the DPU
    - `id` string — Interface ID
    - `machineId` string — ID of the Machine the interface belongs to
    - `segmentId` string — Network segment ID
    - `hostname` string — Hostname of the interface
    - `primaryInterface` boolean — Whether this is the primary interface
    - `macAddress` string — MAC address of the interface
    - `address` string[] — IP addresses assigned to the interface
    - `vendor` string, nullable — Vendor of the interface
    - `created` string, date-time, nullable — Timestamp when the interface was first observed
    - `lastDhcp` string, date-time, nullable — Timestamp of the last DHCP lease for the interface
    - `isBmc` boolean — Whether this interface is a BMC interface
  - `softwareComponents` DpuMachineSoftwareComponent[], nullable, required — Software components reported on the DPU
    - `name` string — Name of the software component
    - `version` string — Version of the software component
    - `url` string — URL where the software component can be obtained
  - `health` MachineHealth, required — Describes results of various Machine health probes and alerts
    - `source` string — Describes how the health report was generated
    - `observedAt` string, nullable — Date/time when health report was generated
    - `successes` MachineHealthProbeSuccess[] — Results from successful health probes for the Machine
      - `id` string, required — Health probe identifier
      - `target` string, nullable — Specific component targeted by health probe
    - `alerts` MachineHealthProbeAlert[] — Results from failed health probes for the Machine
      - `id` string, required — Health probe identifier
      - `target` string, nullable — Specific component targeted by health probe
      - `inAlertSince` string, date-time, nullable — Date/time since the alert has been in effect
      - `message` string, required — Details of the failed health probe result
      - `tenantMessage` string, nullable — Information provided by Tenant, if any
      - `classifications` string[] — Classifications for this alert, category or impact
  - `labels` object, nullable, required — Labels associated with the DPU
  - `state` string, required — Lifecycle state of the DPU
  - `dpuNetworkConfig` DpuNetworkConfig, required — Network configuration fields exposed for a DPU Machine. Internal-only and sensitive fields from the Core configuration are omitted.
    - `asn` integer, required — Autonomous System Number for BGP routing
    - `dhcpServers` string[] — List of DHCP server IP addresses
    - `vniDevice` string, required — VNI device name
    - `managedHostConfig` ManagedHostNetworkConfig — Network configuration for the managed host
      - `loopbackIp` string, required — Loopback IP address
      - `quarantineState` ManagedHostQuarantineState — Quarantine state for the managed host
        - `mode` string, required — Quarantine mode
        - `reason` string, nullable — Reason for quarantine
    - `managedHostConfigVersion` string, required — Version of the managed host configuration
    - `useAdminNetwork` boolean, required — Whether to use the admin network
    - `adminInterface` DpuInterfaceConfig — Interface configuration for DPU networking
      - `functionType` string, required — Function type (e.g. PHYSICAL_FUNCTION, VIRTUAL_FUNCTION)
      - `vlanId` integer, required — VLAN ID
      - `vni` integer, required — VXLAN Network Identifier
      - `gateway` string, required — Gateway IP address
      - `ip` string, required — Interface IP address
      - `interfacePrefix` string, required — Interface name prefix
      - `virtualFunctionId` integer, nullable — Virtual function ID if applicable
      - `vpcPrefixes` string[] — List of VPC IP prefixes
      - `prefix` string, required — IP prefix for the interface
      - `fqdn` string, required — Fully qualified domain name
      - `bootUrl` string, nullable — Boot URL for PXE/iPXE boot
      - `vpcVni` integer, required — VPC VXLAN Network Identifier
      - `sviIp` string, nullable — Switch virtual interface (SVI) IP address
      - `tenantVrfLoopbackIp` string, nullable — Tenant VRF loopback IP address
      - `isL2Segment` boolean, required — Whether the interface is an L2 segment
      - `vpcPeerPrefixes` string[] — List of peered VPC IP prefixes
      - `vpcPeerVnis` integer[] — List of peered VPC VNIs
      - `mtu` integer, nullable — Maximum transmission unit (MTU) for the interface
      - `networkSecurityGroup` InterfaceNetworkSecurityGroupConfig — Network security group configuration resolved on a DPU interface
        - `id` string, required — ID of the Network Security Group
        - `version` string, required — Version of the Network Security Group
        - `source` string, required — Source of the Network Security Group configuration
        - `rules` ResolvedNetworkSecurityGroupRule[] — Resolved rules for the Network Security Group
          - `rule` NetworkSecurityGroupRule — Aggregation of Network Security Group rules
            - `name` string, nullable — Name of the Network Security Group rule
            - `direction` 'INGRESS' | 'EGRESS', required — Traffic direction the rule applies to
            - `sourcePortRange` string, nullable — Source port or port range matched by the rule
            - `destinationPortRange` string, nullable — Destination port or port range matched by the rule
            - `protocol` 'TCP' | 'UDP' | 'ICMP' | 'ICMP6' | 'ANY', required — Network protocol matched by the rule
            - `action` 'PERMIT' | 'DENY', required — Action applied when traffic matches the rule
            - `priority` integer — Rule priority used to order evaluation
            - `sourcePrefix` string, required — Source CIDR prefix matched by the rule
            - `destinationPrefix` string, required — Destination CIDR prefix matched by the rule
          - `srcPrefixes` string[] — Resolved source IP prefixes for the rule
          - `dstPrefixes` string[] — Resolved destination IP prefixes for the rule
    - `tenantInterfaces` DpuInterfaceConfig[] — List of tenant interface configurations
      - `functionType` string, required — Function type (e.g. PHYSICAL_FUNCTION, VIRTUAL_FUNCTION)
      - `vlanId` integer, required — VLAN ID
      - `vni` integer, required — VXLAN Network Identifier
      - `gateway` string, required — Gateway IP address
      - `ip` string, required — Interface IP address
      - `interfacePrefix` string, required — Interface name prefix
      - `virtualFunctionId` integer, nullable — Virtual function ID if applicable
      - `vpcPrefixes` string[] — List of VPC IP prefixes
      - `prefix` string, required — IP prefix for the interface
      - `fqdn` string, required — Fully qualified domain name
      - `bootUrl` string, nullable — Boot URL for PXE/iPXE boot
      - `vpcVni` integer, required — VPC VXLAN Network Identifier
      - `sviIp` string, nullable — Switch virtual interface (SVI) IP address
      - `tenantVrfLoopbackIp` string, nullable — Tenant VRF loopback IP address
      - `isL2Segment` boolean, required — Whether the interface is an L2 segment
      - `vpcPeerPrefixes` string[] — List of peered VPC IP prefixes
      - `vpcPeerVnis` integer[] — List of peered VPC VNIs
      - `mtu` integer, nullable — Maximum transmission unit (MTU) for the interface
      - `networkSecurityGroup` InterfaceNetworkSecurityGroupConfig — Network security group configuration resolved on a DPU interface
        - `id` string, required — ID of the Network Security Group
        - `version` string, required — Version of the Network Security Group
        - `source` string, required — Source of the Network Security Group configuration
        - `rules` ResolvedNetworkSecurityGroupRule[] — Resolved rules for the Network Security Group
          - `rule` NetworkSecurityGroupRule — Aggregation of Network Security Group rules
            - `name` string, nullable — Name of the Network Security Group rule
            - `direction` 'INGRESS' | 'EGRESS', required — Traffic direction the rule applies to
            - `sourcePortRange` string, nullable — Source port or port range matched by the rule
            - `destinationPortRange` string, nullable — Destination port or port range matched by the rule
            - `protocol` 'TCP' | 'UDP' | 'ICMP' | 'ICMP6' | 'ANY', required — Network protocol matched by the rule
            - `action` 'PERMIT' | 'DENY', required — Action applied when traffic matches the rule
            - `priority` integer — Rule priority used to order evaluation
            - `sourcePrefix` string, required — Source CIDR prefix matched by the rule
            - `destinationPrefix` string, required — Destination CIDR prefix matched by the rule
          - `srcPrefixes` string[] — Resolved source IP prefixes for the rule
          - `dstPrefixes` string[] — Resolved destination IP prefixes for the rule
    - `instanceNetworkConfigVersion` string, nullable — Version of the instance network configuration
    - `instanceId` string, nullable — ID of the associated instance
    - `networkVirtualizationType` string, nullable — Type of network virtualization
    - `vpcVni` integer, nullable — VPC VNI identifier
    - `routeServers` string[] — List of route server IP addresses
    - `remoteId` string, required — Remote identifier for the managed host
    - `deprecatedDenyPrefixes` string[] — Deprecated list of denied IP prefixes
    - `dpuNetworkPingerType` string, nullable — Type of network pinger to use
    - `denyPrefixes` string[] — List of denied IP prefixes
    - `siteFabricPrefixes` string[] — List of site fabric IP prefixes
    - `vpcIsolationBehavior` string, required — VPC isolation behavior setting
    - `statefulAclsEnabled` boolean, required — Whether stateful ACLs are enabled
    - `enableDhcp` boolean, required — Whether DHCP is enabled
    - `hostInterfaceId` string, nullable — ID of the host interface
    - `minDpuFunctioningLinks` integer, nullable — Minimum number of functioning DPU links required
    - `isPrimaryDpu` boolean, required — Whether this is the primary DPU
    - `internetL3Vni` integer, nullable — Layer 3 VNI used for internet access
    - `datacenterAsn` integer, required — Datacenter Autonomous System Number
    - `anycastSitePrefixes` string[] — List of anycast site IP prefixes
    - `tenantHostAsn` integer, nullable — Autonomous System Number for the tenant host
    - `siteGlobalVpcVni` integer, nullable — Site-global VPC VNI identifier
  - `lastRebooted` string, date-time, nullable, required — Last reboot timestamp
  - `placementInRack` PlacementInRack, required — Physical placement of a Machine within its Rack
    - `slotNumber` integer, nullable — Rack slot the Machine occupies
    - `trayIndex` integer, nullable — Index of the Machine's tray within its slot

## Other responses

- `400` — Error response when request data cannot be validated
- `403` — Error response when user is not authorized to call an endpoint or retrieve/modify objects
- `404` — Error response when requested object is not found

## Changes

- **2026-08-28** `2096eb1db2c1` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/changes/v2/org/:org/nico/dpu/:dpuMachineId/get.md)

---

[API](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api.md) · [All operations](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nvidia/nvidia-infra-controller-rest-api/revisions/2096eb1db2c1/schema)