New-PveNodesQemuAgentSetUserPassword
Sets the password for the given user to the given password
API: POST /nodes/{node}/qemu/{vmid}/agent/set-user-password, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveNodesQemuAgentSetUserPassword [-PveTicket <PveTicket>] [-Crypted <bool>] -Node <string> -Password <SecureString> -Username <string> -Vmid <int> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Crypted |
bool |
No | set to 1 if the password has already been passed through crypt() |
-Node |
string |
Yes | The cluster node name. |
-Password |
SecureString |
Yes | The new password. |
-Username |
string |
Yes | The user to set the password for. |
-Vmid |
int |
Yes | The (unique) ID of the VM. |
Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.
Output
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.
