pmg_ruledb_rule_update
Update a PMG rule's name, priority, activity, direction, or group logic invert flags. Dry-run shows the plan; confirm executes the change.
Instructions
MUTATION (MEDIUM): update a PMG RuleDB rule configuration. Dry-run by default.
Changes rule-level fields only (name/priority/active/direction/AND-invert flags) — to attach or detach condition/action groups use pmg_ruledb_rule_from_attach and its sibling attach/detach tools. Only non-None fields are sent. confirm=True executes and returns {"status": "ok", "result": <PMG's raw API response>}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id_ | Yes | Rule ID (positive integer string, e.g. '100'). | |
| name | No | New rule name; omit to keep current value. | |
| active | No | Whether the rule is active; True begins live mail processing under this rule. | |
| to_and | No | AND (True) vs OR (False) logic across attached 'to' groups. | |
| confirm | No | False (default) returns a dry-run PLAN; True executes the mutation. | |
| from_and | No | AND (True) vs OR (False) logic across attached 'from' groups. | |
| priority | No | New rule priority 0-100; lower numbers are evaluated with higher priority. | |
| what_and | No | AND (True) vs OR (False) logic across attached 'what' groups. | |
| when_and | No | AND (True) vs OR (False) logic across attached 'when' groups. | |
| direction | No | Mail direction the rule applies to: 0=inbound, 1=outbound, 2=both. | |
| to_invert | No | If True, invert the 'to' group match. | |
| from_invert | No | If True, invert the 'from' group match. | |
| what_invert | No | If True, invert the 'what' group match. | |
| when_invert | No | If True, invert the 'when' group match. | |
| 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 |