Home > Backup and Recovery Blog > XenServer Backup using Bacula. How to Backup Citrix Hypervisor?
1 Star2 Stars3 Stars4 Stars5 Stars
(18 votes, average: 4.94 out of 5)

XenServer Backup using Bacula. How to Backup Citrix Hypervisor?

  • July 7, 2020 (Last Updated: August 25, 2020), Rob Morrison

Citrix Hypervisor (previously called XenServer) is a comprehensive virtualization management platform with a variety of capabilities and supported infrastructure types. Citrix Hypervisor is a result of a rebranding of its product formerly known as  XenServer.

General information

Bacula Enterprise provides native integration with Citrix Hypervisor via a specific plugin (or ‘Module’; the terms are interchangeable in this context). This level of integration allows Bacula Systems users to perform various XenServer backup and recovery operations on different levels with Citrix Hypervisor no matter the size or complexity of the data center in question. There’s also an especially large potential in regards of flexibility and the customizability of the solution, including deployment locations, data types, recovery methods, and so on.

Bacula Enterprise’s backup and recovery of XenServer Citrix Hypervisor offers a variety of different features, including:

  • Full, Incremental and Differential image-level XenServer backups;
  • Online backup capabilities with a snapshot technology for guest VMs;
  • Full VM image restoration capabilities;
  • Support for the older backup formats and types;
  • The ability to perform VSS-based snapshots of guest VMs;
  • An option to change the target directory for a VM archive, and much more.

XenServer backup and recovery without third-party software

Before going over Bacula’s capabilities with the XenServer it’s also important to mention that there is a way to do Xen backup and restore operations with Xen itself. There are a few limitations to that, though – server backups might take a lot of storage space, you may need to restart with the original installation CD to perform a complete restore process, and you must not create XenServer control domain backups (domain 0).

Here’s how the backup process goes:

  1. Select the designated server in the Resources panel, click the Server menu and proceed to the Back Up Server… line.
  2. Locate and specify the folder that you want to use as the backup file storage location, enter the filename and click Save. The backup process will begin. You may also use the Logs tab to see the process of the backup.

And that’s about it, the entire backup process is just two steps. The restore process is also relatively simple:

  1. First you’ll have to locate that same menu Server and click the Restore From Backup… line.
  2. In the following menu locate the backup file that you want to restore.
  3. Use the XenServer install CD to restart the server and complete the entire restoration process.

Bacula client installation on each guest VM

When it comes to actual XenServer VM backup and restore operations with Bacula, there are a number of different approaches, and it’s somewhat more sophisticated than the original method. First of all we’ll work out the way that Bacula and Citrix can operate with guest VMs and which XenServer backup strategies work for those.

This particular strategy works by installing a Bacula Enterprise File Daemon on every guest VM, treated as if they are normal, physical clients. You will have to manually take advantage of Bacula’s scheduling, prioritizing and parallel job performing capabilities to optimize I/O usage of the Citrix Hypervisor and avoid various hiccups and bottlenecks.

Performing an installation of a Bacula Enterprise File Daemon on a particular VM allows you to manage it like a physical server, allowing for a number of useful Bacula Enterprise features, including:

  • Compression on a file level;
  • Job verification;
  • Backup accuracy;
  • Individual file restoration;
  • Exclusion of specific files or directories;
  • Checksum verification to look for spyware of viruses.

Using Citrix Hypervisor module to create image backups

The image-level strategy allows Bacula’s Citrix Hypervisor module to use the raw disk level to create backups. There is no need to install a Bacula Daemon on each VM for this technique to work, either. The Xen module takes advantage of XenServer’s API to locate and save the contents of each of your VMs using the snapshot technology and the vm-export/vm-import methods.

This method typically saves significant resources since there’s no need for Bacula to “walk” through each and every VM’s filesystem, allowing to ease the workload of a Citrix Hypervisor infrastructure in general. On the other hand, since this XenServer VM backup type saves literally everything on a particular VM, this also includes useless files that you don’t really need in your backup, such as temp files or swap files. However, it’s also an advantage as well, since the VM configuration files are also saved via this method - allowing for much easier VM restoration.

Backup process

There are four main steps in the basic process of creating a backup of a single VM using XenServer VM backup module:

  • Older version deletion;
  • New VM snapshot creation and the preparation stage of the backup;
  • vm-export command execution and data being saved to a Bacula storage;
  • Snapshot deletion as soon as the backup is done.

Both running and halted guest VM states are suitable for performing a backup process. The only snapshots that would be considered old by the system are the ones that fit the specific template – BaculaSnapshot_<UUID>_JobID_<NR>. Those are automatically deleted at early stages of the Xen backup process, so it’s recommended to avoid creating manual snapshots that fit this naming template. Citrix Hypervisor module’s status console would offer you the information about the guest VMs that are currently backed up, the stages of each XenServer backup, snapshot activities, which backups were deleted, etc. You can see an example of this information below:


JobId 135: Start Backup JobId 135, Job=xen.2017-12-28_15.52.21_11
JobId 135: Using Device "FileChgr1-Dev1" to write.
JobId 135: Volume "Vol-0002" previously written, moving to end of data.
JobId 135: xenserver: Start Backup vm: CentOS 7 (fe1ccf3b-1865-3942-c928-d98138397ff1)
JobId 135: xenserver: Old stalled backup snapshots found.
JobId 135: xenserver: Snapshot deleted: 12e387c0-eac5-84b1-8e40-1d0601c9eebf
JobId 135: xenserver: Snapshot created: 03afdf67-4ae3-7b0a-5eb0-2c2520c8580f
JobId 135: xenserver: Snapshot deleted: 03afdf67-4ae3-7b0a-5eb0-2c2520c8580f
JobId 135: xenserver: Backup of vm: CentOS 7 (fe1ccf3b-1865-3942-c928-d98138397ff1)

Every guest VM participating in the process means one more XenServer backup file, named as follows:



There’s also a number of parameters that are used to define specific parts and variations of the Xen backup process.

  • vm=<name-label> represents a guest VM’s name that you’ll be backing up. All matches with the name-label in the brackets will be backed up. The parameter itself is optional and not required for the entire process to work.
  • uuid=<uuid> specifies a UUID of the specific guest VM. UUID is the universally unique identifier – a 128-bit number that identifies information in various systems. The parameter itself is optional and not required for the entire process to work.
  • include=<name-label-regex> is a list of guest VM names to backup, expressed via regular syntax. All guest VMs with matching names would be backed up. The parameter itself is optional and not required for the entire process to work.
  • exclude=<name-label-regex> is a list of guest VM names to exclude from the backup process, expressed via regular syntax. All matches would be excluded from the backup process entirely. Does not affect either the vm= or the uuid= parameters. The parameter itself is optional and not required for the entire process to work.
  • quiesce=<0|1> is about specific guest VMs that you want to be created using the quiesce method. This method is only supported by Windows OS with guest tools installed. The whole backup job is aborted if the guest VM snapshot can’t be created via quiesce method.

It is worth noting that, since all the specification parameters themselves are optional, the system would proceed to backup all of the available guest VMs if there’s no vm=, uuid=, exclude or include input found beforehand. There’s also a specific parameter called abort_on_error, that orders the entire job to be halted if there’s an error found in the setup process, like the lack of vm= parameters, or any other parameters in the first place.

Restore process

The restore process as a standalone operation pursues two main targets:

  • Restoration to a local directory from an XVA archive file;
  • Restoration to a XenServer hypervisor as new or original guest VM.

There are several methods that can be utilized for the restoration process. For example, here’s one restore to the XenServer method. It requires setting up a “where=/” restore parameter in Bacula. In that case the guest VM archive in question would be restored as a new guest VM via Citrix Hypervisor, or restored as the original form of this VM if the preserve option is set beforehand. Failure to set up a correct path for the restoration process will result in the guest VM being created at the default Citrix Hypervisor directory.

There’s also the restore to local directory method, which utilizes the “where=/some/path” restore parameter. This path needs to represent a specific location on the server where the module is installed, and even if it doesn’t exist - it would be created by the plugin itself.

The basic restoration process is relatively easy on its own, it requires a specific command to be executed, with the “where” parameter added in one way or another:


* restore where=/…

In regards to the restore parameters that are used to include or exclude specific VMs, those are similar to the ones used in the backup process. There are some additions to that, too:

  • server: <address> is used to specify the XenServer API address to perform the operation, and in the case of this parameter being incorrect or absent – the default one will be utilized instead;
  • port: <number> is specifying the port of the XenServer API to be used, must be in the range between 1 and 65536; the invalid parameter causes the job to be aborted and the omission of this parameter leads to the process using the default port.
About the author

Rob Morrison Rob on LinkedIn

Rob Morrison is the marketing director at Bacula Systems. He started his IT marketing career with Silicon Graphics in Switzerland, performing strongly in various marketing management roles for almost 10 years. In the next 10 years Rob also held various marketing management positions in JBoss, Red Hat and Pentaho ensuring market share growth for these well-known companies. He is a graduate of Plymouth University and holds an Honours Digital Media and Communications degree, and completed an Overseas Studies Program.

  1. Joel

    It’s interesting how a lot of different platforms or databases nowadays have their own means of creating backups, even if it’s with heavily limited functionality. The same goes for XenServer backups, too, even though Bacula’s solution is that much more user-friendly and customizable.

  2. Korey

    Let me get this straight – I don’t have to worry about any other backup XenServer VM snapshots unless their naming fits this specific template, right? So I don’t have to worry about all of the snapshots being deleted in the process?

  3. Cynthia

    @Korey, Yes, that is true, your snapshots are safe during the backup XenServer virtual machine process, unless they start with “BaculaSnapshot_”, and fit the rest of the example from the article at the same time.

Leave a comment

Your email address will not be published. Required fields are marked *