Estimate and Backup Plugin Parameters

Enterprise

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 only to Backup and Estimate Jobs.

Note

All these parameters are optionals.

Parameter

Value

Description

Required

backup_method

[=checkpoint|external_snapshot|block_dev]

Specifies the backup method used to back up virtual machines.

  • With the checkpoint method, the plugin uses disk checkpoints to identify changed blocks, without capturing the memory state.

    This method is compatible with QCOW2 disks.

  • With the external_snapshot method, the plugin creates an external snapshot that isolates disk changes into multiple files.

    This method supports RAW disks, but only full backups are allowed (this limitation will be removed in future versions).

  • With the block_dev method, the plugin uses checkpoint functionality via QMP to determine disk changes without capturing the memory state.

    It is compatible with both QCOW2 and RAW disks; however, checkpoints are retained only until the domain is powered off.

If not specified, the default value is checkpoint.

Pay close attention to user permissions. Additional details are available in this section.

No

domain

<domain_name>

Specifies which virtual machines should be backed up. This parameter may be specified multiple times. If neither this parameter nor domain_uuid is specified, all virtual machines are backed up.

No

domain_uuid

<domain_uuid>

Specifies which virtual machines should be backed up using their UUID. This parameter may be specified multiple times. If neither this parameter nor domain is specified, all virtual machines are backed up.

No

domain_exclude

<domain_name>

Specifies virtual machines to be excluded from the backup process. If not specified, no virtual machines are excluded.

No

domain_uuid_exclude

<domain_name>

Specifies virtual machines, identified by UUID, to be excluded from the backup process. If not specified, no virtual machines are excluded.

No

domain_regex_include

<regex_to_include>

Specifies, using regular expressions, which virtual machines should be included in the backup.

No

domain_regex_exclude

<regex_to_exclude>

Specifies, using regular expressions, which virtual machines should be excluded from the backup process. If not specified, no virtual machines are excluded.

No

storage_pools_config

[=all|no|storage_pool_name]

Specifies whether to back up the configuration of all storage pools or a specific storage pool. If not specified, all storage pools are backed up.

No

networks_config

[=all|no|network_name]

Specifies whether to back up the configuration of all networks or a specific network. If not specified, all network configurations are backed up.

No

cold_backup

[=0 or 1]

Specifies how to handle virtual machines that are powered off at the time of the backup. When enabled, powered-off virtual machines are started in paused mode for the duration of the backup.

This option does not alter the state of virtual domain that is already running. If not specified, the default value is 1.

No

domain_disk_exclude

</disk/path/disk.qcow2>

Specifies the path of a disk to be excluded from the backup. If not specified, no disks are excluded.

No

domain_disk_regex_exclude

<regex_to_exclude>

Specifies, using a regular expression, disk paths to be excluded from the backup. If not specified, no disks are excluded.

No

quiesce

[=no|try|yes]

Specifies whether the plugin attempts to quiesce the virtual machine before backing it up.

Quiescing is possible only when the virtual machine is running and the guest system has qemu-agent-command installed.

  • yes: Quiescing is required; an error is issued if quiescing fails.

  • try: Quiescing is attempted; a warning is issued if it fails.

  • no: Quiescing is not attempted.

If not specified, the plugin attempts quiescing.

No

custom_quiesce

[=0 or 1]

Specifies whether a custom quiesce process is executed before backing up a virtual machine. On Linux systems, the custom scripts must be located at:

  • /usr/sbin/pre-freeze-script (quiesce)

  • /usr/sbin/post-thaw-script (thaw)

If not specified, custom quiescing is disabled.

No

custom_quiesce_args

<arguments>

Specifies arguments passed to the custom quiesce script. This parameter applies only if custom_quiesce is enabled. If not specified, the default value is empty.

No

custom_unquiesce_args

<arguments>

Specifies arguments passed to the custom unquiesce script. This parameter applies only if custom_quiesce is enabled. If not specified, the default value is empty.

No

ssh_private_key_path

</path/to/id/rsa>

Specifies the SSH private key used for remote backups. This parameter applies only when uri uses the SSH protocol to connect to a QEMU/KVM hypervisor.

If not specified, the default value is ~/.ssh/id_rsa. For more information about the connection with QEMU/KVM remote hypervisor, see this section.

No

ssh_port

<port>

Specifies the SSH port used to establish the SSH connection to the remote QEMU/KVM hypervisor. This parameter applies only when the uri parameter uses the SSH protocol.

If not specified, the default value is 22. For more information about the connection with QEMU/KVM remote hypervisor, see this section.

No

libvirt_user

<libvirt-user>

Specifies the Libvirt user on the hypervisor. This is required to change ownership of temporary files.

If not specified, the default value is libvirt-qemu. Additional details are available in this section.

No

libvirt_group

<libvirt-group>

Specifies the Libvirt group on the hypervisor. This is required to change group ownership of temporary files.

If not specified, the default value is libvirt-qemu. Additional details are available in this section.

No

mandatory_access_control

[=<0 or 1>]

Specifies whether the plugin manages Mandatory Access Control (SELinux or AppArmor).

If not specified, the default value is 1. Additional details are available in this section.

No

selinux_context

<selinux-context>

Specifies the SELinux context applied to temporary files used by the plugin.

If not specified, the default value is svirt_image_t. Additional details are available in this section.

No

template_apparmor_file

<path-to-apparmor-file>

Specifies the AppArmor profile template used by the domain.

If not specified, the default value is /etc/apparmor.d/libvirt/libvirt-%s, where %s is replaced by the domain UUID. Additional details are available in this section.

No

See also

Previous articles:

Next articles:

Go back to: Libvirt Plugin: Configuration.