Set-PveClusterBackup

Update vzdump backup job definition.

API: PUT /cluster/backup/{id}, Proxmox VE API viewer

Syntax

Set-PveClusterBackup
    [-PveTicket <PveTicket>]
    [-All <bool>]
    [-Bwlimit <int>]
    [-Comment <string>]
    [-Compress <string>]
    [-Delete <string>]
    [-Dow <string>]
    [-Dumpdir <string>]
    [-Enabled <bool>]
    [-Exclude <string>]
    [-ExcludePath <array>]
    [-Fleecing <string>]
    -Id <string>
    [-Ionice <int>]
    [-Lockwait <int>]
    [-Mailnotification <string>]
    [-Mailto <string>]
    [-Mode <string>]
    [-Node <string>]
    [-NotesTemplate <string>]
    [-NotificationMode <string>]
    [-PbsChangeDetectionMode <string>]
    [-Performance <string>]
    [-Pigz <int>]
    [-Pool <string>]
    [-Protected <bool>]
    [-PruneBackups <string>]
    [-Quiet <bool>]
    [-Remove <bool>]
    [-RepeatMissed <bool>]
    [-Schedule <string>]
    [-Script <string>]
    [-Starttime <string>]
    [-Stdexcludes <bool>]
    [-Stop <bool>]
    [-Stopwait <int>]
    [-Storage <string>]
    [-Tmpdir <string>]
    [-Vmid <string>]
    [-Zstd <int>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-All	bool	No	Backup all known guest systems on this host.
-Bwlimit	int	No	Limit I/O bandwidth (in KiB/s).
-Comment	string	No	Description for the Job.
-Compress	string	No	Compress dump file. Values: 0, 1, gzip, lzo, zstd.
-Delete	string	No	A list of settings you want to delete.
-Dow	string	No	Deprecated: Use ‘schedule’ instead. Day of week selection. ‘starttime’ and ‘dow’ will be converted into ‘schedule’ if used.
-Dumpdir	string	No	Store resulting files to specified directory.
-Enabled	bool	No	Enable or disable the job.
-Exclude	string	No	Exclude specified guest systems (assumes --all)
-ExcludePath	array	No	Exclude certain files/directories (shell globs). Paths starting with ‘/’ are anchored to the container’s root, other paths match relative to each subdirectory.
-Fleecing	string	No	Options for backup fleecing (VM only).
-Id	string	Yes	The job ID.
-Ionice	int	No	Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
-Lockwait	int	No	Maximal time to wait for the global lock (minutes).
-Mailnotification	string	No	Deprecated: use notification targets/matchers instead. Specify when to send a notification mail. Values: always, failure.
-Mailto	string	No	Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.
-Mode	string	No	Backup mode. Values: snapshot, suspend, stop.
-Node	string	No	Only run if executed on this node.
-NotesTemplate	string	No	Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as ‘\n’ and ‘\’ respectively.
-NotificationMode	string	No	Determine which notification system to use. If set to ‘legacy-sendmail’, vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the ‘sendmail’ command. If set to ‘notification-system’, a notification will be sent via PVE’s notification system, and the mailto and mailnotification will be ignored. If set to ‘auto’ (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Values: auto, legacy-sendmail, notification-system.
-PbsChangeDetectionMode	string	No	PBS mode used to detect file changes and switch encoding format for container backups. Values: legacy, data, metadata.
-Performance	string	No	Other performance-related settings.
-Pigz	int	No	Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
-Pool	string	No	Backup all known guest systems included in the specified pool.
-Protected	bool	No	If true, mark backup(s) as protected.
-PruneBackups	string	No	Use these retention options instead of those from the storage configuration.
-Quiet	bool	No	Be quiet.
-Remove	bool	No	Prune older backups according to ‘prune-backups’.
-RepeatMissed	bool	No	If true, the job will be run as soon as possible if it was missed while the scheduler was not running.
-Schedule	string	No	Backup schedule. The format is a subset of systemd calendar events.
-Script	string	No	Use specified hook script.
-Starttime	string	No	Deprecated: Use ‘schedule’ instead. Job Start time. ‘starttime’ and ‘dow’ will be converted into ‘schedule’ if used.
-Stdexcludes	bool	No	Exclude temporary files and logs.
-Stop	bool	No	Stop running backup jobs on this host.
-Stopwait	int	No	Maximal time to wait until a guest system is stopped (minutes).
-Storage	string	No	Store resulting file to this storage.
-Tmpdir	string	No	Store temporary files to specified directory.
-Vmid	string	No	The ID of the guest system you want to backup.
-Zstd	int	No	Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count.

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.