pbs_user_delete
Remove a PBS user with a dry-run plan previewing tokens and ACLs to be deleted. Confirm to execute permanently.
Instructions
MUTATION (MEDIUM): delete a PBS user. Dry-run by default — the PLAN reads the user's current config and tokens to show what vanishes with it (permanent, no undo — any tokens owned by this user are removed with it, and ACL entries granted directly to this userid become orphaned). confirm=True executes and returns a dict; synchronous, no UPID. To disable login without deleting, use pbs_user_update (enable=False) instead. Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| digest | No | Optional SHA256 config digest to prevent concurrent modifications. | |
| userid | Yes | PBS user id to delete, format 'user@realm'. | |
| confirm | No | False (default) returns a dry-run PLAN preview; True executes the mutation. | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |