list-entities

dpsctl topology list-entities Usage Guide

List entities in the system.

Usage

dpsctl topology list-entities [entity-names...]

Flags

Includes global dpsctl options.

   --help, -h          show help

Examples

List All Entities

$ dpsctl topology list-entities
{
  "entities": [
    {
      "type": "PowerDomain",
      "name": "PD-A",
      "constraints": {
        "power_value": {
          "value": 1150000,
          "type": "W"
        },
        "power_factor": 0.9
      },
      "redfish": {
        "@odata.type": "#PowerDomain.v1_2_2.PowerDomain",
        "@odata.id": "/PD-A",
        "id": "PD-A"
      }
    },
    {
      "type": "ComputerSystem",
      "model": "DGX_H100",
      "name": "node001",
      "policy": "Node-High",
      "redfish": {
        "@odata.type": "#ComputerSystem.v1_23_0.ComputerSystem",
        "@odata.id": "/node001",
        "id": "node001",
        "url": "https://node001-bmc.example.com",
        "secret_name": "node001"
      }
    }
  ]
}

List Specific Entities

$ dpsctl topology list-entities node001 node002
{
  "entities": [
    {
      "type": "ComputerSystem",
      "model": "DGX_H100",
      "name": "node001",
      "policy": "Node-High",
      "redfish": {
        "@odata.type": "#ComputerSystem.v1_23_0.ComputerSystem",
        "@odata.id": "/node001",
        "id": "node001",
        "url": "https://node001-bmc.example.com"
      }
    },
    {
      "type": "ComputerSystem",
      "model": "DGX_H100",
      "name": "node002",
      "policy": "Node-Med",
      "redfish": {
        "@odata.type": "#ComputerSystem.v1_23_0.ComputerSystem",
        "@odata.id": "/node002",
        "id": "node002",
        "url": "https://node002-bmc.example.com"
      }
    }
  ]
}

List Single Entity

$ dpsctl topology list-entities PD-A
{
  "entities": [
    {
      "type": "PowerDomain",
      "name": "PD-A",
      "constraints": {
        "power_value": {
          "value": 1150000,
          "type": "W"
        },
        "power_factor": 0.9
      },
      "redfish": {
        "@odata.type": "#PowerDomain.v1_2_2.PowerDomain",
        "@odata.id": "/PD-A",
        "id": "PD-A"
      }
    }
  ]
}

Notes

  • Entities represent physical devices in the datacenter
  • Each entity has a type, name, and device model (if applicable)
  • Entities can have constraints, policies, and Redfish endpoints
  • Use this command to explore the entity inventory before building topologies