Remove-PveNodesLxc
Destroy the container (also delete all uses files).
API: DELETE /nodes/{node}/lxc/{vmid}, Proxmox VE API viewer
Aliases: Remove-PveLxc
Syntax
Section titled “Syntax”Remove-PveNodesLxc [-PveTicket <PveTicket>] [-DestroyUnreferencedDisks <bool>] [-Force <bool>] -Node <string> [-Purge <bool>] -Vmid <int> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-DestroyUnreferencedDisks |
bool |
No | If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. |
-Force |
bool |
No | Force destroy, even if running. |
-Node |
string |
Yes | The cluster node name. |
-Purge |
bool |
No | Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will always be removed. |
-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.