pve_ceph_pool_set
Modify an existing Ceph pool's configuration such as replica count, placement groups, CRUSH rule, and autoscaling. Dry-run planning by default; confirm to execute changes.
Instructions
MUTATION: change an existing Ceph pool's settings.
RISK_MEDIUM: a pg_num change triggers cluster rebalance (docstring/plan say so plainly). At least one field must be set — a call with every field omitted is refused before any wire call (the pve_ceph_flags_set "at least one" lesson). No upstream cmd-safety check exists for pool changes. CAPTURE-or-declare: reads the pool's current settings before planning (also readable directly via pve_ceph_pool_status, ADVERSARIAL — taint marked when tracking is on); if unreadable -> complete=False. Dry-run by default (returns a PLAN); confirm=True executes (PUT /nodes/{node}/ceph/pool/{name}) and returns {"status": "submitted", "result": }. No rollback primitive on this plane — revert by re-applying the captured prior settings with this same tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the pool to change. | |
| node | No | PVE node the pool is on; defaults to the configured node if omitted. | |
| size | No | Number of replicas per object (1-7). | |
| pg_num | No | Number of placement groups (1-32768). CAUTION: changing this triggers cluster rebalance. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the change. | |
| min_size | No | Minimum number of replicas per object to allow I/O (1-7). | |
| crush_rule | No | CRUSH rule NAME to use for object placement (a string — NOT the numeric id pve_ceph_pool_list returns for this same field; pve_ceph_pool_status's crush_rule is ALREADY the same string type, no divergence there). | |
| pg_num_min | No | Minimum placement-group count the autoscaler may choose (<=32768). | |
| application | No | Pool application: 'rbd', 'cephfs', or 'rgw'. | |
| target_size | No | Estimated target size for the PG autoscaler: a number optionally suffixed with K/M/G/T (e.g. '10G'). | |
| 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. | |
| pg_autoscale_mode | No | PG autoscaler mode: 'on', 'off', or 'warn'. | |
| target_size_ratio | No | Estimated target ratio of total pool capacity, for the PG autoscaler. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |