pbs_node_task_stop
Stop a running PBS task by its UPID. Dry-run mode returns a plan; set confirm=true to execute cancellation.
Instructions
MUTATION (HIGH): stop (cancel) a running PBS task. Dry-run by default — the PLAN warns that stopping a backup/restore/verify/sync/prune/GC task mid-flight can leave the datastore or a snapshot inconsistent, with NO undo. confirm=True executes (DELETE /nodes/{node}/tasks/{upid}) and returns {"status": "ok", "result": None} — a cancellation signal, not immediate. Find UPIDs via pbs_tasks_list. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node | No | PBS node name (or 'localhost'). | localhost |
| upid | Yes | The task's Unique Process ID (UPID) string to cancel. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the cancellation. | |
| 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
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |