]> git.proxmox.com Git - pve-docs.git/blobdiff - vzdump.adoc
pvenode/wake-on-lan: mention defaults
[pve-docs.git] / vzdump.adoc
index 01e1c20ace5bc81cb50b4f9d2719cf7e60fca084..b5bbac73e32916fcd7243c8825d07ac02740d3ef 100644 (file)
@@ -33,7 +33,7 @@ of the backups and downtime of the guest system.
 
 {pve} backups are always full backups - containing the VM/CT
 configuration and all data.  Backups can be started via the GUI or via
-the `vzdump` command line tool.
+the `vzdump` command-line tool.
 
 .Backup Storage
 
@@ -48,19 +48,9 @@ drive, for off-site archiving.
 
 .Scheduled Backup
 
-Backup jobs can be scheduled so that they are executed automatically
-on specific days and times, for selectable nodes and guest systems.
-Configuration of scheduled backups is done at the Datacenter level in
-the GUI, which will generate a job entry in /etc/pve/jobs.cfg, which
-will in turn be parsed and executed by the `pvescheduler` daemon.
-These jobs use the xref:chapter_calendar_events[calendar events] for
-defining the schedule.
-
-Since scheduled backups miss their execution when the host was offline or the
-pvescheduler was disabled during the scheduled time, it is possible to configure
-the behaviour for catching up. By enabling the `Repeat missed` option
-(`repeat-missed` in the config), you can tell the scheduler that it should run
-missed jobs as soon as possible.
+Backup jobs can be scheduled so that they are executed automatically on specific
+days and times, for selectable nodes and guest systems. See the
+xref:vzdump_jobs[Backup Jobs] section for more.
 
 Backup Modes
 ------------
@@ -74,7 +64,7 @@ depending on the guest type.
 
 This mode provides the highest consistency of the backup, at the cost
 of a short downtime in the VM operation. It works by executing an
-orderly shutdown of the VM, and then runs a background Qemu process to
+orderly shutdown of the VM, and then runs a background QEMU process to
 backup the VM data. After the backup is started, the VM goes to full
 operation mode if it was previously running. Consistency is guaranteed
 by using the live backup feature.
@@ -102,8 +92,8 @@ https://git.proxmox.com/?p=pve-qemu.git;a=blob_plain;f=backup.txt[here].
 NOTE: {pve} live backup provides snapshot-like semantics on any
 storage type. It does not require that the underlying storage supports
 snapshots. Also please note that since the backups are done via 
-a background Qemu process, a stopped VM will appear as running for a 
-short amount of time while the VM disks are being read by Qemu.
+a background QEMU process, a stopped VM will appear as running for a
+short amount of time while the VM disks are being read by QEMU.
 However the VM itself is not booted, only its disk(s) are read.
 
 .Backup modes for Containers:
@@ -196,13 +186,15 @@ Backup Encryption
 For Proxmox Backup Server storages, you can optionally set up client-side
 encryption of backups, see xref:storage_pbs_encryption[the corresponding section.]
 
+[[vzdump_jobs]]
 Backup Jobs
 -----------
 
 Besides triggering a backup manually, you can also setup periodic jobs that
 backup all, or a selection of virtual guest to a storage. You can manage the
 jobs in the UI under 'Datacenter' -> 'Backup' or via the `/cluster/backup` API
-endpoint.
+endpoint. Both will generate job entries in `/etc/pve/jobs.cfg`, which are
+parsed and executed by the `pvescheduler` daemon.
 
 A job is either configured for all cluster nodes or a specific node, and is
 executed according to a given schedule. The format for the schedule is very
@@ -216,10 +208,18 @@ overriding those from the storage or node configuration, as well as a
 xref:vzdump_notes[template for notes] for additional information to be saved
 together with the backup.
 
+Since scheduled backups miss their execution when the host was offline or the
+pvescheduler was disabled during the scheduled time, it is possible to configure
+the behaviour for catching up. By enabling the `Repeat missed` option
+(`repeat-missed` in the config), you can tell the scheduler that it should run
+missed jobs as soon as possible.
+
 There are a few settings for tuning backup performance not exposed in the UI.
 The most notable is `bwlimit` for limiting IO bandwidth. The amount of threads
 used for the compressor can be controlled with the `pigz` (replacing `gzip`),
-respectively, `zstd` setting. Furthermore, there is `ionice`. See the
+respectively, `zstd` setting. Furthermore, there are `ionice` and, as part of
+the `performance` setting, `max-workers` (affects VM backups only) and
+`pbs-entries-max` (affects container backups only). See the
 xref:vzdump_configuration[configuration options] for details.
 
 [[vzdump_retention]]
@@ -399,7 +399,7 @@ limit. A bigger per-job limit will only overwrite the per-storage limit if
 you have `Data.Allocate' permissions on the affected storage.
 
 You can use the `--bwlimit <integer>` option from the restore CLI commands
-to set up a restore job specific bandwidth limit.  Kibit/s is used as unit
+to set up a restore job specific bandwidth limit. KiB/s is used as unit
 for the limit, this means passing `10240' will limit the read speed of the
 backup to 10 MiB/s, ensuring that the rest of the possible storage bandwidth
 is available for the already running virtual guests, and thus the backup
@@ -470,6 +470,11 @@ downloaded from such an archive is inherently safe, but it avoids exposing the
 hypervisor system to danger. The VM will stop itself after a timeout. This
 entire process happens transparently from a user's point of view.
 
+NOTE: For troubleshooting purposes, each temporary VM instance generates a log
+file in `/var/log/proxmox-backup/file-restore/`. The log file might contain
+additional information in case an attempt to restore individual files or
+accessing file systems contained in a backup archive fails.
+
 [[vzdump_configuration]]
 Configuration
 -------------
@@ -550,6 +555,9 @@ Use rsync and suspend/resume to create a snapshot (minimal downtime).
  # vzdump 777 --mode suspend
 
 Backup all guest systems and send notification mails to root and admin.
+Due to `mailto` being set and `notification-mode` being set to `auto` by
+default, the notification mails are sent via the system's `sendmail`
+command instead of the notification system.
 
  # vzdump --all --mode suspend --mailto root --mailto admin
 
@@ -582,4 +590,3 @@ file system, using pipes
 ifdef::manvolnum[]
 include::pve-copyright.adoc[]
 endif::manvolnum[]
-