Previous page

Next page

Locate page in Contents

Print this page

prlctl backup, backup-list, backup-delete, restore

Creates, lists, deletes or restores virtual machine backups.

Syntax

prlctl backup <vm_ID|vm_name> [ -f , --full ] [ -i , --incremental ] [ --description <desc> ]

[ -s , --storage [ user [ : passwd ] @ ] server [ : port ]

prlctl backup-list [ vm_ID|vm_name ] [ -f , --full ] [ --localvms ]

[ -s , --storage [ user [ : passwd ] @ ] server [ : port ]]

prlctl backup-delete { <vm_ID|vm_name> | -t , --tag <backup_ID> }

[ -s , --storage [ user [ : passwd ] @ ] server [ : port ]]

prlctl restore { vm_ID|vm_name | -t , --tag <backup_ID> } [ -n , --name <new_name> ] [ --dst <path> ]

[ -s , --storage [ user [ : passwd ] @ ] server [ : port ]]

Options

Name

Description

<vm_ID|vm_name>

Virtual machine ID or name.

  • Use with prlctl backup to create a backup of the specified virtual machine.
  • Use with prlctl backup-list to list backups of the specified virtual machine.
  • Use with prlctl backup-delete to delete all backups of the specified virtual machine.
  • Use with prlctl restore to restore the most recent backup of the specified virtual machine.

-s, --storage [ user [ : passwd ] @ ] server [ : port ]]

Specifies a remote backup server address, port, and credentials.

If this option is omitted, the backup will be saved on the default backup server that can be configured using the prlsrvctl set command.

--description <desc>

Backup description.

Descriptions with white spaces must be enclosed in quotation marks.

-f, --full

  • Use with prlctl backup to create a full backup of the virtual machine. A full backup contains all virtual machine data.
  • Use with prlctl backup-list to display full backup information.

-i, --incremental

Create an incremental backup of the virtual machine. An incremental backup contains only the files changed since the previous full or incremental backup.

This is the default backup type.

--localvms

List local backups only.

-t, --tag <backup_ID>

The ID of the backup to restore or delete.

-n, --name <new_name>

A new name to assign to the restored virtual machine.

If omitted, the virtual machine will be restored with the original name.

--dst <path>

Restore the virtual machine to the specified directory on the Parallels server.

If this option is omitted, the virtual machine will be restored to /var/parallels/ <vm_name> .