Restore Plugin Parameters

Bacula Enterprise Only

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

During a restore operation, the Libvirt Plugin uses the same parameters that were set for the backup job and saved in the Catalog. During restore, it is possible to change any of the parameters described in Generic Plugin Parameters and Estimate and Backup Plugin Parameters chapters. In addition to the parameters used for backup, the following restore-specific parameters are available.

Note

All these parameters are optionals.

Parameter	Value	Description	Required
new_domain_name	`<domain_name>`	Specifies a new name for the restored virtual machine. If not specified, the restored virtual machine name is generated using the format `<domain-name>-<restoreJobId>`. To avoid naming conflicts, if the generated name already exists on the hypervisor, the plugin automatically appends a random suffix, resulting in the format `<domain-name>-<restoreJobId>-<randomString(7)>`.	No
new_domain_uuid	`<domain_uuid>`	Specifies a new UUID for the virtual machine to be restored. If not specified, a random UUID is generated automatically. Two virtual machines cannot share the same UUID.	No
storage_pool_name	`<storage_pool_name>`	Specifies the storage pool in which restored disks will be stored. If not specified, disks are restored to their original storage pools.	No
new_storage_volume_names	`<storage_volume_name\|JSON format>`	Specifies new names for restored disks (when restoring a single disk, a single name may be specified). If not specified (or if some disks are omitted), restored disks are named using the format `<disk-name>-<restoreJobId>`. To avoid conflicts, if a generated disk name already exists on the hypervisor, the plugin appends a random suffix, resulting in `<disk-name>-<restoreJobId>-<randomString(7)>`. When specifying multiple disks, the plugin interprets the values as a key-value list, where: The key is the file name as shown in the Bacula restore selection. The value is the new disk name. Example: `vda_21474836480.qcow2=new-name-disk-01.qcow2, vdb_10737418240.qcow2=disk-store-db`	No
start_domain	`<no\|yes>`	Specifies whether the restored virtual machine should be started after the restore completes. If not specified, the default value is `no`.	No
ssh_port	`<port>`	Specifies the SSH port used to establish the connection to a remote hypervisor during restore. If not specified, the default value is `22`. For additional information about restoring from a remote hypervisor, see this section.	No
ssh_private_key_path	`<path>`	Specifies the SSH private key used to connect to a remote hypervisor during restore. If not specified, the default value is `~/.ssh/id_rsa.pub`. For additional information about restoring from a remote hypervisor, see this section.	No
no_network	`<no\|yes>`	Specifies whether network interfaces of the restored virtual machine should be deactivated. `no`: Network interfaces are enabled. `yes`: Network interfaces are disabled. If not specified, the default value is `no`.	No