remove-entities

dpsctl topology remove-entities Usage Guide

Permanently deletes entities from the system.

Note: The entities must not be referenced by any topology (active or inactive). If an entity is part of any topology, the deletion will fail.

Usage

dpsctl topology remove-entities --topology <any-string> [entity-names...]

Flags

Includes global dpsctl options.

   --topology string   Required flag (value ignored).
   --help, -h          show help

Examples

Delete Unused Entities

$ dpsctl topology remove-entities --topology ignored node001 node002
{
  "status": {
    "ok": true,
    "diag_msg": "Success"
  }
}

Error: Entity in Use

$ dpsctl topology remove-entities --topology ignored node001
{
  "status": {
    "ok": false,
    "diag_msg": "entit(ies) referenced from existing topologies"
  },
  "entity_topologies": {
     "node001": {
        "topologies": ["my-topology"]
     }
  }
}

Notes

• This operation permanently deletes entities from the database.
• The --topology flag is currently required by the CLI but the value is not used to scope the deletion; the deletion is global (system-wide).
• To remove entities from a topology without deleting them from the system, you must update the topology definition (e.g. using dpsctl topology update).