Skip to content

Set-PveAccessUsers

Update user configuration.

API: PUT /access/users/{userid}, Proxmox VE API viewer

Set-PveAccessUsers
[-PveTicket <PveTicket>]
[-Append <bool>]
[-Comment <string>]
[-Email <string>]
[-Enable <bool>]
[-Expire <int>]
[-Firstname <string>]
[-Groups <string>]
[-Keys <string>]
[-Lastname <string>]
-Userid <string>
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No
-Append bool No
-Comment string No
-Email string No
-Enable bool No
-Expire int No
-Firstname string No
-Groups string No
-Keys string No
-Lastname string No
-Userid string Yes

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.

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.