pve_ha_resource_add
Add a guest (VM/CT) to Proxmox HA management. Dry-run returns a plan showing the SID, group, and initial state; set confirm=True to execute.
Instructions
MUTATION: add a guest to HA management. Dry-run by default — the PLAN shows the SID, group, initial state, and blast radius (state='stopped' is HIGH: CRM will stop the guest). confirm=True to execute. Synchronous (pmxcfs config write; CRM enforces state asynchronously) — typically returns null, not a UPID. To remove HA management use pve_ha_resource_remove.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Guest type: 'lxc' or 'qemu'. | lxc |
| vmid | Yes | Numeric VMID/CTID of the guest to add to HA management. | |
| group | No | HA group to assign (PVE 8 only; PVE 9 removed groups in favor of HA rules — omit on PVE 9). | |
| state | No | Desired HA state, e.g. 'started', 'stopped', 'disabled' ('stopped' has the CRM stop the guest). | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the change. | |
| max_restart | No | Max number of restart attempts the CRM makes before giving up. | |
| max_relocate | No | Max number of relocation attempts the CRM makes before giving up. | |
| 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 |