pve_cloudinit_set
Set cloud-init fields like ciuser, sshkeys, and ipconfig on a Proxmox QEMU guest. Provides a dry-run plan with masked secrets before execution.
Instructions
MUTATION: set cloud-init fields (ciuser/sshkeys/ipconfigN/...) on a QEMU guest — kind='lxc' is refused (cloud-init is QEMU-only). Dry-run by default with secrets masked in the PLAN; confirm=True to execute. Synchronous; the return carries a top-level undo_record key beside status/result (secret fields excluded). Effects apply on next reboot + cloud-init regen, not live. Read current values with pve_cloudinit_get.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Guest type; cloud-init applies to `qemu` guests. | qemu |
| node | No | PVE node the guest runs on. Omit to resolve it automatically from the cluster. | |
| vmid | Yes | Numeric VMID of the QEMU guest to set cloud-init config on. | |
| changes | Yes | Cloud-init fields to change, e.g. {'ciuser': 'admin', 'sshkeys': '...', 'ipconfig0': 'ip=dhcp'}. | |
| confirm | No | Leave `false` (default) to get a dry-run PLAN with secrets masked; set `true` to execute. | |
| 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 |