Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 2.55 KB

xenserver.md

File metadata and controls

78 lines (60 loc) · 2.55 KB

BareOS FileDaemon XenServer Plugin

This plugin makes backup of Xen Server. It can be used to save:

  1. VM: using the xe vm-export or snapshot-export-to-template command.
  2. HOST: using the xe host-backup command
  3. POOL DATABASE: using the xe pool-dump-database command

To restore select the needed file, found in /@XENSERVER in the catalog.

Prerequisites

The plugins has been developed and tested with Xen Server 7.1

You need the packages bareos-filedaemon-python-plugin installed on your client.

Installation

  1. Make sure you have met the prerequisites.
  2. Install the files BareosFdTaskClass.py, xenserver/BareosFdXenServerClass.py and xenserver/bareos-fd-xenserver.py in your Bareos plugin directory (usually /usr/lib/bareos/plugins)

Configuration

Activate your plugin directory in the fd resource configuration on the client

FileDaemon {                          
    Name = client-fd
    ...
    Plugin Directory = /usr/lib/bareos/plugins
}

Include the Plugin in the fileset definition on the director

FileSet {
    Name = "client-data"
        Include  {
            Options {
                compression = LZO
                signature = MD5
            }
            File = /etc
            #...
            Plugin = "python:module_path=/usr/lib/bareos/plugins:module_name=bareos-fd-xenserver"
        }
    }
}

Options

You can append options to the plugin call as key=value pairs, separated by ':'. Please read more about the BareOS Python Plugin Interface here: http://doc.bareos.org/master/html/bareos-manual-main-reference.html#Python-fdPlugin

Example plugin options:

    Plugin = "python:module_path=/usr/lib/bareos/plugins:module_name=bareos-fd-xenserver:host_backup=yes"

folder

Virtual folder used in catalog. Default: @XENSERVER

host_backup

Set to no to disable host backup. Default: yes

pool_dump_database

Set to no to disable pool dump database. If host is not the pool master, dump will be skipped. Default: yes

virtual_machines_backup

Set to yes to enable virtual machines backup. Default: no

virtual_machines

Semicolon separated list of virtual machines names to back up. if unset all virtual machine are dumped. Default: unset

exclude

Comma separated list of database names exclude from backup. Default: unset

running_only

Set to no to include virtual machines in any power-state. Default: yes

use_snapshot

Set to yes to create a snapshot and back up it instead of virtual machine itself. This allows back up running virtual machine. Default: yes