pve_user_update
Update a Proxmox user's attributes including login status, group membership, and contact info. Preview changes with dry-run mode; execute with confirmation.
Instructions
MUTATION: update a user (enable=False stops login; group changes re-scope access). Dry-run by default. confirm=True executes and returns a dict; synchronous, no UPID. Use pve_user_get to see current state first, or pve_user_delete to remove the user instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Optional email address; omit to leave unchanged. | ||
| append | No | If True, add `groups` to existing membership instead of replacing it. | |
| enable | No | Whether the account can log in; False stops login. Omit to leave unchanged. | |
| expire | No | Account expiry as a Unix timestamp; omit to leave unchanged. | |
| groups | No | Comma-separated list of group ids; replaces membership unless append=True. | |
| userid | Yes | User id to update, format 'user@realm'. | |
| comment | No | Optional free-text comment; omit to leave unchanged. | |
| confirm | No | False (default) returns a dry-run PLAN preview; True executes the mutation. | |
| lastname | No | Optional last name; omit to leave unchanged. | |
| firstname | No | Optional first name; omit to leave unchanged. | |
| 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
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |