Remove-PveClusterHaResources
Delete resource configuration.
API: DELETE /cluster/ha/resources/{sid}, Proxmox VE API viewer
Syntax
Section titled “Syntax”Remove-PveClusterHaResources [-PveTicket <PveTicket>] [-Purge <bool>] -Sid <string> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Purge |
bool |
No | Remove this resource from rules that reference it, deleting the rule if this resource is the only resource in the rule. |
-Sid |
string |
Yes | HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). |
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.