Set-PveClusterMappingDir
Update a directory mapping.
API: PUT /cluster/mapping/dir/{id}, Proxmox VE API viewer
Syntax
Section titled “Syntax”Set-PveClusterMappingDir [-PveTicket <PveTicket>] [-Delete <string>] [-Description <string>] [-Digest <string>] -Id <string> [-Map <array>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Delete |
string |
No | A list of settings you want to delete. |
-Description |
string |
No | Description of the directory mapping. |
-Digest |
string |
No | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. |
-Id |
string |
Yes | The ID of the directory mapping. |
-Map |
array |
No | A list of maps for the cluster nodes. |
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.
