NodeRingsDocs

Deregister an agent

Tear down local agent components and optionally delete the agent from the API

nr cluster deregister uninstalls local Liqo, Calico, and k3s pieces for an agent and can delete the agent record from NodeRings.

This is destructive. Customer workloads that depended on this agent will fail until you register a replacement and reattach platforms/nodes.

Interactive teardown

nr cluster deregister --name edge-ams-01

The CLI asks for confirmation. To skip the prompt:

nr cluster deregister --name edge-ams-01 --yes

Flags

FlagMeaning
--name / --agent-idIdentify the agent (one required)
--yes / -ySkip the confirmation prompt
--forceContinue after partial cleanup failures (not the same as --yes)
--skip-apiUninstall locally without calling DeleteAgent

--force means “keep going if a cleanup step fails.” It does not mean “skip confirmation.” Use --yes for that.

After a forced teardown

Review leftovers manually if --force was required:

  • k3s packages / service
  • Calico and Liqo namespaces
  • Operator namespaces and Secrets

Delete the API agent only

If the VM is already gone and you only need to remove the API object:

nr agent delete --name edge-ams-01 --force

Prefer full deregister when the VM is still reachable so local components are cleaned up.