Backup Destinations
A backup destination is a storage location where vProtect keeps VMs, Containers, Cloud and applications backup copies. To configure a backup destination, you can use the following storage types:
The backup destination is defined by the backup provider configuration and retention settings. Each policy can be backed up to the selected backup destination. Backup destinations must be assigned to the nodes in the node configuration.
Note: removal of any backup destination leaves data in the backup provider without option to re-attach it in the future.


vProtect handles retention for all backup destinations except NetBackup. There are 4 properties that define how long backup should be kept in the backup destination:
  • Retention (Full) - no. of versions to keep - number of full backups
  • Retention (Inc.) - no. of versions to keep - number of incremental backups
  • Retention (Full) - no. of days to keep - number of days to keep a full backup
  • Retention (Inc.) - no. of days to keep - number of days to keep an incremental backup
Whichever condition is met first (either number of versions has been reached or the backup is older than the given limit), it is removed from the backup destination.
Each backup destination also needs a unique Name for easier identification in the configuration.

Pre/post access command execution

  • Prepare your scripts
    • the pre-script is invoked before every access to the Backup Destination - common usage - create and mount the remote volume
    • the post-script is executed after Node finishes store, restore and clean-up operations
  • The following environment variables are set before each execution - you can use them later in your scripts:
    • VP_VM_GUID - GUID of the VM in vProtect
    • VP_VM_UUID - UUID of the VM used by the hypervisor or hypervisor manager
    • VP_VM_NAME - name of the VM
    • VP_VM_TMP_DIR - path to the folder containing files in staging
    • VP_BD_GUID - GUID of the Backup Destination being accessed
    • VP_BD_NAME - name of the Backup Destination being accessed
    • VP_CONTAINER_NAME - standard container name generated by vProtect that can be used for names of the volumes (format <VM-NAME>__<PART-OF-UUID>, i.e. Centos 7__8d3ef6f1, may contain special characters)
    • VP_EXPORT_PATH - an export path from Node Configuration, can be used as the mount root for backup destination volumes
    • VP_TASK_TYPE - name of the task type, e.g.: STORE/RESTORE/DELETE_VM/OLD_BACKUPS_REMOVAL - to distinguish operation type when scripts are being invoked
  • Upload your scripts to the node, where the vprotect user is able to access them
  • Optionally, you may need to add a new file in the /etc/sudoers.d/ directory to enable the vprotect user to execute privileged script (like chown operations in some file system locations): %vprotect ALL=(root) NOPASSWD: /opt/vprotect/scripts/myscripts/
  • Open the "BACKUP DESTINATIONS" section from the left menu:
  • Open your Backup Destination (click on the name)
  • Provide pre/post access command arguments (first argument is the command executed locally on the node):
Last modified 3mo ago