HyperV WinAPI: Configuration

Bacula Enterprise Only

This solution is only available for Bacula Enterprise. For subscription inquiries, please reach out to sales@baculasystems.com.

Note

It is highly recommended to enable compression when using the Hyper-V WinAPI Plugin for backups.
To perform backups using the Hyper-V WinAPI Plugin, the accurate option must be enabled.

Job Configuration

Once the Bacula File Daemon and the Hyper-V WinAPI Plugin are correctly installed and configured, setting a backup job up is as simple as adding the job and the fileset within the Bacula Director configuration file.

Important

The Enable VSS parameter must be set to no in the Fileset (see examples below).

The following plugin options are supported:

Name	Status	Default	Description
include	Optional	Include all (*)	a Unix shell-style wildcards pattern for including VMs by name
exclude	Optional	Exclude none	a Unix shell-style wildcards pattern for excluding VMs by name
tmp_dir	Optional	`Bacula-repo`	locates the Bacula working repository folder. Make sure there’s enought space on this location to create VM’s shapshots and exports. Default is a `Bacula-repo` folder in the VHD location.
pre_backup_action	Optional	None	action on the VMs before backup takes place. Can be None, Stop, Save. - None is noop. - Stop stops the VM before backup (useful when VM doesn’t support VSS or kernel freeze to maintain consistent backups). - Save saves the VM before stoping it.
post_backup_action	Optional	None	action on the VMs after backup is completed. Can be None, Restart, ForceRestart. - None is noop. - Restart restarts the VM if it was stopped or saved pre-backup. - ForceRestart restarts the VM unconditionnaly.
consistency_level	Optional	Application	overwrites the consistency level. Can be Application Consistent of Crash Consistent. Application is the recommanded value but some VMs might not support it.
allow_pre_save	Optional	Disabled	when enabled, allows retry with `pre_backup_action` set to Save and `post_backup_action` set to Restart, if crash consistency retry backup has failed.
cluster_mode	Optional	Disabled	when enabled, the plugin will parse and allow migration of VM’s that are not on the local node (for Failover Cluster configuration).
abort_on_error	Optional	Disabled	abort immediately the job if a serious error is found (b.e when no VM matches the `include` patterns). By default, a Job error is raised, but the job continues.
wait_on_vm_migration	Optional	Disabled	when the VM is in “migrating” state, the plugin will wait for the VM migration completion before processing with the backup if the option is enabled. Otherwise, it skips the VM.
user_name	Optional	None	the user name that will run the backup/restore operation. This is not the recommanded method. The user name can be specified locally on the hyper-v node in a `bacula-hv.usr` file located in the fd plugins folder.
user_password	Optional	None	the user password that will run the backup/restore operation. This is not the recommanded method. The user password can be specified locally on the hyper-v node in a `bacula-hv.pwd` file located in the fd plugins folder.