Previous page

Next page

Locate page in Contents

Print this page

vzarestore

The vzarestore utility is used to manage Container backups: restore a Container or certain Container files/directories from the Container backup archive, list the backups existing on the Backup Node, remove backups, etc. vzarestore can be run on any Hardware Node provided this Node has the Parallels Agent software installed and running. The utility has the following syntax:

The utility has the following syntax:

vzarestore [CT | -e <CT1, ...>] [OPTIONS]

[BACKUP_NODE]

vzarestore -r,--remove <BACKUP_ID ...>

vzarestore -l,--list [LIST_OPTIONS] [BACKUP_NODE]

vzarestore --browse BACKUP_ID [BROWSE_OPTIONS] [BACKUP_NODE]

vzarestore --print-ct-config BACKUP_ID [BACKUP_NODE]

vzarestore --help

The restore options are the following:

-e CT1, ...

The Containers to be restored on the Source Node. Any Container can be specified using both its ID (e.g. 101) and its name (e.g. server1).

-b BACKUP_ID

The ID assigned to the Container backup. This ID can be used to restore this Container or its certain files from the backup with the specified ID. If not specified, the last Container backup is used.

This option is incompatible with the -e option.

--force

Do not stop on errors during the vzarestore execution. You are recommended to use this option when restoring more than one Container at once.

--skip-ct-config

Do not restore the Container configuration file. This option can be used only when restoring a single Container.

Note: The Container configuration file is not changed when restoring separate Container files.

--files PATH_TO_FILE

The full path to the file/directory inside the Container to be restored. This option is incompatible with the -e option.

--skip-locked

Do not stop on errors even if some of the files to be restored are in the 'locked' state.

-B

Handle the values after the -e option as Container backup IDs.

--storage BACKUP_NODE

The IP address and the credentials of the Backup Node where the Container backups are stored. Can be specified in the following form: USER[:PASSW]@IP_ADDRESS. If this option is omitted, the local Node is treated as the Backup Node.

Miscellaneous options for vzarestore:

-r, --remove

Remove the Container backup with the specified backup ID. You can specify several backup IDs and separate them by spaces.

-l, --list

Do not restore any Containers. Display the information on the existing backups located either on the Backup Node or on the local Node if the former is not specified.

--browse

Display the contents of the Container backup with the specified backup ID.

--print-ct-config

Display the configuration file contents of the Container backup with the specified backup ID.

The options which can be used with the --list option of vzarestore:

-f, --full

Display the full information on the specified Container backup.

--latest

Display the latest Container backups.

-e CT1, ...

Display the information on the backups for the specified Containers only.

-B

Handle the values after the -e option as Container backup IDs.

You can use the following browse options with the --browse option of vzarestore:

-d, --dir directory_path

The path to the directory inside the Container backup archive whose contents is to be shown.

Please send us your feedback on this help page