Restoration Utility Commands and Options

Location

$PRODUCT_ROOT_D/bin/pleskbackup where the $PRODUCT_ROOT_D is /usr/local/psa for RPM-based systems or /opt/psa on DEB-based systems. 

Usage
pleskrestore <command> [<arguments>] [<options>]
Commands
Command Argument Description

--restore

<backup_file>

Restores data from the specified backup.

Requires the -level option.

--check-backup

<backup_file>

Checks integrity of the specified backup file, which is:

  • backup digital sign match
  • backup file format
  • content files integrity

--get-restore-task-status

<task ID>

Displays the status of a restoration task while the restoration is being implemented. You can get the task ID using the -async option with the --restore command.

-i|--info

<backup_file>

Shows the backup file description.

-h|--help

 

Displays help on the utility usage.

Options
Option Argument Description

-level

clients|resellers|domains|server

Specifies restore level.

Required with the --restore command.

-filter

<file>|<list:<item1_name>[,<item2_name>[,...]]>

Specifies list of subscriptions, customer or reseller names for restoring. The object names are listed either in a specified file, one per line, or as the option argument, separated by commas.

-only-mailnames

<file | list:item1[,...]>

Specifies a list of mailboxes for restoration. The list can be read from a file or specified in a comma-separated list. The format of a list item is <mailbox>@<domain_name>.

Use the additional option -domain-name to specify the subscription for which you want to restore the mailboxes.

-only-maillists

<file | list:item1[,...]>

Specifies a list of mailing lists for restoration. The list can be read from a file or specified in a comma-separated list. The format of a list item is <mailing list>@<domain_name>.

 

Use the additional option -domain-name to specify the subscription for which you want to restore the mailing lists.

-only-databases

<file | list:item1[,...]>

Specifies a list of databases for restoration. The list can be read from a file or specified in a comma-separated list. The format of a list item is [<server_type>:[<server_host>:[<server_port>:]]]<database_name>, where server_type can be mysql, mssql, or postgresql.

 

Use the additional option -domain-name to specify the subscription for which you want to restore the databases.

-only-web-content

file | list:item1[,...]>

Specifies a list of files or directories for restoration. The list can be read from a file or specified in a comma-separated list. Paths to files and directories should be relative to the subscription root.

 

Use the additional option -domain-name to specify the subscription for which you want to restore the files

-only-sites

file | list:item1[,...]>

Specifies a list of sites for restoration. The list can be read from a file or specified in a comma-separated list. The format of a list item is <domain_name>.

 

Use the additional option -domain-name to specify the subscription for which you want to restore the sites.

-only-dns-zones

file | list:item1[,...]>

Specifies a list of DNS zones for restoration. The list can be read from a file or specified in a comma-separated list. The format of a list item is <domain_name>.

 

Use the additional option -domain-name to specify the subscription for which you want to restore the DNS zones.

-only-certificates

file | list:item1[,...]>

Specifies a list of SSL certificates for restoration. The list can be read from a file or specified in a comma-separated list. The format of a list item is <certificate_name>[:<domain_name>].

 

Use the additional option -domain-name to specify the subscription for which you want to restore the certificates.

-domain-name

<domain_name>

Specifies the domain name. Used with the -only-mailnames, -only-maillists, -only-databases, -only-web-content, -only-dns-zones, -only-sites or -only-certificates options.

-configuration-only

 

Restores configuration only (without content). Used with the -level, -only-mailnames, -only-databases, -only-sites and -only-maillists options.

-content-only

 

Restores content only (without configuration). Used with the -only-mailnames, -only-databases, -only-sites and -only-maillists options.

-server-pool

 

Specifies that SSL certificates are from the server pool. Use with the -only-certificates option.

-license

 

Restores Plesk license key from the backup.

-verbose

 

Enables verbose restore mode.

-quiet

 

Enables quiet restore mode.

-debug

 

Enables debugging restore mode.

-nowarning

 

Do not display warning messages.

-conflicts-resolution

<file>

Specifies file that describes conflict resolution policies and rules.

-dump-file

<backup_file>

Specifies a backup file to restore.

-param-file

<param_file>

Specif parameters file.

-suspend

 

Suspends the sites being restored.

-backup-password

<password>

If you used password protection for a backup, use this option to specify the password. You can also set the password with the environment variable PLESK_BACKUP_PASSWORD, this is a more secure way.

-ignore-backup-password

 

Allows you to restore a backup without providing the backup password. Note that in this case, some sensitive data will not be restored properly. For example, user passwords will be replaced with random ones, the information about already installed APS apps will be lost, and so on.

-ignore-sign

 

Allows restoring backups that are created on other servers or in Plesk versions earlier than 11.5.

Warning: If you use this option, Plesk will restore the backup file even if it is corrupted or modified manually.

-async

 

Restores the backup asynchronously, which means it returns the restoration task's identifier, which you can use later to retrieve the task's status. Used with the --restore command.

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.