5 1 0:OpenNebula Single File Restore

From SEPsesam


Welcome to the latest SEP sesam documentation version 5.1.0 Apollon. For previous documentation version(s), check documentation archive.


Virtualization Are you looking for an alternative for your VMware environment?

SEP supports a range of hypervisors, offering snapshot-based online backup of VMs.

Click HERE to get an overview of the available SEP modules and explore supported features like CBT, Single File Restore, and more.

Overview


SEP sesam supports single file restore – item-level restore of files, folders, and volumes from the FULL or COPY backup of the OpenNebula virtual machine if the saveset is stored on a SEP sesam data store (Path, Si3 deduplication store, etc.). By mounting the virtual disk, the operating system creates a virtual drive from the file and makes it available locally on your server.

You can restore individual files using the GUI restore wizard or via the web interface Restore Assistant. Although most options are the same in both restore interfaces, the web interface Restore Assistant is more intuitively designed and offers additional advanced options.

Note that this article only describes the procedure for restoring individual files of an OpenNebula VM. For details on complete VM restore, see OpenNebula GUI Restore or restore via web interface Restore Assistant.

Prerequisites

Before attempting to restore a single file, all preparation steps have to be performed properly, including configuration and VM backup. For details, see the OpenNebula.

To ensure error-free operation of SEP sesam and improve performance, make sure that the following conditions are met:

  • SEP sesam Server version ≥ 5.0.0 Jaglion. For the list of supported systems, see OpenNebula Support Matrix.
  • Backups must not be encrypted, compressed or stored on tape.
  • Make sure that there is sufficient free space on the target system to which you are restoring your data; by default, the target data store for restore is the same data store that was used for the backup.
  • During restore, it is recommended that you stop all activities on the target.
  • To restore single files via the web interface Restore Assistant, appropriate permissions are required. For details, see About Authentication and Authorization.
  • SFR of backups from virtualization platforms requires the guestfs-tools package to be installed on Linux in order to access and mount VM disk image on Linux. If the package is not installed on your SEP sesam Server or Linux RDS, it is not possible to mount VMDK and perform SFR. Refer to Installing guestfs-tools on Linux.
  • Before starting a restore, check the restrictions for mounting the virtual disk (VHD file).

Restore options

When restoring individual files from OpenNebula VM backups, you can choose from the following VM restore options to perform restore according to your needs:

  • Do not overwrite existing items: (default) Files are only restored if they do not already exist on the target system.
  • Overwrite existing items': If the data exists on the target server, it is replaced with the restored version.
  • Create new version: Restore files under a new name.
  • Keep original tree structure: When restoring to the original location, the Keep original tree structure option is selected by default. The directory structure of the restored files is the same as the original directory structure of the backed up data.
  • Restore all items flat in the selected target directory: The backup is simply restored to a file without recreating the directory structure.
  • You can also select to skip ACL settings during restore.

Restoring single files

Depending on the interface you are using, follow the appropriate procedure to restore individual OpenNebula VM files:

Restoring a single file (SFR) is supported only in advanced UI mode. For details on switching the UI mode, see Setting the UI mode in the GUI and Setting the UI mode in the Restore Assistant.

Note
The operations and options available after logging in may differ depending on the user type. Other GUI and Web UI display restrictions may depend on the custom roles with specific permissions and the UI mode.
For details, see About Authentication and Authorization and User Roles and Permissions.

Using the GUI restore wizard

Make sure your UI mode is set to advanced and create a new restore task for the individual item(s) you want to restore.

  1. From the SEP sesam GUI menu bar, select Activities -> Restore. The New Restore Task window opens.
  2. Select what you want to restore. You can search savesets by task name or by filename or path.
    • When searching by task name, use the drop-down list of available tasks and select the one you want to restore from. This option is selected by default.
    • If you are searching by filename/path, select the option Filename or path in a saveset and enter your search expression in the search pattern field.
  3. In the Saved in period drop-down lists, specify the time frame for which you want to conduct the search. Click Next.
  4. The search results are displayed. From the list of savesets matching your query, select the version from which you want to restore an individual file. Then select the Mount virtual disk(s) check box. Note that some restrictions apply.
  5. You can also select RDS to mount on from the drop-down list and specify advanced mount options.
    Note
    • To be able to access and mount VM disk image on Linux, the guestfs-tools package must be installed on your SEP sesam Server or Linux RDS. If the guestfs-tools package is not installed on your SEP sesam Server or Linux RDS, it is not possible to mount VMDK and perform SFR. Refer to Installing guestfs-tools on Linux.
    • Mounting is not possible if the savesets are stored on tapes or if the data is compressed or encrypted. Some other XPRFS restrictions also apply to mounting.

  6. Mount is triggered and your virtual disk is mounted to the device server. This may take a few seconds. Click OK.
  7. You can now either use the file explorer on your server to browse and copy the needed files directly to the target location, or click Next to select the required files in the Select Files dialog.
  8. If you clicked Next, in the Select Files window select the data you want to restore and click Next.
  9. In the fourth step of the restore wizard (Target Settings), select a restore target (Target node and New restore target) where you want to restore your files.
  10. Then select an appropriate restore option (Overwrite existing items, etc.) as described in the above section.
  11. In the final step of the restore wizard, you can review all the settings of your restore task. You can start your single file restore immediately by clicking Start. If you want to save the restore task, click Save.
  12. Click OK to unmount the saveset and close your restore session.

Using the web Restore Assistant

You can restore individual files of an OpenNebula VM in the web interface in the advanced UI mode if you have the appropriate permissions. For more details on the UI mode, see Setting UI mode in the Restore Assistant.

To familiarize yourself with the concept of user permissions, see About Authentication and Authorization.

  1. Open the Restore Assistant in the browser. There are three ways to do this:
    • via the GUI: by clicking the Restore Assistant icon in the toolbar or from Activities -> Restore Assistant
    • from SEP sesam Web UI: left menu -> Restore Assistant
    • or by entering the following address in the browser bar: http://[sesamserver]:11401/sep/ui/restore/.
  2. In the Start window, select OpenNebula. Then select the option Advanced View. The VM or single file restore option is selected by default. Click Next.

  3. In the Virtual Machine window, under Selection of the server, select your target OpenNebula server to which the data will be restored.
    Then, under Selection of the virtual machine, select the VM that you want to restore and click Next.
  4. In the Task window, under Task selection, select your source task. A backup task defines the source data that was backed up by the client.
    Then, under Backup selection, select the exact backup version you want to restore. You can use the calendar function in the upper right corner to set a date range for the backups. Select the Single file restore option (in the lower right corner) and click Next.

  5. In the Files window, you have to select the SEP sesam Server or RDS to which you want to mount the backup. You can also specify an alternate mount path and/or advanced mount options. Then click the button Mount this backup in filesystem. A new window will appear showing the progress of the mount process.
  6. Note
    • To be able to access and mount VM disk image on Linux, the guestfs-tools package must be installed on your SEP sesam Server or Linux RDS. If the guestfs-tools package is not installed on your SEP sesam Server or Linux RDS, it is not possible to mount VMDK and perform SFR. Refer to Installing guestfs-tools on Linux.
    • Mounting is not possible if the savesets are stored on tapes or if the data is compressed or encrypted. Some other XPRFS restrictions also apply to mounting.
  7. Once a virtual disk is mounted on the device server, select the files or folders you want to restore and click Next.
  8. In the Target window, under Target selection, select your target environment for restore.
    Then select an appropriate restore option (Overwrite existing files, etc.) as described in the above section. Click Next.
  9. In the Options window, you can specify additional advanced options, such as selecting a data source (media pool, drive, etc.), set include/exclude filters, etc. For details on the available options, see Online restore in advanced UI mode.
    Click Next.
  10. In the last step, check the summary of your restore task (restore type (based on task type, selected backup, its date and details, restore options, etc.) and click Start restore.

Monitoring restore

You can monitor the restore progress using the Web UI (Monitoring -> Restores) or view the status in the GUI (Main Selection -> Job State -> Restores). The restore overview provides detailed information on the last run of restore jobs, including task name, status (successful, error, in queue...), start and stop time of the last backup, data size, throughput, etc. For details, see SEP sesam Web UI or Restores by State in the GUI.


See also

Installing guestfs-tools on LinuxOpenNebula RestoreWeb Single File Restore for Virtual MachinesRestore AssistantAbout Authentication and Authorization

Copyright © SEP AG 1999-2024. All rights reserved.
Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP AG. When compiling and designing user documentation SEP AG uses great diligence and attempts to deliver accurate and correct information. However, SEP AG cannot issue a guarantee for the contents of this manual.