Skip to content

Set-PveAccessAcl

Update Access Control List (add or remove permissions).

API: PUT /access/acl, Proxmox VE API viewer

Set-PveAccessAcl
[-PveTicket <PveTicket>]
[-Delete <bool>]
[-Groups <string>]
-Path <string>
[-Propagate <bool>]
-Roles <string>
[-Tokens <string>]
[-Users <string>]
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Delete bool No Remove permissions (instead of adding it).
-Groups string No List of groups.
-Path string Yes Access control path.
-Propagate bool No Allow to propagate (inherit) permissions.
-Roles string Yes List of roles.
-Tokens string No List of API tokens.
-Users string No List of users.

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.