Previous page

Next page

Locate page in Contents

Print this page

vzabackup

The vzabackup utility can be run on virtually any Virtuozzo-based physical server (including the Source and Backup Nodes) having the vzabackup package installed. It has the following syntax:

vzabackup [BACKUP_OPTIONS] NODE1 ... [CT_OPTIONS]

vzabackup [STORAGE_OPTIONS]

The general backup options are the following:

-F, -I, --Tfull

Force performing a full backup.

-i, --Tinc

Make an incremental backup or, if no full backups are available, a full backup. If this option is omitted, the full backup is created.

--Tdiff

Make a differential backup or, if no full backups are available, a full backup. If this option is omitted, the full backup is created.

-D, DESCRIPTION "backup_description"

The description to be set for the backup archive. The backup description should always be quoted (e.g. "backup for Container 101").

-o, --rm-old

Create a new backup and then remove the oldest backup of the specified Container.

--rm-tag backup_ID

Create a backup and then remove the backup with the specified ID. You can learn what ID is assigned to what Container backup using the -l and -f options of the vzarestore utility.

-Cn, -C0

Create the Container backup without any compression. This will speed up the backing up time; however, it may significantly increase the size of the resulting backup file.

-Cg, -C1

Compress the resulting backups with the normal level of compression. This is the default level of compression used to back up all Nodes/Containers.

The optimal data compression level depends on the type of files to be stored in the backup archive. For example, it is advisable to use the 'normal' and 'none' compression types if most of the files to be backed up are already compressed (e.g. the files with the .zip and .rar extensions) or can be compressed with a low degree of efficiency (e.g. all executable files with the .exe extension or image files with the .jpg, .jpeg., and .gif extensions).

-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 with the -C0 and C1 options; however, it takes longer to create the backup file.

-Cb, -C3

Compress the resulting backups with the maximum level of compression. In this case the backup file size is the smallest; however, it may take much time to create the backups.

-J

If several Hardware Nodes are specified, tells vzabackup to back up the specified Hardware Nodes (and their Containers) simultaneously. If the option is omitted, the Hardware Nodes are backed up sequentially one after another.

--force

Force the process of backing up the Hardware Nodes/Containers. You are recommended to use this option when backing up more than one Node/Container.

--storage BACKUP_SERVER

The IP address or hostname and the credentials of the Backup Node where the created backup will be stored. Should be specified in the following format: [USER[:PASSW]]@IP_ADDRESS where:

  • IP_ADDRESS is the IP address or hostname of the Backup Node and
  • USER and PASSW denote the credentials of the root user used to log in to the Backup Node.

When using this option, keep in mind the following:

  • If you do not indicate the user and/or password to log in to the Backup Node, you will be asked to do so during the vzabackup execution.
  • If you are backing up Containers residing on the local Node and this local Node is also used as the Backup Node, you do not need to specify the Node credentials, provided that you are logged in to this Node as root.
  • If the --storage option is omitted, vzabackup puts the created Container backups to the backup directory on the local (Source) Node. By default, this directory is /vz/backups.

Node1...

The IP address and the root credentials of the Source Node, i.e. of the Node hosting the Containers to be backed up. Should be specified in the following form: [USER[:PASSW]]@IP_ADDRESS where:

  • IP_ADDRESS is the IP address or hostname of the Source Node and
  • USER and PASSW denote the credentials of the root user used to log in to the Source Node.

When using this option, keep in mind the following:

  • If you do not indicate the user and/or password to log in to the Source Node, you will be asked to do so during the vzabackup execution.
  • If you are backing up Containers residing on the Source Node, you do not need to specify the Node credentials, provided that you are logged in to this Source Node as root.

-q, --no-progress

Disables logging to the screen during the vzabackup operation.

The Container options define the list of Containers to be backed up:

-e CT1...

The Containers to back up on the Source Node. If this and the -x options are omitted, all Containers on the given Node will be backed up. Containers can be specified using both their IDs (e.g. 101 or 102) and their names (e.g. server1 or server2).

-x CT1...

The Containers that need not to be backed up, i.e. the Containers you wish to exclude from the backup process. If this and the -e options are omitted, all Containers on the given Node will be backed up. Containers can be specified using both their IDs (e.g. 101 or 102) and their names (e.g. server1 or server2).

--include-files files_list

The path to the files and directories inside the Container to be included in the backup.

--exclude-files files_list

The path to the files and directories inside the Container to be excluded from the backup.

The backup storage options are the following:

--view-folder

Display the path to and the login for the backup storage directory on the local Node. The default backup storage directory is /vz/backups. The login parameter is always empty because credentials can be set for samba folders only.

--set-folder PATH_TO_STORAGE

Set a new backup storage in the PATH_TO_STORAGE directory on the local Node.

Please send us your feedback on this help page