pbs_user_update
Update a PBS user account: enable or disable login, set expiry, names, email, and clear properties. Dry-run shows plan; confirm executes changes.
Instructions
MUTATION (MEDIUM): update a PBS user (enable=False stops login immediately). Dry-run by default — the PLAN reads the user's current config first.
NOTE: this tool does NOT accept a password parameter — PBS's own PUT /access/users 'password' field is documented as ignored ("use PUT /access/password instead"); exposing a working-looking no-op parameter here would mislead a caller into thinking it changed the password.
confirm=True executes and returns a dict; synchronous, no UPID. Use pbs_user_get to see current state first, or pbs_user_delete to remove the user instead. Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Optional email address; omit to leave unchanged. | ||
| digest | No | Optional SHA256 config digest to prevent concurrent modifications. | |
| 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. | |
| userid | Yes | PBS 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. | |
| delete_props | No | Property names to clear: any of 'comment', 'firstname', 'lastname', 'email'. | |
| 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 |