New-PveClusterReplication

Create a new replication job

API: POST /cluster/replication, Proxmox VE API viewer

Syntax

New-PveClusterReplication
    [-PveTicket <PveTicket>]
    [-Comment <string>]
    [-Disable <bool>]
    -Id <string>
    [-Rate <float>]
    [-RemoveJob <string>]
    [-Schedule <string>]
    [-Source <string>]
    -Target <string>
    -Type <string>
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Comment	string	No	Description.
-Disable	bool	No	Flag to disable/deactivate the entry.
-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>’.
-Rate	float	No	Rate limit in mbps (megabytes per second) as floating point number.
-RemoveJob	string	No	Mark the replication job for removal. The job will remove all local replication snapshots. When set to ‘full’, it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Values: local, full.
-Schedule	string	No	Storage replication schedule. The format is a subset of systemd calendar events.
-Source	string	No	For internal use, to detect if the guest was stolen.
-Target	string	Yes	Target node.
-Type	string	Yes	Section type. Values: local.

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

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.