Generic Plugin Parameters

Bacula Enterprise Only

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

The following Libvirt Plugin parameters apply to all Job types (Backup, Estimate, or Restore).

Note

All these parameters are optionals.

Parameter	Value	Description	Required
abort_on_error	`[=<0 or 1>]`	Specifies whether the plugin should abort execution (and consequently the Bacula Job) if a fatal error occurs during a Backup, Estimate, or Restore operation. If not specified, the default value is 0.	No
log	`</path/to/log_file.log>`	Generates an additional log file in addition to the standard job log. This parameter is included in the backend configuration; therefore, by default, the log file is stored in the Bacula working directory.	No
debug	`[=<0 to 9>]`	Specifies that the plugin backend generates a debug output file at the location defined by the log parameter. This file can assist in troubleshooting job execution issues. If not specified, no debug output is generated.	No
uri	`<URI to connect>`	Specifies the URI used to connect to the QEMU/KVM hypervisor. If not specified, the default value is `qemu:///system`. To connect to a remote QEMU/KVM hypervisor, refer to this section.	No
nbd_server_address	<endpoint>	Specifies the network address on which the NBD server exposes the device. If not specified, the default value is `localhost`. For additional details, see this section.	No
nbd_server_port	`<port>`	Specifies the port on which the NBD server exposes the device. If not specified, the default value is `10809`. For additional details, see this section.	No
nbd_client_address	`<endpoint>`	Specifies the address from which the NBD client connects to consume the device. If not specified, the default value is `localhost`. For additional details, see this section.	No
nbd_client_port	`<port>`	Specifies the port used by the NBD client to consume the device. If not specified, the default value is `10809`. For additional details, see this section.	No
nbd_access	`[=user_directory\|nbd_device]`	Specifies how virtual machine disks are exposed using NBD in order to interact with them. When using `user_directory`, virtual machine disks are mounted in the directory defined by the `tmp_dir` parameter. This mode allows the plugin to operate without special system privileges. When using `nbd_device`, virtual machine disks are attached to block devices matching the pattern `/dev/nbdX`. In this case, the kernel must have the `nbd` module loaded, and the executing user must have the required permissions. If not specified, the default value is `nbd_device`.	No
use_sudo	`[=<0 or 1>]`	Specifies whether the plugin should use sudo when executing certain external commands. This is useful if the executing user lacks sufficient privileges. If not specified, the default value is 0. To enable this option, the user must be configured in the `sudoers` file to execute `qemu-nbd` without a password prompt. Example of user bacula entry in the sudoers file bacula ALL=(ALL) NOPASSWD: /usr/bin/qemu-nbd	No
tmp_dir	`</temporary/path/>`	Specifies the directory where the plugin creates temporary files during backup operations. When using the `checkpoint` backup method, the plugin creates scratch files for each virtual machine disk, which act as buffers during the backup. When using the `block_dev` backup method, full or partial disk data may be copied into this directory. This directory is also used to mount disks when `nbd_access=user_directory` is selected. The Libvirt user (by default libvirt-qemu) must have read and write access to this directory. When using the `block_dev` method, ensure that sufficient disk space is available, as large amounts of data may be written to this directory.	No