Backup Configuration File

This file ( /etc/vzbackup.conf ) is in the same format as the global Parallels Cloud Server configuration file and per-Container configuration files. All the parameters define the global backup settings, but some of them may be overridden by the per-server configuration file, if the latter exists. Still, other parameters may be further overridden in the configuration file of a particular Container.

Note: The settings in the /etc/vzbackup.conf file are valid only for Containers backed up with the pbackup utility. These settings are ignored when you back up individual Containers using the prlctl backup command or virtual machines using both the pbackup utility and the prlctl backup command.

Global Parameters

Name	Description	Default value
BACKUP_DIR	The directory where backups are stored. Note: To set the backup directory in the current version of Parallels Cloud Server, use the `prlsrvctl set` command .	`/var/parallels/backups`
BACKUP_TYPE	The backup type. Among the supported types are "plain full ( `F` )", "full ( `I` )", and "incremental ( `i` )". The default is incremental. If it is impossible to do an "incremental" backup, a "full" backup will be made.	`i`
BACKUP_NODES	The hostname of the server whose Containers are to be backed up. You can specify several hostnames of your servers and separate them by spaces. If you wish to back up Containers residing on the Backup server itself, you should specify its hostname as the value of this parameter.
BACKUP_MAX_CHLD	The maximal number of servers to back up in parallel for non-periodic backups.	`1`
BACKUP_MAX_CHLD_CRON	The maximal number of servers to back up in parallel for periodic backups.	`3`
BACKUP_NOTIFY_EMAIL	The e-mail addresses where to send notifications about the backing up.
BACKUP_COMPRESS	Specifies whether the Containers are to be compressed when being backed up, and with what compression algorithm. When backing up Containers, you can set this option to one of the following values: `C0` : in this case the Container backup is created without any compression. Using this level of compression, you may greatly reduce the backup creation time; however, the size of the resulting backup file may significantly increase as compared to other compression levels. `C1` : in this case the Container backup is created with a normal level of compression. `C2` : in this case the Container backup is created with the high level of compression. The size of the resulting backup file is smaller than that of the backup file compressed in the 'normal' and 'none' modes; however, it takes longer to create the backup file. `C3` : in this case the Container backup is created with the maximal level of compression. The size of the resulting backup file is the smallest and the time of the backup creation - the longest. This parameter can be overridden by the `-Cg` , `-Cb` , `-Cn` command-line options of the `pbackup` utility.	`none`
BACKUP_COMPATIBILITY_MODE	If set to "yes" and not commented out, the `pbackup` / `prestore` utilities use `vzbackup` / `vzrestore` for operations on Containers. Otherwise, `prlctl backup` and `prlctl restore` commands are used. This parameter is commented out by default.	`disabled`
CRON_BACKUP	Specifies whether the backing up is performed as a cron job. If set to "yes", the values of the `BACKUP_KEEP_MAX` and `BACKUP_LOADAVG_MAX` parameters in the given file are taken into consideration. This parameter can be overridden by the `-p` or `-j` command-line switch of the `vzbackup` utility.	`no`

Per-server Parameters

Name	Description	Default value
BACKUP_SSH_OPTS	Options which are passed to `ssh` when it is used.	`-c blowfish`
BACKUP_VESTOP	Defines whether the Containers are to be stopped before their backing up. If set to `–s` , the Containers are stopped by default, otherwise, they are not stopped.
BACKUP_EXCL_VES	Defines those Containers that are to be excluded from the backup list. Container IDs must be given here.
BACKUP_LOADAVG_MAX	The maximal `loadavg` with which backing up is allowed. This parameter is effective only if the `-p` option is specified with the `vzbackup` utility.	`10`
BACKUP_FINISH_TIME	The time when the backing up should be stopped and delayed until the next execution (e.g., when running backup scripts at 4am) one can require the backup to be finished before 7am. The backup will continue from the last Container at the next execution. The format is: " `HH:MM` ". This parameter is effective only if the `-L` option is specified with the `vzbackup` utility.	`none`
BACKUP_LIMIT_TIME	The number of hours after which the backing up should be stopped and delayed until the next execution. The format is: " `HH` ". This parameter is effective only if the `-L` option is specified with the `vzbackup` utility.	`none`

Per-Container Parameters

Parameter	Description	Default Value
BACKUP_CHAIN_LEN	An incremental backup parameter. After this number of incremental backups, a full backup is performed.	`7`
BACKUP_CHAIN_DAYS	An incremental backup parameter. After this number of days a full backup is performed.	`7`
BACKUP_KEEP_MAX	The number of backups to store. Only full and plain full backups are accounted. If a regular backup is being performed that exceeds this number, the oldest backup is automatically deleted. This parameter is effective only if the `-p` option is specified with the `vzbackup` utility. If there is no `-p` option, the number of backups to store is not limited whatever the value of this parameter.	`3`

If you want to rewrite the per-server parameters for a particular Parallels server, you should create a new configuration file named server.conf and put it to the backup directory (defined by the BACKUP_DIR parameter in the global backup configuration file.

Top of page

Feedback