entity-status#

dpsctl import entity-status Usage Guide#

Get the status and results of an entity import operation by request ID. The request ID is returned by dpsctl import entity.

dpsctl import entity-status waits for the import request to complete, then returns the generated entities.

Usage#

dpsctl import entity-status --request-id <id>

Flags#

Includes global dpsctl options.

   --request-id string  Request ID returned by 'import entity' command
   --help, -h           show help

Examples#

Check Status and Retrieve Entities#

$ dpsctl import entity-status --request-id abc123-def456-ghi789
[
  {
    "Type": "ComputerSystem",
    "Model": "DGX_H100",
    "Name": "node001",
    "Redfish": {
      "URL": "https://node001-bmc.example.com",
      "SecretName": "node001"
    }
  },
  {
    "Type": "ComputerSystem",
    "Model": "DGX_H100",
    "Name": "node002",
    "Redfish": {
      "URL": "https://node002-bmc.example.com",
      "SecretName": "node002"
    }
  }
]

Request Lifecycle#

  • Generation timeout: The server runs entity generation with a default timeout of 10 minutes (server maximum 30 minutes). Long-running requests may be marked failed after the timeout.

  • Request cleanup: Request state and generated entities are removed after 30 minutes (TTL-based cleanup).

  • Completion behavior: The command blocks until the import request is complete, then streams the generated entities.

  • Error handling: Returns error details if the import operation failed or the request ID is invalid or not found.

  • Manual cleanup: Use dpsctl import entity-delete to remove stored request state and generated results before TTL cleanup.