remove-entities

dpsctl topology remove-entities Usage Guide

Remove specific entities from the system.

Usage

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

Flags

Includes global dpsctl options.

   --help, -h          show help

Examples

Remove Single Entity

$ dpsctl topology remove-entities node001
{
  "status": {
    "ok": true,
    "diag_msg": "Entity removed successfully"
  }
}

Remove Multiple Entities

$ dpsctl topology remove-entities node001 node002 node003
{
  "status": {
    "ok": true,
    "diag_msg": "3 entities removed successfully"
  }
}

Remove Entity in Use (Error)

$ dpsctl topology remove-entities node001
{
  "status": {
    "ok": false,
    "diag_msg": "Cannot remove entity 'node001': entity is part of active topology 'datacenter'"
  },
  "entity_topologies": {
    "node001": {
      "topologies": ["datacenter"]
    }
  }
}

Remove Non-Existent Entity

$ dpsctl topology remove-entities non-existent-node
{
  "status": {
    "ok": false,
    "diag_msg": "Entity 'non-existent-node' not found"
  }
}

Notes

  • Entities must not be part of any active topology
  • This operation is irreversible
  • All entity configurations and relationships are permanently deleted
  • Use dpsctl topology deactivate first if entities are in an active topology
  • Consider exporting configurations before removal for backup purposes
  • If entities cannot be deleted due to topology references, the response includes entity_topologies mapping