Remove-PveClusterReplication
Mark replication job for removal.
API: DELETE /cluster/replication/{id}, Proxmox VE API viewer
Syntax
Section titled “Syntax”Remove-PveClusterReplication [-PveTicket <PveTicket>] [-Force <bool>] -Id <string> [-Keep <bool>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Force |
bool |
No | Will remove the jobconfig entry, but will not cleanup. |
-Id |
string |
Yes | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. ‘<GUEST>-<JOBNUM>’. |
-Keep |
bool |
No | Keep replicated data at target (do not remove). |
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.
