fix typo in api viewer

[pve-docs.git] / vzdump.adoc

diff --git a/vzdump.adoc b/vzdump.adoc
index 5341200652823ddc4dc6d3802b577f231e526adb..6953fb9b66795c50b358b6fd24dbb9b48124fb66 100644 (file)
--- a/vzdump.adoc
+++ b/vzdump.adoc
@@ -1,7 +1,8 @@
+[[chapter_vzdump]]

 ifdef::manvolnum[]
 ifdef::manvolnum[]

-PVE({manvolnum})
-================
-include::attributes.txt[]
+vzdump(1)
+=========
+:pve-toplevel:

 
 NAME
 ----
 
 NAME
 ----


@@ -9,7 +10,7 @@ NAME
 vzdump - Backup Utility for VMs and Containers 
 
 
 vzdump - Backup Utility for VMs and Containers 
 
 

-SYNOPSYS
+SYNOPSIS

 --------
 
 include::vzdump.1-synopsis.adoc[]
 --------
 
 include::vzdump.1-synopsis.adoc[]


@@ -18,11 +19,10 @@ include::vzdump.1-synopsis.adoc[]
 DESCRIPTION
 -----------
 endif::manvolnum[]
 DESCRIPTION
 -----------
 endif::manvolnum[]

-

 ifndef::manvolnum[]
 Backup and Restore
 ==================
 ifndef::manvolnum[]
 Backup and Restore
 ==================

-include::attributes.txt[]
+:pve-toplevel:

 endif::manvolnum[]
 
 Backups are a requirements for any sensible IT deployment, and {pve}
 endif::manvolnum[]
 
 Backups are a requirements for any sensible IT deployment, and {pve}


@@ -62,10 +62,11 @@ depending on the guest type.
 `stop` mode::
 
 This mode provides the highest consistency of the backup, at the cost
 `stop` mode::
 
 This mode provides the highest consistency of the backup, at the cost

-of a downtime in the VM operation.  It works by executing an orderly
-shutdown of the VM, and then runs a background Qemu process to backup
-the VM data. After the backup is complete, the Qemu process resumes
-the VM to full operation mode if it was previously running.
+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
+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.

 
 `suspend` mode::
 
 
 `suspend` mode::
 


@@ -80,16 +81,19 @@ This mode provides the lowest operation downtime, at the cost of a
 small inconstancy risk.  It works by performing a Proxmox VE live
 backup, in which data blocks are copied while the VM is running. If the
 guest agent is enabled (`agent: 1`) and running, it calls
 small inconstancy risk.  It works by performing a Proxmox VE live
 backup, in which data blocks are copied while the VM is running. If the
 guest agent is enabled (`agent: 1`) and running, it calls

-'guest-fsfreeze-freeze' and 'guest-fsfreeze-thaw' to improve
+`guest-fsfreeze-freeze` and `guest-fsfreeze-thaw` to improve

 consistency.
 
 A technical overview of the Proxmox VE live backup for QemuServer can
 be found online
 consistency.
 
 A technical overview of the Proxmox VE live backup for QemuServer can
 be found online

-https://git.proxmox.com/?p=pve-qemu-kvm.git;a=blob;f=backup.txt[here].
+https://git.proxmox.com/?p=pve-qemu.git;a=blob_plain;f=backup.txt[here].

 
 NOTE: Proxmox VE live backup provides snapshot-like semantics on any
 storage type. It does not require that the underlying storage supports
 
 NOTE: Proxmox VE live backup provides snapshot-like semantics on any
 storage type. It does not require that the underlying storage supports

-snapshots.
+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.
+However the VM itself is not booted, only its disk(s) are read.

 
 .Backup modes for Containers:
 
 
 .Backup modes for Containers:
 


@@ -106,9 +110,9 @@ a second rsync copies changed files. After that, the container is
 started (resumed) again. This results in minimal downtime, but needs
 additional space to hold the container copy.
 +
 started (resumed) again. This results in minimal downtime, but needs
 additional space to hold the container copy.
 +

-When the container is on a local filesystem and the target storage of
+When the container is on a local file system and the target storage of

 the backup is an NFS server, you should set `--tmpdir` to reside on a
 the backup is an NFS server, you should set `--tmpdir` to reside on a

-local filesystem too, as this will result in a many fold performance
+local file system too, as this will result in a many fold performance

 improvement.  Use of a local `tmpdir` is also required if you want to
 backup a local container using ACLs in suspend mode if the backup
 storage is an NFS server.
 improvement.  Use of a local `tmpdir` is also required if you want to
 backup a local container using ACLs in suspend mode if the backup
 storage is an NFS server.


@@ -122,12 +126,14 @@ snapshot content will be archived in a tar file. Finally, the temporary
 snapshot is deleted again.
 
 NOTE: `snapshot` mode requires that all backed up volumes are on a storage that
 snapshot is deleted again.
 
 NOTE: `snapshot` mode requires that all backed up volumes are on a storage that

-supports snapshots. Using the `backup=no` mountpoint option individual volumes
+supports snapshots. Using the `backup=no` mount point option individual volumes

 can be excluded from the backup (and thus this requirement).
 
 can be excluded from the backup (and thus this requirement).
 

-NOTE: bind and device mountpoints are skipped during backup operations, like
-volume mountpoints with the backup option disabled.
-
+// see PVE::VZDump::LXC::prepare()
+NOTE: By default additional mount points besides the Root Disk mount point are
+not included in backups. For volume mount points you can set the *Backup* option
+to include the mount point in the backup. Device and bind mounts are never
+backed up as their content is managed outside the {pve} storage library.

 
 Backup File Names
 -----------------
 
 Backup File Names
 -----------------


@@ -156,13 +162,13 @@ For details see the corresponding manual pages.
 Configuration
 -------------
 
 Configuration
 -------------
 

-Global configuration is stored in '/etc/vzdump.conf'. The file uses a
+Global configuration is stored in `/etc/vzdump.conf`. The file uses a

 simple colon separated key/value format. Each line has the following
 format:
 
  OPTION: value
 
 simple colon separated key/value format. Each line has the following
 format:
 
  OPTION: value
 

-Blank lines in the file are ignored, and lines starting with a '#'
+Blank lines in the file are ignored, and lines starting with a `#`

 character are treated as comments and are also ignored. Values from
 this file are used as default, and can be overwritten on the command
 line.
 character are treated as comments and are also ignored. Values from
 this file are used as default, and can be overwritten on the command
 line.


@@ -172,7 +178,7 @@ We currently support the following options:
 include::vzdump.conf.5-opts.adoc[]
 
 
 include::vzdump.conf.5-opts.adoc[]
 
 

-.Example 'vzdump.conf' Configuration
+.Example `vzdump.conf` Configuration

 ----
 tmpdir: /mnt/fast_local_disk
 storage: my_backup_storage
 ----
 tmpdir: /mnt/fast_local_disk
 storage: my_backup_storage


@@ -186,14 +192,14 @@ Hook Scripts
 You can specify a hook script with option `--script`. This script is
 called at various phases of the backup process, with parameters
 accordingly set. You can find an example in the documentation
 You can specify a hook script with option `--script`. This script is
 called at various phases of the backup process, with parameters
 accordingly set. You can find an example in the documentation

-directory ('vzdump-hook-script.pl').
+directory (`vzdump-hook-script.pl`).

 
 File Exclusions
 ---------------
 
 NOTE: this option is only available for container backups.
 
 
 File Exclusions
 ---------------
 
 NOTE: this option is only available for container backups.
 

-'vzdump' skips the following files by default (disable with the option
+`vzdump` skips the following files by default (disable with the option

 `--stdexcludes 0`)
 
  /tmp/?*
 `--stdexcludes 0`)
 
  /tmp/?*


@@ -214,7 +220,7 @@ Examples
 
 Simply dump guest 777 - no snapshot, just archive the guest private area and
 configuration files to the default dump directory (usually
 
 Simply dump guest 777 - no snapshot, just archive the guest private area and
 configuration files to the default dump directory (usually

-'/var/lib/vz/dump/').
+`/var/lib/vz/dump/`).

 
  # vzdump 777
 
 
  # vzdump 777