pve_ha_rule_update
Update an existing HA rule in Proxmox VE with dry-run planning to review changes before execution. Supports node/resource affinity, disabling, and field deletion.
Instructions
MUTATION: update an HA rule. Dry-run by default — the PLAN shows the current rule and the
fields being changed. delete unsets keys. confirm=True to execute. Synchronous (pmxcfs
config write, no UPID). RISK_MEDIUM — may trigger CRM migration of affected resources.
To create a new rule use pve_ha_rule_create; to remove one use pve_ha_rule_delete.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rule | Yes | HA rule ID to update. | |
| nodes | No | New comma-separated node list with optional priority, e.g. 'pve1:2,pve2' (node-affinity rules). | |
| delete | No | List of field names to unset on the rule, e.g. ['strict', 'nodes']. | |
| digest | No | Expected config digest for optimistic-locking; PUT is rejected if the stored digest differs. | |
| strict | No | node-affinity only: True restricts resources to ONLY the listed nodes. | |
| comment | No | New free-text comment for the rule. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the change. | |
| disable | No | True to disable the rule, False to enable it, omit to leave unchanged. | |
| affinity | No | 'positive' or 'negative' (resource-affinity rules). | |
| resources | No | New comma-separated HA resource SIDs the rule applies to, e.g. 'vm:100,ct:101'. | |
| rule_type | No | New rule type: 'node-affinity' or 'resource-affinity'. | |
| 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 |