ShadowProtect SPX User Guide

Transcription

StorageCraft Copyright Declaration
StorageCraft ImageManager, StorageCraft ShadowProtect, StorageCraft Cloud, and
StorageCraft Cloud Services, together with any associated logos, are trademarks of
StorageCraft Technology Corporation in the United States and elsewhere. All other brands and
product names are or may be trademarks or registered trademarks of their respective owners.
Table of Content
Table of Content
1 SPX Overview
2 SPX Licensing Options
3 Linux Installation
2
3
4
5
3.1 Remote Management Installs
8
4 Windows Installation
9
4.1 Supported Windows Versions
4.2 Supported File Systems
4.3 Supported Storage Media
4.4 Multi-Boot Environments
4.5 Windows Silent Install
11
12
13
14
14
5 Windows Upgrade to SPX
16
5.1 Selecting Backup Volumes
18
6 Socket Licensing Service
19
6.1 Socket Licensing Service Installation
6.2 Register Hypervisors with the Socket Licensing Service
6.3 Configure Socket Licensing Service for Hyper-V
6.4 Configure Socket Licensing Service for vCenter/vSphere
6.5 SPX Activation through Socket License Service
6.6 Configuration Examples
7 The SPX Dashboard
29
7.1 Help Overlay
7.2 Menu Bar
7.3 Tool Bar
7.4 Backup Job Listing
30
31
34
35
8 SPX Quick Start
35
8.1 Activating SPX
8.2 Linux Quick Start
8.3 Windows Quick Start
35
36
36
9 How SPX Works
37
9.1 SPX Features and Components
9.2 Recovering Files and Folders
9.3 Restoring a Volume
9.4 SPX Backups
9.5 SPX Use Cases
9.6 VirtualBoot Scenarios
37
38
38
39
40
40
10 Creating a Backup Job
41
10.1 Destinations
10.2 Settings Tab
10.3 Schedule Tab
10.4 Advanced Tab
42
43
44
45
11 Monitoring Backup Jobs
48
11.1 Notifications
52
12 Restoring a Volume
13 Restoring Files and Folders
14 Converting Backup Files
15 Changing Backup Destinations
16 VirtualBoot
54
55
56
57
58
16.1 vSphere (ESXi Clusters)
16.2 Troubleshooting VirtualBoot for vSphere
16.3 Oracle VirtualBox
16.4 Microsoft Hyper-V
16.5 Launch a VM with VirtualBoot
58
64
68
70
72
17 Can't Find a Feature
18 SPX and ShadowProtect Feature Comparison
© 2016 StorageCraft Technology Corporation
20
21
24
26
27
27
StorageCraft Support Center
73
74
Page 2 of 76
StorageCraft ShadowProtect SPX is the latest sector-based backup and disaster recovery product from StorageCraft. SPX delivers
major benefits for:
Linux users: SPX seamlessly extends the capabilities of ShadowProtect to Linux servers—both virtual and physical. SPX
supports all the features on Linux that administrators and users rely on with ShadowProtect in the Windows environment.
These include Mount, Verify, and VirtualBoot.
Windows users: SPX upgrades existing ShadowProtect 5.x users to a newly designed user interface, more flexible scheduler,
and patented job timeline feature.
In particular, the SPX interface is identical in appearance and operation between Linux and Windows.
This user guide covers up to ShadowProtect SPX v6.3.0.
See the StorageCraft ShadowProtect SPX ReadMe for enhancements and known issues.
Additional Resources and Information
StorageCraft ShadowProtect SPX Forum
StorageCraft Technical Support Web site
StorageCraft Glossary technical terms
Documentation Conventions
This symbol designates either a Note, which contains an explanation or exceptions to the
text, or an Important item which provides details on making a selection about the
configuration and/or use of ShadowControl.
This symbol designates a Warning text. A warning highlights critical information that
affects backup job performance or potential loss of data.
1 SPX Overview
SPX highlights include:
Annual Subscription Licensing
SPX offers additional licensing options, with one or two year subscriptions and maintenance. Included with each license is
access to updates, upgrades, and standard technical support during the subscription period.
Socket Licensing provides a much more flexible and cost effective method of licensing SPX for VM environments.
Single Pane Management using ShadowControl 3.1 for both Linux and Windows.
Linux server support for Ubuntu 12.04 and 14.04; CentOS/Red Hat RHEL 6 and 7.
Windows Support for contemporary Server and Desktop releases including Windows 10.
New User Interface
SPX offers an improved user interface that is more intuitive and easier to use. This interface displays a patented interactive
timeline of existing backups. Select any backup to view a summary of that backup, including the backup file size.
Single install for both Perpetual and MSP licenses
Flexible backup job scheduler
SPX offers a predefined backup job profile for each backup type. Users can also customize their own, creating backups at the
date and time the user wants.
Improved Remote Management
SPX can serve as a remote console for machines also running SPX. SPX provides all options available locally to the remote
systems via the management connection. This remote connection leverages HTTP, rather than DCOM (as used by
ShadowProtect). This means that most firewalls allow the SPX connection without the changes required for DCOM.
Fully integrated with StorageCraft technology
SPX uses the same backup file format as other ShadowProtect products. This means that ImageManager, Cloud Services, and
ShadowProtect functions such as Mount, Verify, and VirtualBoot fully support both Linux-sourced backups as well as Windows.
SPX is a native 64-bit application
Extended VirtualBoot support to Linux
SPX supports VirtualBoot for Linux system volume backups.
VirtualBoot supports multiple hypervisors.
ShadowProtect SPX can now VirtualBoot backup images in Microsoft Hyper-V, Oracle VirtualBox, and VMware vSphere.
Unique SPX Codes for Windows Logs
SPX events now display unique codes for Windows system logs. This simplifies searches and sorts for SPX issues.
Page 3 of 76
Changing Backup Destinations
Users can now change an existing backup job's destination as storage needs change.
Differences with ShadowProtect 5.x
SPX performs differently than ShadowProtect 5.x in these areas:
SPX asks the user to log in using Windows Local Admin credentials to access SPX.
SPX automatically performs a self-healing incremental using DiffGen rather than requires selecting this option as in SP 5.
SPX does not support the ShadowProtect 5.x feature for using the NETGEAR ReadyDATA NAS device as a destination.
2 SPX Licensing Options
SPX requires a license/activation key to run. Before using the software, read the End User License Agreement.
License
Type
Description
Annual
Subscription
License
StorageCraft offers licenses with one or two year subscription
options and maintenance. Included with the license is access to
updates, upgrades, and standard technical support during the
subscription period.
Socket
Licensing
ShadowProtect SPX supports Socket Licensing. See the Socket
Licensing Service page for details.
Perpetual
License
StorageCraft licenses SPX on a one-license-per-system basis.
For example, to use SPX to backup 10 servers requires 10
server licenses. This is true for both physical and virtual
environments.
StorageCraft provides a fully-functional Trial license for SPX
which is valid for a period of 30 days. During the trial period
SPX can create and restore backup image files for both system
and data volumes. SPX can also restore specific files and
folders.
After 30 days, the license expires and the backup functions
Trial License cease to operate. Images created during the trial period are
fully restorable if you have a registered (perpetual) license
version of the software. You can download and use the
StorageCraft Recovery Environment CrossPlatform to restore
system volumes.
You don’t need an active SPX license to use VirtualBoot or
mount recovery points.
StorageCraft offers an MSP License for SPX as well. An MSP
MSP License license is a subscription-based model for Managed Service
Providers (MSP). Refer to the MSP User Guide for details.
Page 4 of 76
3 Linux Installation
SPX is available for installation from the StorageCraft public repo. Full instructions appear in the SPX section of the StorageCraft
website SPX product page using conventional Linux processes.
Note: For those new to ShadowProtect's sector-based backup and recovery, review the section How SPX Works. Use the
StorageCraft Glossary for definitions of SPX terms and processes.
Linux Volume Architecture
StorageCraft strongly recommends recording the disk partition layout and logical volume configuration when installing SPX. This
simplifies the restore process using the Recovery Environment.
Console Requirements
The SPX console requires an XServer GUI desktop environment. See the Remote Management section below for details on installing
on systems which do not have a GUI install or the system runs headless.
Supported Kernel Versions
StorageCraft continually updates this list of supported Linux kernel versions for Ubuntu and CentOS/Red Hat RHEL. A more
automated approach is to follow these instructions to confirm that SPX supports the installed kernel version:
Ubuntu (64-bit)
1. Set up the repo.
For Ubuntu 12.04, run:
wget http://downloads.storagecraft.com/spx/Ubuntu12.04/storagecraft-repo-latest.deb -O storagecraft-repo-latest.deb
sudo dpkg -i storagecraft-repo-latest.deb
sudo apt-get update
For Ubuntu 14.04, run:
wget http://downloads.storagecraft.com/spx/Ubuntu14.04/storagecraft-repo-latest.deb -O storagecraft-repo-latest.deb
sudo apt-get update
2. Type in this command in a terminal session to display the current supported kernel list.:
apt-cache search kmod-stcvsm
Note: This installs a copy of the StorageCraft repository public signing key to the files system and automatically adds it to the
apt keystore. A copy of this key can be found at
Ubuntu 12.04: :http://downloads.storagecraft.com/spx/Ubuntu12.04/stc/repository.key.
Ubuntu 14.04: :http://downloads.storagecraft.com/spx/Ubuntu14.04/stc/repository.key.
3. Install the latest version of SPX from the repo:
sudo apt-get update
sudo apt-get install spx kmod-stcvsm-$(uname -r) -y
4. To verify that the latest version of SPX installed, run:
dpkg-query --show spx
5. Add the current user to the SPX management group:
sudo /usr/bin/gpasswd -a $USER spx
6. Start the service:
Page 5 of 76
sudo start spx
7. Open the SPX console:
Use Search to locate the SPX icon
To open the interface from the terminal, use the terminal command:
/opt/StorageCraft/spx/bin/spx_gui
CentOS/RHEL (64-bit)
Important: The EPEL repository is REQUIRED to install SPX on CentOS/RHEL.
To install the EPEL repository on CentOS or RHEL run the command.:
sudo yum install epel-release
1. SPX may have a conflict if the system has fprintd-pam installed. To avoid this, uninstall fprintd-pam:
sudo yum remove fprintd-pam
Note: if this command displays errors, skip to the next step.
2. Open a terminal to install and configure the StorageCraft repo on the system.
To install on CentOS/RHEL 6, run:
wget http://downloads.storagecraft.com/spx/CentOS6/storagecraft-repo-latest.rpm
sudo yum install storagecraft-repo-latest.rpm -y
To install on CentOS/RHEL 7, run:
wget http://downloads.storagecraft.com/spx/CentOS7/storagecraft-repo-latest.rpm
3. Install the latest version of SPX from the repo:
sudo yum install spx kmod-stcvsm-$(uname -r)
4. To verify that the latest version of SPX installed, run:
rpm -qi spx
5.Start the service.
On CentOS/RHEL 6, run:
sudo start spx
On CentOS/RHEL 7, run:
sudo systemctl start spx
6. Add the current user to the SPX management group:
sudo /usr/bin/gpasswd -a $USER spx
7. Open the SPX console:
Select Applications > System Tools > ShadowProtect SPX to open the SPX user interface from the GUI.
To open the interface from the terminal, use the terminal command:
/opt/StorageCraft/spx/bin/spx_gui
CentOS/RHEL (64-bit) with EPEL repositories enabled and one of the supported kernel versions.
To view the current supported list:
1. Set up the SPX repo.
For CentOS6/RHEL6, run:
wget http://downloads.storagecraft.com/spx/CentOS6/storagecraft-repo-latest.rpm -O storagecraft-repo-latest.
rpm -O storagecraft-repo-latest.rpm
Page 6 of 76
For CentOS6/RHEL7, run:
wget http://downloads.storagecraft.com/spx/CentOS7/storagecraft-repo-latest.rpm -O storagecraft-repo-latest.rpm
2. Type into the command line:
yum list kmod-stcvsm*
Note: StorageCraft only supports distributions of Linux with long-term support (LTS) and not self-compiled or short-term
releases.
Updating SPX
Once SPX installs the StorageCraft repo deb package the first time, use these commands to install subsequent builds and updates:
Ubuntu (64-bit)
apt-get update
apt-get install spx
CentOS/RHEL
yum update spx
If SPX issues an error message saying there's a conflict with a package, remove the conflicting package:
And then repeat the install.
File Systems
SPX supports these Linux file systems on storage devices:
ext2
ext3
ext4
XFS
Sector Sizes
Contemporary hard drives and SSDs ship with a 4096-byte physical sector size. Most also support the 512-byte logical sector size.
(These drives are often labeled 512e for "512 Byte Sector Size Emulation".) SPX supports backing up both 4096- and 512-byte
logical sector sizes.
In the unusual situation of restoring a partition/volume from one logical sector size to another:
512 bytes per logical sector -> 4096 bytes per logical sector (and the destination does not support 512e)
4096 bytes per logical sector -> 512 bytes per logical sector
SPX will issue an error message during the restore if it encounters a mismatched sector size.
VirtualBoot
SPX supports various versions of Oracle VirtualBox including v.4.3.28. The Oracle website provides a download for VirtualBox.
Warning:
It is possible to configure the VirtualBox Repo on a Linux machine. (This makes it easy to download updates to VirtualBox.)
However, this option will tend to download the latest version of VirtualBox for that particular branch defined in the Repo (e.g. 4.3.x
or 4.2.x). This presents two potentially serious problems:
Some versions of VirtualBox are not supported for SPX. These are rare but they do occur when there are bugs in the
VirtualBoot API used by SPX. Using the VirtualBox Repo may install a new, untested version and VirtualBoot functions would
fail.
Page 7 of 76
Some versions of VirtualBoot may update to the system kernel. This may result in a kernel version that is not supported by
SPX. StorageCraft regularly releases updated kernel drivers as new kernels become available, so this issue should be rare.
However, it is still possible and would cause SPX functions to perform erratically or not at all.
For these reasons StorageCraft recommends downloading directly specific versions of VirtualBox that StorageCraft confirms are
supported by SPX. The SPX readme lists the current supported versions of VirtualBox. Download the specific VirtualBox package
(e.g. rpm) for that supported version using the normal download URL (e.g. download.virtualbox.org/virtualbox).
Hypervisor Support
The SPX virtual license works on a VM running any supported Linux version. In turn, these VMs can run on these hypervisors:
Microsoft Hyper-V
Microsoft Virtual PC
Microsoft Virtual Server
VMWare ESX/ESXi
VMWare Workstation
Red Hat Enterprise Virtualization (RHEV)
Citrix Xen Hypervisor
Oracle VirtualBox
Linux KVM
ProxMox
Qemu
Stratos everRun
Recovery Environment CrossPlatform
The 64-bit Recovery Environment CrossPlatform (RE-X) supports SPX-generated Linux backup files. The older, 32-bit version does
not.
XServer Desktop Environment
The SPX console requires an XServer GUI desktop environment to run. Refer to the section on Remote Management for details.
3.1 Remote Management Installs
To manage a Linux server which does not have a GUI or runs headless:
Install a GUI XServer environment on the Linux server or
Enable remote access on the server if installing a GUI on the server is not an option.
To enable remote access:
1. Install SPX on the server.
2. Run the terminal command:
/opt/StorageCraft/spx/bin/spx_cli remote --enable <Port Number>
Note: The Port Number indicates the port to use for remote management sessions. The default is Port 13581.
3. Install and run SPX on a Linux VM or physical system with a GUI desktop environment. SPX automatically displays the Session
dialog:
Page 8 of 76
4.Select New Remote Session from the Saved Sessions dropdown list.
5. Enter the requested information:
Field
Description
Session Alias
IP
Enter the remote system's address or name.
address/DNS
Note: This info appears at the top of the SPX Dashboard to
name
indicate which system the console monitors.
Port
Default is 13581. Enter another port number if this one is in use.
Username
This user must be Root or a member of the SPX management
group on the remote system.
Password
Enter the password for the user on the remote system.
Remember
password
Check the box to have SPX save the password for the user on the
remote system.
6. Click Connect. SPX connects the console to the remote system. SPX displays the License Required dialog:
Note: This license activation refers to the SPX license on the remote system, not the system the console runs on. Running the
console for remote management does not require a license.
7. Select a license option:
Option
Description
This postpones SPX activation. SPX then displays the main dialog. The
Activate user can then define one or more backup jobs for the remote system.
Later
However, those jobs will not run until the user enters either a Trial
Key or a valid license.
Get
Trial
Key
This opens a form to request a Trial key from StorageCraft. Enter the
Trial key and click Activate to use SPX and its features for 30 days.
Activate Enter the product key, contact name, and organization. Click Activate
License to begin using SPX and its features.
Now
8. Refer to the SPX Quick Start or to Creating a Backup Job to configure a job for the remote system.
4 Windows Installation
The SPX install includes both the SPX console and the SPX agent. This is unlike past versions of ShadowProtect which had the
option to install either or both.
Page 9 of 76
System Requirements
Component
CPU
SPX Requirement
300 MHz or higher Pentium-compatible CPU
Memory
The greater of 256 MB or the Operating System minimum
Hard drive
space
50 MB free disk space
CD-ROM or
DVD drive
Required only for CD installs or for using the Recovery
Environment
Monitor
VGA or higher resolution
Internet
Connection
Required for seamless upgrades from ShadowProtect 5.x.
Port
SPX requires Port 443 open for activation.
Hyper-V Plugin Requires a system running Windows Server 2012 R2 and
is acting in a server role.
Warning: SPX does not support taking backups from USB flash drives. It does support external drives connected via USB or
internal SSD drives. Use ShadowProtect 5.x if a system requires backing up a flash drive.
32- and 64-bit Installers
SPX provides 32- and 64-bit Windows installers for Standard and GPO installs. (This is different from the Linux version which ships
in a 64-bit version only.) Points to remember:
SPX requires the correct bit-level installer for the OS. If the OS is 32-bit, use the 32-bit SPX installer. If the OS is 64-bit, use
the 64-bit installer.
The default installation path for 32-bit Windows is Program Files (x86)\StorageCraft\spx. The default for the 64-bit version is
Program Files\StorageCraft\spx.
The standard installers work for manual and silent installs using scripts. The Windows GPO installers work when using a
Group Policy to install SPX.
The Windows GPO installer filenames end with "GP" to distinguish them from the Standard installers. For example:
ShadowProtect_SPX-en-US-6.0.8-19.win64_GP.msi
ShadowProtect_SPX-en-US-6.0.8-19.win32_GP.msi
Installation
To install SPX on a Windows system:
1.
2.
3.
4.
5.
6.
Download and run the appropriate bit-level SPX Windows standard installer.
Follow the onscreen prompts to complete the install.
If this is a new (and not upgrade) install, request a Trial key when asked.
Copy the Trial key from the StorageCraft trial response page (or email) into the activation dialog.
Click Done.
Log into a Local Session using credentials for a user who is a member of the Windows Local Admin group. (A user who has
Administrator privileges.)
7. Configure a destination and a backup job.
Recovery Environment
The 64-bit Recovery Environment CrossPlatform (RE-X) supports restorations of both Windows and Linux boot volumes. Use the
REBuilder app to create the 64-bit Windows Recovery Environment if the restore requires additional driver support. (StorageCraft
recommends using the 32-bit Recovery Environment only when required by the destination hardware.)
OS Upgrades
You need to deactivate the ShadowProtect SPX license and uninstall the software prior to upgrading an existing Windows system to
a newer version. For example, do an uninstall of SPX when upgrading a Windows 7 system to Windows 8 or a Windows 8 to
Windows 8 Pro or to Windows 10. After the OS upgrade, reinstall ShadowProtect and reactivate the license. While the system
preserves backup job configurations and other ShadowProtect settings and could continue an existing back chain, a best practice is
to always create a new backup job after the upgrade rather than continue the older, existing chain.
Page 10 of 76
4.1 Supported Windows Versions
Specific operating system support is dependent upon the SPX license that you purchase--Desktop, Server, Small Business, or
Virtual. SPX supports both 32-bit and 64-bit versions of many Windows operating systems. Refer to the SPX ReadMe for the latest
specific support details. The minimum Windows version supported is Windows XP SP3 and Windows Server 2003 Service Pack 2.
SPX License
Description
Desktop License
Windows XP Family, including:
XP Home Service Pack 3
XP Professional Service Pack 3
Windows Vista Family, including:
Vista Home Basic
Vista Home Premium
Vista Ultimate
Windows 7
Windows 8
Windows 8 Pro
Windows 8.1 x86
Windows 8.1 x64
Windows 8.1 Enterprise x86
Windows 8.1 Enterprise x64
Windows 10 (x86, x64)
Server License
Windows Server 2003 family with SP2, including:
Server 2003 Standard Edition
Server 2003 Standard Edition R2
Server 2003 Advanced Edition
Server 2003 Advanced Edition R2
Server 2003 Enterprise Edition
Server 2003 Enterprise Edition R2
Server 2003 Datacenter Edition
Server 2003 Datacenter Edition R2
Server 2003 Web Edition
Small Business Server 2003
Windows Server 2008 (including R2) 32-bit x86 and 64-bit x64
Windows Server 2008 R2 Foundation
Windows Server 2008
Windows Server 2012 family, including:
Windows Server 2012
Windows Server 2012 Core
Windows Server 2012 Foundation
Windows Server 2012 Essentials
Windows Server 2012 Standard
Windows Sever 2012 Datacenter Hyper-V
Windows Server 2012 R2 x64 Essentials
Windows Server 2012 R2 x64 Foundation
Windows Server 2012 R2 x64 Storage Server
Windows Server 2012 R2 x64 Data Center
Windows Hyper-V Server 2012 R2
Page 11 of 76
SPX for Small
Business License
Small Business Server 2003 R2
Windows Server 2012 Foundation
Windows Server 2012 Essentials
Windows Server 2012 R2 Foundation
Windows Server 2012 R2 Essentials
NOTE: SPX for Small Business does not activate on Windows Storage Server 2008 R2 Essentials or any
version of standard version of Windows Storage Server or DataCenter.
SPX Virtual supports Windows guests in these hypervisors:
Virtual License
Citrix XenServer
Linux KVM
VMware
Microsoft Hyper-V
Microsoft Virtual PC
Microsoft Virtual Server
Oracle VirtualBox
ProxMox
Red Hat KVM
Red Hat Enterprise Virtualization (RHEV)
Stratos everRun
VMware ESX/ESXi (including the free version of ESXi)
VMware Workstation
NOTE: SPX does not support:
Windows Server 2003 SP1
Windows Storage Spaces storage pools
Windows Server Cluster Shared Volumes
4.2 Supported File Systems
SPX supports the following file systems:
FAT16
FAT16X
FAT32
FAT32X
NTFS
Important: If you want to do continuous incremental backups your volumes need to use NTFS.
MBR Disks
GPT Disks
Basic and Dynamic Volumes and Disks
4K/AF drives with 4096-byte physical sectors and 512-byte sector emulation
Important: Backups of 4K/Advanced Format drives won’t successfully VirtualBoot on VirtualBox unless 512-byte sector
emulation (512e) is enabled on the volumes being backed up.
SPX does not support:
exFAT or ReFS file systems
Windows Server Cluster Shared Volumes
Using VirtualBoot with UEFI-based system volumes
SPX also does NOT backup any links created with the SUBST command (or calls to DefineDosDevice()) because such links reside
*outside* of any persistent file system.
Page 12 of 76
Restores
SPX performs data volume (not boot volume) restores from these image files:
SPF
SPI
Note: SPX does not support restores from VHD or VHDX files.
SPX and Microsoft Windows Deduplication
SPX includes support for Windows Deduplication (dedup) in several scenarios:
Creating a backup of a dedup-enabled volume
Using a dedup-enabled volume as a destination for backup images (note that this yields only a modest savings in space as
SPX already compresses these image files)
Mounting a backup file containing a dedup-enabled volume (the mounting system must have the Windows Dedup feature
enabled)
Using VirtualBoot a system volume backup that includes a data volume hosted on a dedup-enabled system.
Restoring a backup file created from a dedup-eabled volume (the destination needs to have the Windows Dedup feature
enabled to view all files)
Restoring a backup file hosted on a dedup-enabled volume using SPX on the same machine as the dedup-enabled volume
However, SPX does not support:
Mounting a backup file that is deduped or dependent on another backup file that is deduped.
Restoring a backup file hosted on a dedup-enabled volume using Recovery Environment if any of the backup files have been
deduped.
4.3 Supported Storage Media
SPX supports backups from these storage media:
Locally-connected hard drives or SSDs
Removable hard drives (USB or FireWire)
SPX supports storing backups on these storage media:
Locally connected hard drives or SSDs
Removable hard drives (USB or FireWire)
Virtual drives (LUN) hosted on a local RAID controller
Network drives (SAN, NAS, iSCSI)
SPX does not support:
Windows Server Cluster Shared Volumes (CSV)
Note: Installing SPX on a system using CSV may result in redirection of I/O related to clustered shared volumes. This may
preclude access to volumes.
The Restore feature of SPX also supports converting backup image files into these virtual disks:
VMware VMDK
Microsoft VHD
Supported Sector Sizes
Contemporary hard drives and SSDs ship with a 4096-byte physical sector size. Most also support the 512-byte logical sector size.
(These drives are often labeled 512e for "512-Byte Sector Size Emulation".) SPX supports backing up and restoring both 4096- and
512-byte logical sector sizes.
In the unusual situation of restoring a partition/volume from one logical sector size to another:
Page 13 of 76
SPX will issue an error message during the restore if it encounters a mis-matched sector size.
Note that a second type of 4K drives now appear on the market. These 4K Native (4Kn) drives do not support emulating the 512byte logical sector size. Microsoft Windows may also issue a warning when restoring volumes from a 512-byte sector size drive to a
4Kn drive. Various Windows applications are hard-coded for 512-byte sectors and cannot re-initialize after migrating to a 4Kn drive.
4.4 Multi-Boot Environments
On systems with multiple boot partitions, install SPX on each of the supported bootable partitions. These installs guarantee that SPX
recognizes changes to SPX-managed volumes in these environments. Only one of these installs requires activation, but the snapshot
driver (stcvsm.sys) must be available in each Windows or Linux partition.
This snapshot driver manages the fast incremental tracking in SPX. If you boot to an alternate OS environment where the snapshot
driver is not loaded, SPX cannot track volume updates from that OS boot session. This means that your next Incremental backup
misses any changes made from the alternate OS.
If one or more non-Windows operating systems, such as Linux, can write to an SPX-managed volume, confirm that SPX recognizes
those changes by creating a script:
1. Create a script that executes during the startup/logon phase of the non-Windows OS.
2. Configure it to delete all VSM000.IDX files (the name and extension are both case-sensitive) files from the root directory of
each SPX-managed volume.
Removing these files forces SPX's snapshot driver to do a full differential backup when the primary Windows volume boots. This
differential image file captures any changes made to the volume by the non-Windows OS.
Note: Since the multiple operating systems run independent of each other, it is possible to install both a Windows SPX and a
Linux SPX in their respective environments. This would maintain separate backup chains for each, rather than only a full backup for
the quiescent operating system.
4.5 Windows Silent Install
SPX performs silent installs to Windows systems using the standard SPX installer. Use this command in a script to perform the
install:
m siex ec /qn /pack age C:\spx -6.0.1-2.win64.m si IACCEPT=STO RAGECRAFT.EULA {KEY=<License Key> NAME=<Nam e> O RG=<O rganization> TYPE=<Type>
HO ST=<Hostnam e> PO RT= <Port> }
Note: You can add /lvoicewarmupx <path> to the msiexec to generate a log file.
Example: m siex ec /qn /lvoicewarm upx C:\InstallLog.tx t /pack age C:\spx -6.0.1-2.win64.m si IACCEPT=STO RAGECRAFT.EULA {KEY=<License Key> NAME=<Nam e>
O RG=<O rganization> TYPE=<Type> HO ST=<Hostnam e> PO RT= <Port> }
Parameters
The silent install command supports these parameters:
If you provide a license key you also have to provide the "Name" and "Organization" fields
Parameter
Description
Mandatory
Installer name and path
Use the actual name and path to the MSI file> For
example, C:\spx-6.0.3.win64.msi
YES
IACCEPT=STORAGECRAFT.EULA This confirms the installer read and agrees with the
StorageCraft EULA.
Key=
YES
ShadowProtect SPX license key (for example: 1234-A123- NO
1234-1ABC)
Page 14 of 76
Yes, if the command includes the
Key= parameter
NAME=
Name of the user
ORG=
Assigns the endpoint to this ShadowControl Organization. Yes, if the command includes the
Key= parameter
*TYPE=
The type of activation. Options are Default or SOCKET.
No, uses Default type if left blank
†HOST=
Name or IP of the Socket Licensing Service Server.
Options are FQDN or IP.
Yes, if Type is set to SOCKET
‡PORT=
This the port used by the Socket Licensing service.
Currently only 8282 is supported
No, Default is set to 8282 if no
port is specified.
*For socket-based licensing, you must specify the Host and you must set Type=socket. If the Type is not specified or set to
SOCKET it is assumed to be "default" licensing.
†Host and Port are remembered but ignored if Type is not "socket".
‡Port assumes 8282 if not specified.
Note: After the install completes, run a script to enable remote management on the target systems (see below).
Using the Installer under a Local System ("SYSTEM") Account
When deploying SPX using the remote "Agent" running on a system, adjust the install options if the Agent is running under the
Local System ("SYSTEM") Account:
msiexec /qn /package C:\Temp\spx-6.0.1-2.win64.msi /Lime "C:\Temp\install.txt" IACCEPT=STORAGECRAFT.EULA
Installing with an SPX license key:
msiexec /qn /package C:\Temp\spx-6.0.1-2.win64.msi /Lime "C:\Temp\install.txt"
IACCEPT=STORAGECRAFT.EULA KEY=XXXX-XXXX-XXXX-XXXX NAME=BOB ORG=BOBCORP
Note: Either command causes a forced restart of the system when it completes.
Deployment Using Windows Group Policies (GPO installs)
Important: Download the GPO version of the SPX installer from the StorageCraft website to perform a Windows Group Policy
install. Do not use the standard MSI installer.
When deploying SPX within a Microsoft Active Directory domain, Windows provides the option to use Group Policy (GPO) to
install the software. As SPX has a mandatory string "IACCEPT=STORAGECRAFT.EULA " to include with the install, create a
matching transform file (*.MST ) with this string.
Note: A Transform (*.MST) file can include command line parameters to pass into an MSI installer as part of a software
install using Group Policies (GPO).
Example Transform File (.MST)
This example includes acceptance of the StorageCraft EULA, together with license key and related details.
Page 15 of 76
Caution: Do not save the transform changes back to the original MSI file. Doing so will break the digital signature on the MSI.
Enable Remote Management
After the silent install (either scripted or GPO) SPX requires a separate script to enable remote management of the new SPX
systems.
For a 64-bit install, run this command :
C:\Program Files\StorageCraft\spx\spx_cli.exe remote --enable <Port Number>
For a 32-bit install, run this command:
C:\Program Files (x86)\StorageCraft\spx\spx_cli.exe remote --enable <Port Number>
The <Port Number> parameter is optional. Omit it to install using the default port 13581.Otherwise, specify the desired port
number.
Note: To log into the system after using this command with a new port number, use the specified port in the SPX login
screen. For example, if the new port is Port 1234, enter "1234" in the Port field:
5 Windows Upgrade to SPX
Page 16 of 76
SPX can upgrade an existing Windows ShadowProtect 5.x install to SPX. During the upgrade process, the SPX installer attempts to
migrate:
Critical ShadowProtect 5.x backup configuration settings
Backup scripts
Basic Email Notification settings
An existing valid MSP license
An existing valid ShadowProtect Retail/Perpetual license key
Ensure that existing backups continue to run post-upgrade
This upgrade should only require a single reboot.
Caution: SPX does not support the ShadowProtect 5.x feature for using the NETGEAR ReadyDATA NAS device as a destination.
Do NOT upgrade to SPX if this feature is a system requirement.
Desktop Login Authentication
SPX also introduces an added security measure in comparison with earlier versions of ShadowProtect. To run SPX, users need to be
members of the Local Admin group in Windows. Users then enter these credentials to log into SPX. This process also provides
support for remote management of other SPX systems.
Upgrade from ShadowProtect 5.x
To upgrade ShadowProtect 5.x to SPX requires a:
Valid MSP key or a valid Retail key with maintenance
Internet connection
Note: If the ShadowProtect 5.x install lacks a valid key, or has a retail key without maintenance, SPX displays a URL where the user
can obtain a Trial license.
To perform the upgrade:
1. Run the SPX installer.
The software automatically detects if the system has ShadowProtect 5.x installed. If it does, the installer stops and disables the
ShadowProtect service.
(Note that this stops any backups from occurring.) It then updates the mount and snapshot drivers.
2. Accept the reboot request from the installer.
Note: SPX requires this reboot to run backups. Once the system restarts, SPX starts its services and imports the existing
ShadowProtect backup job information.
The installer also:
Automatically activates SPX if the system has a valid license,.
Runs the migrated backup jobs at their scheduled times.
Removes the existing ShadowProtect 5.x program, shortcuts, and Start menu options.
To confirm a successful upgrade, log into SPX and verify that the backup job configurations migrated correctly..
Configuration Settings Not Migrated
The SPX installer does not migrate:
Any job for non-VSS backups. Instead, SPX converts that job into a VSS backup job.
A locally stored backup encryption password file. (SPX will continue to use the password file stored on the backup file
destination.)
Existing backup job status information for use in the timeline. The timeline updates begin with new backup information once
SPX runs the next scheduled backup.
Backup File Numbering
SPX introduces a more comprehensive tracking database for backup files to ShadowProtect. In SPX, when a user deletes an existing
backup job, then creates a new job for the same volume, the backup file numbering continues from the last file's number of the old
job. It does not restart the count from "001". This allows long-term tracking over a variety of jobs.
If the new job requires the numbering restart at "001", specify a new destination for the job with a new path.
Page 17 of 76
Upgrade from ShadowProtect 4.x
SPX does not support upgrading directly from ShadowProtect 4.x. 4.x users have two options:
Maintain their current backup chain and job configuration by upgrading first to ShadowProtect 5.x and then to SPX.
Stop the current chain, uninstall ShadowProtect and initiate a new job and chain after installing SPX.
Maintain the current chain
To keep the system's existing backup chain:
1. Confirm that there is a current maintenance agreement for the 4.x installation.
2. Upgrade the system's existing ShadowProtect 4.x installation to ShadowProtect 5.x following the steps outlined in the
ShadowProtect User Guide.
3. Follow the steps to install SPX.
4. Confirm that the backup job configurations migrated successfully.
Start a new chain
To upgrade and start a new chain, users of ShadowProtect 4.x should:
1.
2.
3.
4.
5.
Deactivate the license.
Uninstall ShadowProtect.
Complete a full SPX install.
Activate SPX.
Configure a new destination and backup jobs.
5.1 Selecting Backup Volumes
SPX differs from ShadowProtect in how to select which volumes to back up. In past versions, ShadowProtect provided Disk
Management--an elaborate tool to view and manage disk partitions. In contrast, SPX automates this entire volume selection process
in the backup job setup screen. For example, in the backup job screen, SPX only displays those volumes which require backups.
Hidden or unknown volumes no longer appear in the list of available volumes.
On a typical Windows system with UEFI and a GPT disk, the Windows Disk Management utility might show five partitions:
Partition
Number
Description
1
System Reserve or Recovery Partition
(Hidden)
2
EFI System Partition (Hidden)
3
C: drive, Primary partition
4
F: drive, Primary partition
5
E: drive, Primary partition
In the SPX backup job configuration dialog, however, only Partitions 1, 3, 4, and 5 appear:
Page 18 of 76
The hidden partition 2 is not needed for a full restore on new hardware. Hidden Partition 1 is shown, as it can contain required
Bitlocker data if the system uses that encryption service.
Note: Partition 5 (Drive F:) is greyed out in this example as it is the intended destination for SPX backup files.
6 Socket Licensing Service
The StorageCraft Socket Licensing Service allows hypervisor hosts to activate ShadowProtect SPX, installed on individual guest VMs
through StorageCraft licensed sockets. The limit of VMs supported by a host's socket license(s) is only limited by what the hardware
can support.
Note: StorageCraft focuses on the actual number of populated sockets, not
the number of cores per processor.
1. The Socket Licensing Service requires installation on either a Windows or Linux machine (physical or virtual) that
communicates with the internet (HTTP) using port 8282. Port 443 must also be open for outbound communication with the
StorageCraft activation server. See Configuration Examples for more information.
1. This machine also needs to communicate to the hypervisor host(s) or vCenter within the local network.
2. Network communication is defaulted to HTTPS but can be configured for HTTP as well.
2. Register the hypervisors through the Socket License Dashboard to facilitate network communication. See the specific setup
information for Hyper-V and vSphere before registering a host.
3. Configure the Socket License Service to connect to the hypervisors. Hyper-V requires additional configuration for both HTTP
or HTTPS. Connection in vSphere is defaulted to HTTPS.
4. Install an SPX version that supports socket licensing (v6.1.0. or newer) on each VM that is to be protected.
5. Initiate Activation of SPX on the VM where SPX is installed.
Communication
The following information will outline basic communication between the StorageCraft Activation server, the Socket License Service,
hypervisor hosts, and the guest VMs:
1.
2.
3.
4.
5.
The VM where SPX is installed, sends an activation request to the Socket license Service.
The Socket license Service, querries the hypervisor host for socket license status.
The hypervisor host confirms socket licensing with the Socket License Service.
The Socket License Sevice requests activation from the StorageCraft activation server.
The StorageCraft activation server authorizes activation to the requesting VM.
The numbered bullets above correspond with the image below.
Page 19 of 76
General Socket license Service Information
Adding Hypervisor Hosts
If new hosts are added to the network, their sockets must be licensed accordingly to activate SPX on the guest VMs.
Moving VMs
If an SPX licensed VM is moved (i.e. vMotion) fom a licensed socket to an unlicensed socket, the SPX license will expire after 30
days if the sockets are not licensed within that time frame. SPX activations for VMs on properly licensed sockets have no expiration
date.
Resetting Your Password
A password is required to log in to the Socket Licensing Service
Important: The only way to reset the password is to delete the database file (Main) from
C:\ProgramData\StorageCraft\SocketLicensing\
You will need to add all of the hosts again.
Activations will still work after the hosts have been re-added.
6.1 Socket Licensing Service Installation
Install the StorageCraft Socket Licensing Service on Windows
Download and install the Socket Licensing Service:
1.
2.
3.
4.
Go to the StorageCraft Updates page.
Select the SPX Socket Licensing for windows link and download the .msi file.
Run the .msi installation file.
The service will start automatically after the installation is complete. The default browser will be launched if the "Launch
Application" box is checked.
The web address is http://localhost:8282 (if on the same machine where the socket licensing service is installed).
If connecting to the socket licensing service from another machine, use the IP address of the machine where the socket
licensing service is running and default port number. For example: http://12.2.4.10:8282 (8282 is the default port).
The Socket Licensing Service login screen will be displayed in the browser.
Install the StorageCraft Socket Licensing Service on Ubuntu 14.04
In a terminal window, download and install the repo:
wget https://downloads.storagecraft.com/spx/Ubuntu14.04/storagecraft-repo-latest.deb -O storagecraft-repolatest.deb
Page 20 of 76
Install the Socket Licensing Service:
sudo apt-get update
sudo apt-get install socket-licensing-service
Start the service
Note: You must start the service manually the first time after installation. It will start automatically after that.
sudo start socket-licensing-service
If you need to restart:
sudo service socket-licensing-service restart
Install the StorageCraft Socket Licensing Service on CentOS 7
In a terminal window download and install the repo:
wget http://downloads.storagecraft.com/spx/CentOS7/storagecraft-repo-latest.rpm -O storagecraft-repo-latest.rpm
sudo yum install storagecraft-repo-latest.rpm
Install the Socket Licensing Service:
sudo yum install socket-licensing-service
Start the service
Note: You must start the service manually the first time after installation. It will start automatically after that.
sudo systemctl start socket-licensing-service
If you need to restart:
sudo systemctl restart socket-licensing-service
6.2 Register Hypervisors with the Socket Licensing
Service
This page gives you an overview and instructions on how to register hypervisors for the Socket Licensing Service.
After installing the Socket Licensing Service, log in and configure the hypervisors.
Login
To log in, enter the password and then click the LOGIN button. (There is no user name).
Page 21 of 76
Adding a New Hypervisor
1. Click on the Hypervisors tab at the top of the screen.
2. Click the add hypervisor button
in the bottom right corner of the hypervisors screen.
3. Complete the form to register a new hypervisor.
Register a hypervisor
To register a hypervisor
1. Enter the name for the hypervisor in the Alias field.
2. Enter the Hostname or IP Address.
3. Select the Port. Use 0 for the default port (8282).
4. Check the box next to Use HTTPS if using a secure connection.
5. Click the radio button to select which type of hypervisor to use.
6. Enter the Username.
7. Enter the Password.
8. Click Submit.
The new hypervisor should now show up in the list of hypervisors on the dashboard.
Example List of Hypervisors
This screen shows a sample list of hypervisors defined in the Socket Licensing Services dashboard.
Page 22 of 76
Hypervisor Details
Page 23 of 76
6.3 Configure Socket Licensing Service for Hyper-V
Socket Licensing Service over HTTPS
To connect the Socket Licensing Service over HTTPS to a Hyper-V server:
Obtain and install a Transport Layer Security (TLS) certificate.
Important: StorageCraft does not support issuing of TLS certifcates.
Note: WinRM HTTPS requires a local computer "Server Authentication"
certificate with a CN matching the hostname, that is not expired, revoked, or
self-signed to be installed.
Follow the steps for Configuring WINRM for HTTPS.
Note: You must run all winrm commands as an administrator. The
commands require special escape characters if you are in PowerShell.
1. Create a new TLS certificate
2. Enable HTTPS for WinRM
winrm quickconfig -transport:https
3. Open port 5986 (HTTPS port for WinRM) in the firewall
4. Enable Basic authentication for WinRM
5. Create a local user account and add the user to the Local Admins group
Page 24 of 76
Note: Domain users are not supported with Basic authentication.
6. Add the user to the WinRMRemoteWMIUsers__ group
7. Configure the Socket Licensing Service taking care to ensure the hypervisor hostname matches the certificate hostname,
exactly.
Socket Licensing Service over HTTP
Note: You must run all winrm commands as an administrator. The
commands require special escape characters if you are in PowerShell.
From the command line, run:
winrm quickconfig -transport:http
Or run:
winrm set winrm/config/service/auth @{Basic=”true”}
Ensure there is a WinRM listener:
winrm e winrm/config/listener
Note: Output must contain one listener on port 5985 and the "ListeningOn" field should contain an IP address the activation
service can connect to.
If no listener is present, add one:
winrm create winrm/config/listener?Address=*+Transport=HTTP
Configure the service for unencrypted authentication:
winrm set winrm/config/service @{AllowUnencrypted=”true”}
Add the user to the WinRMRemoteWMIUsers__ group
When configuring Hyper-V for unsecure communication with the Socket Licensing Service, you must uncheck the Use HTTPS box.
Page 25 of 76
6.4 Configure Socket Licensing Service for
vCenter/vSphere
Overview
The Socket Licensing Service VM must be connected to the internet so it can communicate with the StorageCraft activation server.
Important: The Socket Licensing Service does not connect directly to ESXi hosts. Instead, it communicates through vCenter
with the ESXi hosts. As a minimum, the user account must have Read-Only access.
For an example of a vCenter/vSphere configuration, see the Configuration Examples.
To Configure the Socket Licensing Service
For vSphere configuration make sure that the user account has, (as a minimum), Read-Only access. This is done by adding the
System "Read-Only" role in vCenter.
Page 26 of 76
In vCenter 6.0 a global permission can be added to cover access to All ESXi hosts.
In vCenter 5.5 the permission needs to be added to each ESXi host attached to the datacenter.
6.5 SPX Activation through Socket License Service
Activate Shadowprotect SPX
Activation of SPX on individual VMs is initiated through Product Activation on the VM where the installation occurred.
Fill in the following:
1.
2.
3.
4.
5.
6.
7.
8.
Product key
Name
Organization
Check the Socket Licensing Service box
Hostname or IP address of the Socket Licensing Service machine
Port number (socket licensing uses port 8282)
Click I Agree
Click Done
6.6 Configuration Examples
Page 27 of 76
Socket Licensing Service installed on a Hyper-V host
Socket Licensing Service installed on a guest VM (Hyper-V environment)
Socket Licensing Service installed on physical machine in a DMZ (Hyper-V environment)
Page 28 of 76
Socket Licensing Service installed on a vCenter VM (vSphere Environment)
7 The SPX Dashboard
The SPX dashboard includes:
Help Overlay
Menu Bar
Tool Bar
Backup Job Listing
Job Summary
Timeline
Job Details
Page 29 of 76
SPX Login Dialog
The SPX Login dialog appears every time after launching SPX. This allows the user to select to monitor either the local workstation
(Local Session) or a remote system (Remote Session).
Note: To authenticate into SPX, users need to be members of the Local Admin group in Windows or a member of the SPX group in
Linux.
7.1 Help Overlay
SPX includes a translucent overlay which indicates various features and fields on the SPX dashboard:
Page 30 of 76
The steps to working with SPX from the Help Overlay are:
Step
Displayed Text
Details
1
Create a destination
First, provide a location to store the backup
files.
2
Create a backup job
Next, configure the type and schedule of the
backup job.
3
Backup jobs are listed
here
SPX displays a list of all jobs for this system in
the top pane.
Note: This list can also display jobs for
remote systems.
4
Summary of the selected
backup job's status and
settings
SPX then populates the Summary pane with
details for the job selected in the Backup Job
pane.
5
Graphical view of the
backup job's event
history
As the selected backup job executes backups,
SPX displays these in the Timeline event
history pane.
6
Edit and control the
selected backup job
Use the controls--Pause and Play--in the
Summary pane to manage the backup job
operations.
7
Navigate through
Timeline events
Use these navigation controls in the Timeline
to move through and select the dates and time
displayed.
8
Backup images for the
selected timeline event
Select an event in the Timeline and SPX
populates the Details pane.
Press <ESC> to close the overlay.
7.2 Menu Bar
The Main Menu options are:
File
Backup
Tools
Help
File
The File menu options include:
Option
Description
Use the dropdown list to select the SPX interface language.
Preferences Check the box to use a 12-hour clock. (The default is to use a 24hour clock.)
Notification
Settings
Defines email or text message destinations for SPX event
notifications as well as SMTP server credentials. See Notifications.
Remote
Access
Settings
Enables a specified port for SPX remote client management.
Logout
Logs the SPX client out from the current agent session.
Page 31 of 76
Exit
Closes the SPX client
Remote Access Settings
This dialog performs two functions:
It allows a remote SPX client to log into and manage this system’s SPX service agent.
It specifies which port to use for this communication. The default port is 13581.
Note: Keep the default port setting of 13581 unless this conflicts with an existing application.
Click Enable Remote Access to enable remote access.
Using the Command Line
On headless or non-XServer-equipped systems, users can enable remote access to the server using the terminal command:
/opt/StorageCraft/spx/bin/spx_cli remote --enable <Port Number>
The Port Number indicates the port to use for the session. Users can then install and run the SPX console on an appropriate Linux
VM or physical system with a GUI desktop environment.to access the remote server.
Note: If the terminal command fails, first check that the command is in lower-case.
Logout
Use this option to log out of the current session with the SPX agent (local or remote). SPX then displays the Session dialog to log
into another agent. The SPX Dashboard panes appear blank until logged into a new session.
Exit
Select this option to close the SPX console.
Backup
Refer to Creating a Backup Job for details on this menu's two options: New Job and Destinations.
Tools
The Tools menu options include:
Image Chain Browser
Mounted Images
VirtualBoot
Background Tasks
Image Chain Browser
This browser displays details of a specified backup file chain from the selected destination. (A backup chain is the set of backup files
created by a backup job for a given volume. This includes the full backup base image and subsequent incremental files containing
changes made to the volume.)
Page 32 of 76
The list includes the
Name of the image file
Date and time SPX created the file
Size of the file.
To use the browser:
1. Select a backup destination from the dropdown list.
2. Select the full backup file for the desired chain.
3. Select the backup file for the point in time desired.
SPX displays details of the chain.
The Image Chain Browser dialog options include:
VirtualBoot—This feature launches a virtual machine based on the selected image file.
Note: SPX enables this option only when the backup image is a boot (system) volume.
Mount—Mounts the image file either as Read/Write or as Read-Only for recovering files or folders. When mounted as
Read/Write, the user can edit the content of the volume. For example, running an anti-virus program to clean an infected
volume. When the user dismounts the volume, SPX asks the user to save the changes to a new backup file.
Note: SPX never changes an existing backup file. This preserves the integrity of the backup.
Restore Image—Use this option to restore a data-only (not a boot) volume. Follow the onscreen prompts to configure a
destination partition and execute the restoration.
Verify Image—Analyzes the selected backup image to confirm that no changes have occurred to the image since creation.
Mounted Images
The Mounted Images dialog shows
All SPX-mounted images
The source image for the mounted volume.
Whether the mounted image is set to Read-only.
Note:. If the user mounts the image as Read-only, SPX automatically discards any changes made to the mounted image upon
dismount. If SPX mounted the volume as Read-Write, SPX asks the user to save any changes to a new incremental file.
VirtualBoot
Use this dialog to configure and launch a virtual machine based on the selected system volume.
To virtual boot a server:
1. Click Add or Remove to select the backup files to use with this virtual machine. The Add Image File function allows users
to include one or more data volumes as well as the boot volume so the VM replicates the original server configuration.
2. Give the virtual machine a name indicative of its source and/or purpose.
3. Specify the amount of RAM to dedicate to the VM.
4. Select whether to give the VM access to the network.
5. Select to launch the VM after clicking Create.
Background Tasks
The Background Tasks dialog lists SPX tasks running (or recently run) in the background.
Help
The Help menu options include:
Online Help
This option opens a new tab in the system’s default browser and displays the online ShadowProtect SPX User Guide.
Help Overlay
SPX includes a translucent overlay which indicates various features and fields on the SPX dashboard: Refer to the Help Overlay page
for details.
Page 33 of 76
Click Close Help Overlay (in the upper-right corner) or press ESC to close the overlay.
System Diagnostics
This option generates a package of diagnostic reports on the server. StorageCraft Support can then use this package to troubleshoot
issues with SPX. To create the package, enter a name and destination folder for this output. Users can then send a copy to
StorageCraft Support upon request to resolve their issue.
Product Activation
StorageCraft provides a 30-day trial key after installation of SPX. Enter this trial key to use all the features of SPX. Include a contact
name and organization to complete the activation. Purchase an activation key to continue to run backups after the 30 days. (Note
that until activated, the dialog displays its status as “Unlicensed”. Once activated, this changes to “Active.”)
Deactivation
The Product Activation dialog can also deactivate a Perpetual SPX license. This allows reuse of the license on another system, in
particular when moving the system to new hardware.
Note: Use the MSP Portal to deactivate an MSP license.
To deactivate a Perpetual SPX license:
1. Go to Help > Product Activation.
2. Click Deactivate.
3. Click OK to deactivate the license.
Registration
Opens a new tab on the default browser to the online StorageCraft Product Registration page. Enter the serial number, click
Continue, then follow the onscreen prompts to register SPX.
Display serial number
Users can display the SPX product key using the terminal command when working with headless or non-GUI-equipped servers:
/opt/StorageCraft/spx/bin/spx_cli --license
Note that the command is case-sensitive.
About
This option displays
The version for the SPX client and for the SPX service. (These may be different.)
A link to the SPX End-user License Agreement (EULA).
A link to the online SPX ReadMe file.
7.3 Tool Bar
Tool Bar
The Tool Bar icons function the same as the similarly named Menu Bar options:
Icon
Name
New Job
Description
Opens the Backup Job dialog.
Destinations Opens the Destination dialog.
Page 34 of 76
Image
Chain
Browser
Displays the backup file Image Chain Browser.
Mounted
Images
Displays a list of the currently mounted backup images.
VirtualBoot
Opens the VirtualBoot dialog.
Logout
Logs the console out of the current SPX service session-local or remote. SPX then displays the Session dialog to log
into another service.
Note: This Login/Session process allows the console to
monitor the SPX service running on local or remote servers.
7.4 Backup Job Listing
The SPX dashboard's Backup Job List shows all the configured jobs for the SPX service. The list also shows the status of the job:
Queued--Waiting for the next schedule time to run the job.
Running--The scheduled job is now creating a new backup.
Paused--The user has opted to pause the job.
Failed--SPX attempted to run the backup job and failed.
Aborted--The user cancelled the scheduled backup. SPX will run the next scheduled backup.
8 SPX Quick Start
The quick start steps outline how to create the most common SPX backup job--a Continuous schedule--on a single server. This type
of job provides a full backup of a volume as a base image, then creates periodic incremental backups on a set schedule to capture
any changes made to the volume. This process creates a backup chain used to restore the volume at a later date.
Linux Quick Start
Windows Quick Start
8.1 Activating SPX
StorageCraft provides a 30-day trial license with SPX. Restoration and functionality is no different than a fully licensed SPX install,
with the exception of system volume restores. To test restoring a system volume, request a StorageCraft Recovery Environment
Evaluation. Even after the trial license expires, backup images created with the trial version of SPX remain compatible with any
licensed SPX software.
To activate the trial version:
1. Launch the SPX console. It automatically displays the SPX License Required dialog.
2. Click Get Trial Key. A web page opens in the browser requesting contact information and a valid email address.
StorageCraft emails the trial key to that address.
3. Click Activate License Now. SPX opens a Product Activation dialog. (The SPX Help menu also has an activation option to
display this dialog.)
4. Enter the key into the dialog.
5. Click Activate to start the 30-day trial.
Note: Use the same Product Activation dialog to enter a purchased Perpetual license.
StorageCraft Socket Licensing Service
SPX activation through the Socket Licensing Service are outlined in the Socket licensing Section of this user guide.
Page 35 of 76
8.2 Linux Quick Start
To install SPX and create a continuous backup job on a Linux server:
1. Create a backup folder to act as a destination for backup image files. This destination can be an:
External hard drive
NAS system on the same network
Backup/Disaster Recovery (BDR) device/server
Note: SPX can use any volume that is not part of this backup job as a backup file destination.
2. Confirm that the current user on the system is a SUDO user in order to install SPX.
3. Follow the online instructions to install SPX from the StorageCraft public repo.
4. Launch SPX in a Linux desktop environment:
In CentOS/RHEL, select Applications > System Tools > ShadowProtect SPX.
In Ubuntu, click on the Dash home icon and type SPX.
5. Login into a Local Session using credentials as a member of the SPX group in Linux.
6. In the SPX interface, click on the Destinations icon to create a backup destination folder on a local or network storage device.
Note: If the destination is a network device, create a local mount point for the device first, then define it in Destinations.
7. Click Add.
8. Browse to and select the destination volume and folder.
9. Specify a name for the destination folder, then click Save > Done.
10. To create the backup job, click the New Job icon in the SPX interface.
11. Specify a name for the new job.
12. Select its backup file destination folder from the dropdown list.
13. Select which volumes to backup from the list.
14. Select the Schedule tab.
15. Select the Continuous schedule type and adjust the backup times as needed. (A Continuous schedule provides a full backup as
a base, then performs incremental backups at the specified times to capture changes to the volume. The default is to run a
backup every hour to capture any changes to the volume.)
Note: If the the image chain will be replicated to StorageCraft Cloud Services, it must be encrypted. Encryption cannot be
added afte the job has started.
16. Click Save.
SPX begins the new backup job.
Note: If SPX does not detect a consolidated image within seven days, a warning will be posted in the job details pane.
Note: A continuous incremental job requires the use of ImageManager to monitor and consolidate the backup files in the
destination folder. Without such management, the size of the backup chain will grow beyond the ability of most systems to properly
handle a restore procedure. For more information on using ImageManager, see the ImageManager User Guide.
Linux Volume Architecture
StorageCraft strongly recommends recording the existing disk partition layout and logical volume configuration when configuring
the initial backup job in SPX. This simplifies the restore process using the Recovery Environment.
8.3 Windows Quick Start
To install SPX and create a continuous backup job on a Windows system:
1. Create a backup folder to act as a destination for backup image files. This destination can be an:
External hard drive
NAS system on the same network
Page 36 of 76
Backup/Disaster Recovery (BDR) device/server
Note: SPX can use any volume that is not part of this backup job as a backup file destination.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
Download and run the SPX Windows installer from the StorageCraft website.
Follow the onscreen prompts to install and activate SPX.
Login into as a Local Session using Windows credentials for a member of the Local Admin group.
In the SPX interface, click on the Destinations icon to create a backup destination folder on a local or network storage device.
Note: If the destination is a network device, create a local mount point for the device first, then define it in Destinations.
Click Add.
Browse to and select the destination volume and folder.
Specify a name for the destination folder, then click Save > Done.
To create the backup job, click the New Job icon in the SPX interface.
Specify a name for the new job.
Select its backup file destination folder from the dropdown list.
Select which volumes to backup from the list.
Select the Schedule tab.
Select the Continuous schedule type and adjust the backup times as needed. (A Continuous schedule provides a full backup as
a base, then performs incremental backups at the specified times to capture changes to the volume. The default is to run a
backup every hour to capture any changes to the volume.)
Note: If the the image chain will be replicated to StorageCraft Cloud Services, it must be encrypted. Encryption cannot be
added afte the job has started.
Click Save.
SPX begins the new backup job.
Note: If SPX does not detect a consolidated image within seven days, a warning will be posted in the job details pane.
Note: A continuous incremental job requires the use of ImageManager to monitor and consolidate the backup files in the
destination folder. Without such management, the size of the backup chain will grow beyond the ability of most systems to properly
handle a restore procedure. For more information on using ImageManager, see the ImageManager User Guide.
9 How SPX Works
An SPX backup image file is a point-in-time representation of a computer volume. It is not a standard file copy of the volume, but
rather a sector-by-sector duplicate of the volume. To recover data, SPX can mount a backup image file (using its Mount utility) to
access its contents as if it were a regular volume. Users can then recover specific files and folders from this virtual volume. SPX can
also restore an entire data volume, or the StorageCraft Recovery Environment CrossPlatform (RE-X) can recover a system volume,
to the exact point in time that the backup image was taken.
SPX brings a number of additional services to the Linux platform:
Features and Components
Backup
Use Cases
VirtualBoot Scenarios
9.1 SPX Features and Components
For a complete version history of product updates, refer to the SPX ReadMe document.
Component
Features
Page 37 of 76
The console manages disaster recovery on Windows machines and Linux servers.
The console can:
Configure backup jobs that run unobtrusively in the background.
Store backups on any accessible media including network storage (SAN, NAS, iSCSI) and removable
drives (USB, FireWire).
SPX Console
Create compressed and encrypted backup image files for efficiency and security.
Recover a complete data volume, to an exact point in time, using the Restore Volume feature.
View backup images for quick file and folder recovery using the Mount feature.
Mount any system volume backup image file as a virtual machine using VirtualBoot.
Remotely manage system backup and recovery operations.
ShadowProtect The engine that creates a system's point-in-time backup images, a licensed agent is required on every machine
Backup Agent that is to be protected. The SPX console manages the backup agent.
StorageCraft
Recovery
Environment
for Windows
The Recovery Environment for Windows is a bootable environment based on the Windows PE platform. It is a
combination of the StorageCraft Recovery Environment and the Windows Assessment and Deployment Kit
(ADK). The Recovery Environment for Windows is created using the StorageCraft Recovery Environment
Builder, which also allows for individual customization by injecting unique drivers during the build process.
Refer to the Recovery Environment User Guide for details.
The Recovery Environment CrossPlatform is a bootable environment for disaster recovery that
doesn't require installing software and can
Access all critical features of the SPX Console from a standalone disaster recovery environment.
StorageCraft
Recovery
Environment
CrossPlatform
Load from a bootable CD or USB drive.
Restore a system (bootable) volume quickly and easily.
Back up a non-bootable system before attempting a restore operation.
Use Boot Repair to restore a system volume to different hardware or to virtual environments
(P2P, P2V, V2P).
For more information, see the StorageCraft Recovery Environment CrossPlatform User Guide.
9.2 Recovering Files and Folders
Once SPX creates a backup image, users can access this image to recover files or folders using the SPX Mount utility. The Mount
utility opens an image file as a volume at a mount point. Users can access the mounted backup image file just as if the volume were
on a hard disk. This includes modifying and saving changes to the temporary volume as a new incremental backup file.
Note: The Mount utility can efficiently mount hundreds of backup images simultaneously if needed.
For instructions, see Restoring Files and Folders.
:
9.3 Restoring a Volume
Page 38 of 76
SPX provides two ways to restore a volume backup depending on the type of volume:
Volume
Type
Restore using
which tool?
Description
Data
Volume
SPX
Use Restore Volume in SPX to recover a data
(non-boot) volume to a local partition.
System
(boot)
Volume
Recovery
Environment
CrossPlatform (REX)
or Recovery
Environment-Windows (REWIND)
Use the 64-bit Recovery Environment
CrossPlatform or Recovery Environment-Windows to restore a system volume. These
tools include Boot Repair (Linux) and HIR
(Windows) for restoring to new hardware.
For more detailed information, see Restoring a Volume.
9.4 SPX Backups
An SPX backup image file is a sector-by-sector representation of the volume at the time SPX takes the volume snapshot. SPX writes
the backup image file to the destination storage media. Options for the destination include network storage (SAN, iSCSI, NAS, etc.)
or removable storage (USB / FireWire). The amount of time it takes to write the backup image file depends upon the system
hardware and the size of the image file. However, for most snapshots, the entire process takes only seconds and does not interfere
with system operation. For information about configuring and creating backup image files, see Creating a Backup Job.
Note: The StorageCraft glossary explains the backup file naming conventions used in SPX. Review these to become familiar with
the different types of image files.
SPX Backup Schedule
Users use SPX to
Configure automated backup jobs to protect designated volumes.
Schedule full image or incremental images (as often as every 15 minutes) on flexible daily and/or weekly schedules.
Backup File Image Chains
The Continuous Incremental backup type creates a chain consisting of a full base image and subsequent incremental files. (These
subsequent files capture changes made to the volume over time.) To correctly perform a restore, SPX or REX must have access to
each file in the chain up to the point in time desired for the restore.
Note: It is not possible to determine from the name of a particular file if other backup image files are dependent on this file.
Because of this, it is very important to use the Image Chain Browser to review dependencies prior to moving or deleting any backup
image.
Warning:
All backup image files are part of a chain. Deleting a backup image file on which other files depend makes the dependent backup
image files useless. Users cannot mount or restore files from these dependent backup image files.
The same is true of the full (base) image file. This file starts and anchors the chain. Deleting a full image file from an active chain
makes the entire chain useless.
Page 39 of 76
9.5 SPX Use Cases
Here are several common use cases for SPX:
Live Backup
Problem: I don't want to shutdown a system every time I need to create a system backup image.
SPX Solution: By leveraging disk imaging with snapshot technology, SPX lets you create live system backups without any system
downtime. SPX creates live backup images that include a system's operating system, critical data, and configuration settings.
Create Full and Incremental Backup Images
Problem: It's time consuming to create a full backup image every time. I need to be able to make incremental backup images to
save time and space.
SPX Solution: SPX uses a sector-based backup strategy that lets it backup just the changes to a file in an incremental backup
image. Sector-based backup is the quickest and most efficient way to take an incremental backup.
With an initial full backup, you can create regular incremental backup images from that point forward to support an accurate
restoration.
Individual Folder and File Restore
Problem: Restoring individual files and folders using traditional backup tools and destinations, such as a tape drive, can be very
difficult and time-consuming. Often it's a challenge to even find the necessary data or requires outside help. I need a quick and easy
method to recover lost files or folders on a self-service basis.
SPX Solution: Disk-based backup images provide fast backup file access. Use the SPX Mount feature to mount a local backup
image file as a volume. Once mounted, you can explore and recover individual files and folders from the backup image. For server
volumes, the IT administrator can also mount a backup image of a server volume and then share this with users to provide selfservice restores of server-based files and folders.
Update an Existing Backup Image
Problem: I have an existing backup image with essential files. However, the volume was infected by a virus and now I don't want
to attempt to recover these files from the infected drive.
SPX Solution: SPX can mount a backup image file as a read/write volume. Use an antivirus program against the volume. SPX can
then save these changes as a new, separate Incremental image file for restoring the volume.
9.6 VirtualBoot Scenarios
The following scenarios introduce several possible use cases for SPX VirtualBoot:
Backup Image Testing
Problem: I need to confirm that my backup images can restore properly. I also want to provide access to all my mission critical
applications and data.
VirtualBoot Solution: Use VirtualBoot to launch a VM of recent boot volume backup file. If the VM launches correctly, you can
verify that the restored applications and data perform as expected.
Page 40 of 76
Software Testing
Problem: You need to find out how some new software performs on your production system, but you don't want to risk having
any problems.
VirtualBoot Solution: VirtualBoot the latest backup of your production system, then install the software in the virtual machine.
You can evaluate the software performance using your system's actual production environment without any risk to your production
system.
Historical Data Access
Problem: After transitioning to a new financial management system, I am going to be audited. To satisfy the audit, I need access
to historical tax records stored in the proprietary format of the old financial software. Unfortunately, I no longer have the old
software and cannot access my historical tax records.
VirtualBoot Solution: Rather than trying to restore a complete backup image that contains the old financial software, use
VirtualBoot to boot the backup image, which gives you access to both the application and the data from your system at the time of
the backup. By preserving the applications with the data, you can greatly extend the lifespan of your data.
Diagnostic Testing
Problem: I want to run some diagnostic tools on the live system (tools like anti-virus or data or file recovery software) but do not
want to risk running these on the live system.
VirtualBoot Solution: Use VirtualBoot to launch a VM of the latest backup of your live system. Then run the diagnostic tests to
view the results.
Hardware Failure
Problem: I have a database server and the 20TB disk array crashes. I need to get the system back on-line and replace the disk
subsystem.
VirtualBoot Solution: This solution is a three-step process:
1. VirtualBoot the latest backup image of your database server. Users can now continue to have access to the database server.
Note: SPX can also continue to take incremental backups of the virtual database server to capture updates. Launch the backup
job from the SPX console. These new Incremental backups will become part of the original backup image chain.
2. Start a HeadStart Restore (HSR) on the database server's new disk subsystem (For more information, see the ShadowProtect
ImageManager User Guide).
3. Once the HSR catches up to the most current Incremental created in the VM, take the VM offline and finalize the HSR installation
on the new disk subsystem (a quick operation), then bring the database server hardware back on-line.
Note: Once the replacement VM is online and continuing the Incremental backup image chain, you can recover from a hardware
failure in several different ways:
Restore to the original hardware, once repaired.
Restore to new hardware (using StorageCraft Recovery Environment CrossPlatform's Boot Repair (for Linux) or Hardware
Independent Restore (for Windows).
Restore permanently to a VM environment by using HSR to restore to a VHD or VMDK virtual machine hard disk file and
launching the new system.
10 Creating a Backup Job
To create a new backup job, first define your Destinations. This tells SPX where to store your backup files. Then either select the
New Job icon on the Tool Bar or select the Backup > New Job option in the Menu Bar to define a new backup job. SPX displays
the Backup Job dialog with three tabs:
Settings
Schedule
Advanced
Page 41 of 76
10.1 Destinations
Use the Destinations dialog to
Specify storage locations for backups.
Review, edit, or delete locations from the list of existing destinations.
Select one destination from the list to act as the default when creating new backup jobs.
Note: SPX requires at least one destination prior to creating a backup job.
To add a new destination:
1. If not logged into SPX, log in using Windows credentials.
These credentials must be for a member of the Local Admin group. Also, SPX does not accept credentials which lack a
password. Use Windows to define a password for the user then log into SPX.
2. Click Add to open the New Destination dialog.
3. Enter a descriptive name for the destination.
4. Use Browse to locate and specify the mount point for the storage device to use for this destination.
Note: Refer to the section below on Backing up to a Network Location to enable access to a network device.
5. Click Save.
The Destinations dialog provides additional options:
Option
Edit
Action
Click Edit to modify the name of the selected destination.
Set
Click Set Default to assign this destination as the default for backup jobs
Default created using SPX.
Click Delete to remove the selected destination from SPX. SPX displays a
warning if any backup job uses this destination.
Delete
Note: SPX displays the delete warning for any recurring or scheduled
backup job. It does not display a warning if a one-time use backup job used
the destination (such as one-time full backup).
Caution: SPX does not support changing the destination for an existing backup job. (It also does not support moving an active
backup chain from one destination to another.) In the event that a replacement destination becomes necessary, create a new job
with the new destination. This will initiate a new chain on that location.
Backing up to a Network Location in Linux
Unlike Windows (which supports network destinations directly), Linux requires a local mount point to reach a network destination.
To backup to a network location using Linux:
1. Create a mount point in a local directory. For example, use the Mountcommand to mount a remote filesystem to a local path
(using cifs):
mount -t cifs //server/share /mnt/remotepath
2. Use /home/user/remote or similar path as your destination directory.
3. To make the mount point permanent, add an entry to the filesystem table (/etc/fstab) so the network location mounts every
time the system boots up.
4. Point to that directory in the Destinations dialog in SPX.
Page 42 of 76
10.2 Settings Tab
SPX displays the Settings tab by default after selecting New Job. To create a new backup job:
1.
2.
3.
4.
On the Settings tab, specify a name for the job.
Select a destination for the backup files (from the defined set in the dropdown or click New Destination to add one).
(Optional): Add a text comment to describe the job.
Use the dropdown list or manually specify which volume(s) to backup.
Note: The list of volumes displays the relevant mount points for a full restore (i.e.: no swap or generic mount points).
The dropdown box options for volumes to include are: All Volumes (all the listed volumes), Only System Volumes, or Only
Data Volumes.
On many systems, selecting All Volumes is appropriate.
Comment Field
The Comment field adds a text note to a backup image file. Users can review these comments in the Summary pane. SPX also
includes the contents of this Comment field in its log. Ensure that the text is clear and self-explanatory to avoid errors when
reviewing the log files.
Note: SPX limits the Comment field to approximately 100 characters.
Compression Field
SPX includes three file compression options for creating a backup image file:
None
No data compression. This option uses the fewest CPU resources but
uses the most disk space.
Typically compresses data by about 40%. Standard compression
Standard provides an optimal balance between CPU usage and disk space
usage.
High
Typically compresses data by about 50%. This option requires the
most CPU resources, but is useful when disk space is limited.
Note: Contemporary standalone or VM host hardware provide adequate support for the high compression setting. Use this
setting unless extended monitoring reveals performance degradation during backup operations.
Encryption Field
Important: StorageCraft strongly recommends encrypting all backup files, in particular those replicated to a remote site or to
StorageCraft Cloud Services.
To activate encryption on this job's backup files:
1. Select the type of encryption to use from the dropdown box:
RC4 128-bit
AES 128-bit
AEX 256-bit (the default)
None
2. Enter an appropriate password for encrypting the backup files.
Note: StorageCraft Cloud replication requires AES 256-bit encryption.
SPX also supports changing the encryption password at a later time. To do so:
1. Select the backup job from the list in SPX.
2. Select the Settings tab in the Edit Job dialog.
Page 43 of 76
3. Enter a new encryption password in the Encryption pane.
4. Click Save.
SPX now encrypts the backup files using the new password.
Warning: Guard encryption passwords carefully. SPX cannot change passwords on existing encrypted files. In addition,
StorageCraft Support cannot recover lost encryption passwords or otherwise access an encrypted backup image file. If the user
changes the encryption password at a later date, record the time and date of the change in order to use the correct password to
unencrypt those files.
Volumes
SPX offers a dropdown list to select predefined types of volumes to backup: All, Data volumes, or System volumes. The user can
also manually select the desired volume(s) to backup.
Note: Most systems only require backups of volumes which receive a drive letter. ShadowProtect does not need to backup the
other volumes, which are often very small, in order to successfully restore the system. The one exception is a system which uses
Windows BitLocker encryption. (The encryption key is kept in the System Reserve partition.) Even in that case, if ShadowProtect
runs on a live system, it does not require backing up the System Reserve partition in order to restore the volumes.
10.3 Schedule Tab
Use the Schedule Type dropdown menu on the Schedule tab to select which type of backup to perform:
Continuous
Mixed
Full
Full, Manual
Note: SPX supports only one continuous backup job per volume.
Continuous
The Continuous incremental backup schedule type first creates a full backup of the volume as a base image file. Subsequently, SPX
creates incremental backup images on the specified schedule to capture changes to the volume.
To create a continuous incremental backup schedule:
1. Select Schedule Type > Continuous.
2. Select the start time for the initial full backup: Immediately or Later. If Later, select a specified date and time to perform the
backup.
3. Select the schedule for each subsequent incremental backup:
Add Weekly—Creates incremental backups at the selected time and day(s) selected. Click Add Weekly a second or third time
(not to exceed three) to add more backups at days and times that differ from the initial weekly incremental schedule.
Add Monthly—Creates incremental backups at the specified days and times on a monthly schedule. Click Add Monthly a
second or third time (not to exceed three) to add more backups at days or times that differ from the initial monthly
incremental schedule.
Important: Each backup job can support up to a total of 3 scheduling rules using either or both Add Weekly and Add Monthly
schedules.
4. Selecting All day uses a 24-hour day. Selecting All day is the same as specifying “00:00 to 23:59” in the From field.
5. Use the Repeat every setting to specify how often to run an incremental backup—once every 15, 30, or 45 minutes or once
every 1 to 12 hours.
Scheduling Example
Unlike a typical fixed schedule function in most backup software, the flexible SPX backup scheduling feature could support one job
performing a backup:
Every 30 minutes during business hours Monday-Friday.
Every hour at night from 6PM to 12AM to capture online transactions.
Every 15 minutes from 6PM to 10PM on first Monday or Friday of each month to capture sales totals and reports from the
field.
Page 44 of 76
Mixed
The Mixed backup type starts a new backup chain on the specified day of the week or month. This job type includes a combination
of a full backup then daily incremental backups run on the set schedule until the next scheduled full backup.
Important: Like in a Continuous job, the Mixed backup job supports up to three rules using a combination of Add Weekly and
Add Monthly schedules.
Full
This schedule executes a full backup at the scheduled time(s) each week or month.
Full, Manual
This option executes a one-time full backup of the selected volume. This backup occurs outside of any existing scheduled backup.
The one-time backup can start immediately or at a later specified date and time.
Note: If SPX is currently running a scheduled backup job when it receives the request for a manual full backup, it will
automatically delay the manual request until the current job completes.
10.4 Advanced Tab
The Advanced tab options provide for more granular control over the SPX backup job. These options may not apply for all job
types. For example, the Retention policy applies only to Mixed (Weekly or Monthly) backup jobs.
The Advanced tab organizes settings into three sections:
Performance
Scripts
Images
Performance
The SPX Performance options include:
Option
Default
Description
Throttling OFF
Limits system resources used during the backup process.
For example, I/O bandwidth used by SPX to create a
backup image file. (The default is 50% of resources.)
Move the slider bar towards Unlimited to increase the
amount of resources available to SPX. Move the slider
towards Limited to reduce the resources available.
Reducing (throttling) the amount of resources means that
SPX performance slows.
Save
Volume
Free
Space in
Backup
Images
Creates a backup of all sectors on the volume including
those sectors marked as free space. This can result in a
much larger image file, but may help preserve previously
deleted files.
Note: This option can be changed at a later date without
creating a new job.
OFF
Page 45 of 76
Ignore
read
failures
during
backup
Instructs SPX to ignore disk read errors that occur during
the creation of backup image files. Use this option with
caution, as it may back up disk corruption and prevent a
restored volume from working properly. However, in the
event of a failed or failing disk, it may help preserve any
remaining intact data.
OFF
Scripts
The Scripts section specifies command files to execute at key points in the backup image file creation process. Scripts cannot rely on
any user interaction, so test each command file before using them with SPX. SPX allows from 1 to 30 minutes at each stage for
command files to complete. (The default is 5 minutes.) If the command files do not complete in the specified time, SPX proceeds
with the backup while the command files continue executing. Scripts can run:
Start Job
Pre-snapshot
Post-snapshot
Finish Job
Linux backups in particular may require pre- and post-snapshot scripts in order to quiesce database applications on the server.
Note: SPX provides the option to abort the backup job if any specified script fails.
Using Scripts
To use a command file for a particular stage in the backup process:
1. Login as a user with ROOT privileges (otherwise SPX won’t copy command files into the scripts folder).
2. Copy the command file(s) into the Scripts directory
/var/opt/StorageCraft/spx/libexec
3. Select the Advanced tab.
4. SPX can abort a script which fails to run within 1-to-30 minutes. Use the Abort scripts which do not finish option to select the
amount of time SPX should wait (the default is 5 minutes) before skipping a script.
5. Specify which scripts to run:
Start Job: Executes the specified file to prepare the system for the backup job.
Pre-Snapshot: Executes the specified script file before taking the backup. For example, you might execute a pre-snapshot
script which places transaction applications or databases into a backup state.
Post-Snapshot: Executes the specified command file after taking the image snapshot. For example, to execute a postsnapshot command file to return transaction applications or databases back to their normal operating mode.
Finish Job: Executes the specified command file after SPX creates the backup image file.
Note: SPX has a 5-minute execution limit for post-backup command files. If post-backup commands require longer than
five minutes, have the script call a command file that executes another command file and then finishes. This lets SPX complete
the associated command file in the 5-minute allotment while the secondary command file performs tasks that take longer to
complete. For example, synchronizing or copying the backup image files to an alternate location, scanning the backup image
file for viruses, etc.
6. Select to have SPX halt the backup if it cannot execute a specified script.
Note: Should the script fail and cause the backup to halt, SPX displays this failed backup in the timeline.
Images
Provides various options for backup job actions:
Option
Default
Save volume
images concurrently OFF
Description
Enables or disables creating backup images
simultaneously for multiple volumes rather
than creating one backup image at a time.
The system hardware needs to support a high
disk load to use this option.
Page 46 of 76
OFF
Enables or disables executing the last
scheduled backup job if it was missed. (For
example, because the system was powered
off.) If SPX missed more than one scheduled
job, this option executes only the last
unexecuted backup job.
Use write cache
when saving images OFF
Bypasses the file transfer API in SPX and
instead uses Windows processes when there
are issues with prolonged backup times.
Immediately run
missed backups on
restart
Split image files
into smaller files
OFF
SPX can split a large backup image file into
multiple smaller files. These smaller files
create a Spanned Image Set. For example,
use a spanned image set to save a large
backup image file into smaller files for later
transfer onto fixed-length media such as
optical discs. Specify the maximum file size
for each of the smaller files in the set. The
default is 256MB.
Retention
SPX retention options can reduce the amount of space required for backup storage. While keeping all backup image files may
provide the most options for restoring data, this policy has two drawbacks:
Rapidly consumes available backup storage space
Increases the complexity in determining which point-in-time file(s) to select for restoring
In practice, determine what points-in-time provide the desired protection against data loss.
Note: SPX retention policy only applies to a Mixed (weekly or monthly) backup schedule. It does not apply to a Continuous
schedule. To manage continuous incremental backup files and the space required for these files, use ImageManager.
The Retention policy options are:
Option
Default
Setting
Description
Keep all
images
ON
Retains all backup image files. Note that this uses the
most storage space.
Keep only
recent
images
OFF,
3 sets
Specifies the maximum number of recent image sets to
keep. When SPX reaches this set maximum, it deletes
the oldest image set after running the next backup. The
default is to retain 3 sets of backups.
Keep all full
backups
OFF
(delete only
incrementals)
Instructs SPX to delete only the incremental backup
images when removing an old image set.
Page 47 of 76
Instructs SPX to make room for a new image set by
deleting the oldest image set before creating the new
image set. This reduces the total amount of disk space
needed to meet the specified retention policy. However,
if the backup job is interrupted or fails, then there will
be fewer remaining sets for restoring the volume.
Perform
deletions
before a full
backup
OFF
Note: SPX offers this option only when there are at
least two backups stored on the system. This prevents
deleting the only backup if the system has retained only
one backup.
If the destination volume requires SPX to use less space
than the required two full backups, use a Continuous
Incremental backup job and ImageManager to reduce
the space required.
After SPX performs the retention policy and deletes one or more backup files, it still retains the name of the file and the date and
time the backup occurred. It displays these deleted files in the Timeline in grey for Missing Files:
VSS Writers (Windows only)
SPX uses VSS on Windows to quiesce applications before taking a snapshot. Some VSS writers do not interact well with SPX and
may causes issues such as a lengthy delay before VSS takes the snapshot.
Caution: Do not disable a VSS writer except under the direction of StorageCraft support or with a specific understanding of that
writer.
To disable a writer on an existing backup job:
1. Uncheck the Enable all option.
2. Scroll through the writer list to select and disable the writer.
3. Click Save.
11 Monitoring Backup Jobs
ShadowProtect SPX introduces the Backup Job Timeline—a dynamic chart of a selected backup job showing the status of each
backup event.
To use the timeline:
1. Click the Logout icon
to display the Sessions dialog.
Page 48 of 76
2. Select:
Local Session to monitor backup jobs on the local system.
An existing remote connection in the dropdown list to monitor a remote system running SPX.
Click New Remote Session to create a connection to a remote server running SPX.
3. Click Connect. SPX displays the backup job(s) defined for the selected system.
Note: SPX also displays the IP address for the monitored SPX service at the top of the Dashboard. This allows the user to
identify which system's jobs SPX currently displays details on.
4. Select a job in the Backup Job list.
The dashboard then shows details for that backup job in the Job Summary, Job Timeline, and Event Details panes:
Color—The event's color indicates:
Blue
Successful Full backup
Green
Successful Incremental backup
Brown Successful Differential created
Warning--Indicates that SPX performed the backup but with
Yellow possible error messages. For example, if a script failed and the
option to halt the backup on script failure was not selected.
Red
Failure--Indicates that SPX did not perform the backup. Review
the log for this backup to diagnose the issue.
Missing backup--A previously existing backup file no longer
Grey appears in the destination folder. This can result from a Retention
policy deleting older backups, a manual deletion, or files that
ImageManager consolidated.
Height—Indicates the size of the backup file. An unusually tall bar (compared to past backup files) may indicate an issue with
that backup.
Width—Indicates the length of time required to execute the backup. Again, a variation from the norm may indicate a need
for further investigation.
Page 49 of 76
Timeline Controls
The timeline chart includes two sets of controls to select the range of date and time shown:
Control
Purpose
Selects the range of date(s) to show in the chart. The
scale at the bottom of the chart then varies to
accommodate the length of time.
Zooms into or out of the timeline to increase or
decrease the length of time shown in the chart—from
minutes to hours.
Timeline Filters
Use the color-coded event type squares to filter the timeline display. Click on an event type to remove it from the timeline. For
example, to view only backup failures, click on other five event types to remove them from the timeline.
Display Event Details
Click on an individual event in the timeline to display statistics of the backup in the Details pane below the timeline. These details
include:
Date and time of the backup
Length of time to run the backup
Source volume
Backup file size
This pane also provides the Actions menu to:
Icon
Action
Open Image Chain Browser to select a system volume backup and use the
VirtualBoot feature to boot a virtual machine using that backup.
Mount the backup file
Restore or convert the backup file (for data volumes only). The Restore
dialog offers options to both restore to a local drive and to convert the
backup file into a VHD or VMDK format.
Verify the file to confirm its integrity.
Note: The selected date range may not be narrow enough to show individual backups. In that case, the event line displays flags
—one for each backup taken with its date and time. The color of the flag follows the chart shown earlier.
Job Summary Pane
The backup Job Summary pane displays details of the selected job:
Field
Description
Name
Gives the user-defined name for the backup job.
Status
Indicates Queued, Running, Paused, Failed, or Aborted.
Note: Failed indicates an issue with the system. Aborted
indicates the user clicked Cancel in the Job Summary pane while
the job ran.
Page 50 of 76
Type
Shows if the job is Continuous, Mixed, or Full.
Schedule
Indicates the most frequent interval for the job: Daily, Weekly, or
Monthly.
Last Run
Displays the date and time of the last attempt to backup the
volume.
Last
Success
Shows when the last successful backup occurred.
Note: This should match the Last Run time and date.
Next
Backup
Indicates when the next backup should occur.
Destination Shows where SPX stores this job's backup files.
Disk Usage Displays the total amount of storage space used by this job's
backup files.
Comment
Shows the text entered into the job's Comment field by the user.
Job Summary Controls
The Job Summary pane provides controls for a job:
Icon Control
Description
Pause/Play Pauses a backup job. The icon then toggles to a Play icon.
Click this Play icon to continue with the job.
Run
Displays a menu with two options:
• Start an incremental backup--Immediately runs an
incremental.
• Rebase to a new Full backup--Starts a new chain with a
new full backup.
Warning: Rebase means creating a new Full
backup. Starting a new chain will impact existing
ImageManager replication or consolidation on the destination
folder.
Cancel
Toggles with the Run icon. Cancel stops a running job. SPX
then displays the Job Summary status as Aborted and the
Timeline shows the job as Failed.
Edit
Displays the backup job configuration dialog. The user can
then modify the job's schedule and other details.
Important: SPX does not support editing all backup job
settings.
Delete
Removes the backup job from SPX.
Warning: This cannot be reversed. Once deleted, the job
must be recreated. This also starts a new backup chain for
the volume.
Microsoft System Logs
SPX also provides unique codes in the Windows system logs to indicate the status of the service and backups:
Event ID
Event ID 1
Type
Information
Appears when
the service starts
Page 51 of 76
Event ID 2
Information
the service stops
Event ID 3
Information
a backup completes
successfully
Event ID 3
Information
a backup completes
successfully with warnings
Event ID 4
Warning
a user cancels a backup
Event ID 5
Error
a backup fails
Event ID 6
Information
SPX creates a snapshot
Event ID 7
Information
SPX deletes a snapshot
11.1 Notifications
Selct Notification Settings from the File menu.
Notifications Settings
This dialog specifies settings for email and text alerts on backup status.
Page 52 of 76
To activate email notifications:
1. Check Notify using email (SMTP).
2. Click SMTP Settings to specify
1. the SMTP server hostname or IP address
2. the Port to use for SMTP traffic
3. the credentials for the SMTP server
4. Connection security
3. Enter the requested information:
Field
Description
Send email to
Enter one or more destination email addresses.
Prefix email subject
with
Enter any text to add as a prefix to the email’s subject line.
For example, this text could specify the server or backup
job.
Prefix email body
Enter any text to add to the start of the email body.
with
4. Select when to send the notification:
1. After each backup job finishes
2. Only if the backup job fails
3. Daily reports
4. Weekly reports
5. Monthly reports
5. Click Send Test Message to confirm the notification settings.
6. Continue to configure text notifications or click Save to only have email notificaitons.
Backup Finished and Backup Failure email notifications include:
Backup job name
Start time
Finish Time
Destination name
Source volume
Daily, Weekly, and Monthly email notifications include:
Number of backups executed
Number of successful backups
Number of failed backups
Number of canceled backups
Average backup size
To configure using text messaging (SMS):
1. Specify the SMS gateway to use for text notifications.
2. Select when to send a text:
1. After each backup job finishes
2. Only if the backup job fails
3. Click Send Test Message to confirm the configuration.
4. Click Save.
Note: SPX issues notifications shortly before Midnight for the local system.
Page 53 of 76
Backup Finished and Backup Failure text message notifications include:
Machine name
Backup job name
Reason for notification
Time of occurrence
12 Restoring a Volume
SPX has two ways to restore a volume depending on the type:
Volume
Type
Restore Method
System
Volume
Use the 64-bit Recovery Environment CrossPlatform (REX) or
Recovery Environment--Windows (RE-WIND) to restore a
boot/system volume.
Data
Volume
1. Use the Restore feature in the SPX Image Chain Browser or
2. Click the Restore Volume icon in the Details pane of the Timeline.
Using the Image Chain Browser
To restore a data volume using the Image Chain Browser:
1. Optional: Create a new partition on a local drive for the data volume restore.
Warning: SPX also supports restoring to an existing partition. However, this erases all existing data on that partition.
2. Click the Image Chain Browser icon
in the Tool Bar.
SPX opens the browser:
3. Select the storage location of the backup files using the Destinationdropdown.
SPX populates the Base Image list for that destination.
4. Select the backup chain for the data volume to restore from in the Base Image list.
SPX populates the Image Chain pane.
5. Select the last backup image file in the list.
SPX populates the Image Summary pane.
6. If encrypted, enter the password for the file.
7. Click the Restore icon
in the Image Summary pane's Tasks menu.
SPX displays the Restore Volume dialog:
Page 54 of 76
8. Select Local Volume in the Destination Type dropdown list. SPX populates the list of available partitions.
Note: The Restore Volume dialog also supports converting the chain into either a VHD or VMDK virtual disk. See
Converting Backup Files for details.
9. Select a partition to restore the volume.
10. Click OK to perform the restore.
SPX restores the data volume to the selected partition.
Using the Timeline
To restore a data volume using the Timeline:
1. Optional: Create a new partition on a local drive for the data volume restore.
Warning: SPX also supports restoring to an existing partition. However, this erases all existing data on that partition.
2. Use the Dashboard to select the backup job.
3. Next, select the desired backup file at the Date and Time in the Timeline. (SPX also displays further details of the selected file
in the Details pane.)
4. Click on the Restore Volume icon
in the Tasks menu.
5. Select Local Volume in the Destination Type dropdown list.
SPX populates the list of available partitions.
Note: The Restore Volume dialog also supports converting the chain into either a VHD or VMDK virtual disk. See
Converting Backup Files for details.
6. Select a partition to restore the volume.
7. Click OK to perform the restore.
SPX restores the data volume to the selected partition.
13 Restoring Files and Folders
The SPX Mount feature provides both administrators and users with a simple way to recover files and folders in Linux.
Warning: The Windows Operating system does not natively support mounting Linux volumes. Windows usually shows error
messages about not supporting the file system and may ask you to format the Linux partition due to the fact that it is an
unsupported partition type. A Linux partition must be mounted on an operating system that supports Linux partition types. You can
remotely manage SPX in the Linux environment to mount the image to that machine.
To perform a restore of one or more files or folders:
Page 55 of 76
1. Click the Image Chain Browser icon on the SPX Tool Bar.
2. Select the storage location of the backup files using the Destination dropdown.
SPX populates the Base Image list for that destination..
3. Select the base backup file for the volume in the Base Image list.
SPX populates the Image Chain pane with the backup files for that volume.
4. Select the backup file in the chain for the date and time desired.
5. Click the Mount icon from the Actions menu.
Note: Provide the encryption password if required.
6. Accept the default mount directory or specify a different one if required.
7. Accept the default to mount the volume as Read-Only. SPX mounts the volume.
Note: SPX can also mount the volume as Read-Write if required. (Some programs require writing to the volume in order to
open a file or folder.) Users may also want to modify the volume's existing content. SPX can save these changes to a new, branch
incremental file. (SPX never modifies the original image file.)
Warning: Image mount operations should only be used to restore data. Never mount an image as writable and continue adding
data as if you are in a production environment. Never mount a writable image chain and share it across the network. Temporary
changes are written to a .spwb file while the image is mounted and those changes are written to the .spi file when you dismount. If
many changes are added by multiple users across the network, AND if any kind of problem occurs when you dismount. . . ALL
changes will be lost. StorageCraft cannot recover any changes from a failed dismount that were made while a writable image was
mounted.
1. Locate the desired file(s) or folder(s) and copy the item(s) to the original drive.
2. When finished, click the Mounted Images icon in the Tool Bar.
3. Click Dismount.
Ignore Buffer File Option
SPX maintains any changes made to a Read-Write volume in a buffer file even after saving those changes to a new, branch
incremental file. This allows SPX to reapply those changes to a new mount of the original image file. (This may be useful when
those changes were to allow application access to multiple files or folders. This eliminates having to redo that access process.)
Warning: Do not mount this branch incremental as Read-Write and save changes to a new, second branch incremental. While It
might appear simpler to do this to access changes, this second branch incremental causes ImageManager consolidation to fail for
this chain. Instead, keep the Ignore any existing buffer file for this image option unchecked. Use this option only when the user did
not save the original changes to an incremental.
14 Converting Backup Files
SPX can convert a volume's backup image chain into a VHD or VMDK virtual disk file.
Note: The Image Conversion tool in ShadowProtect 5.x does support conversions into VHDX format.
To do so, run the Restore Volume feature using one of these features:
Job Timeline
1. Use the Job Timeline on the SPX dashboard to select the desired point-in-time backup image file from the specified
Backup job
Date and time
2. Click the Details Info icon
to open the Image Chain Browser.
SPX populates the browser with details of the selected image chain.
3. Select the last backup image file in the Image Chain list. (Unless creating a virtual disk from an earlier point-in-time. In which
case, select the desired backup file from the earlier time.)
4. Click the Restore Volume icon
in in the Tasks menu.
SPX displays the Restore Volume dialog.
5. Select VHD or VMDK from the Destination Type dropdown list.
6. Click OK. SPX proceeds to create the new virtual disk from the backup chain and copies it into the destination directory.
Page 56 of 76
Image Chain Browser
1. Click on the Image Chain Browser icon
in the Tools bar to open the browser.
2. Select the backup file destination using the dropdown list.
SPX displays the destination's path and populates the Base Image List in the pane.
3. Select the chain's base image in the list.
SPX populates the Image Chain pane with the list of related image files.
4. Select the last image file in the list (unless creating the virtual disk from an earlier point-in-time. In which case, select the
desired backup file from the earlier time.)
5. Click the Restore Volume icon
in the Tasks menu in the Image Summary pane.
6. Select VHD or VMDK format from the Destination Type dropdown list.
7. Click OK.
SPX proceeds to create the new virtual disk from the backup chain and copies it into the destination directory.
15 Changing Backup Destinations
SPX supports changing the destination for an existing backup job. This avoids having to create a new backup job and starting a new
chain in order to change a job from storing files locally to a network destination, or from one network destination to another.
To change an existing backup job's destination:
Important: The user must manually transfer the job's existing backup file chain to the new destination. SPX checks the new
destination prior to running the next scheduled backup. If it cannot find the chain in the destination, the job fails.
1. Use the Job Summary controls (or right-click on the job in the Backup Job list) to pause the existing job. This prevents SPX
from running the job during the change to the new destination.
2. Use the SPX Destination instructions to create the new destination if it does not already exist on the system.
3. Transfer the job's existing chain to the new destination.
4. Wait 10 minutes after the file transfer completes to allow SPX to perform a Destination scan. This scan confirms that there are
files at the new destination.
5. Double-click on the job in the Backup Job list to open the Edit Job dialog.
6. Use the dropdown list in the Destination field to select the nex destination.
7. Click Save.
8. Unpause the job.
SPX now proceeds with the job's regular schedule. When the next backup occurs, SPX checks the destination and performs one of
the following actions:
New Destination has
SPX does this
Current backup chain
Performs the next scheduled backup as normal.
Current backup chain but
missed one or more
backups during the
changeover
Performs a differential backup then continues with the
regular scheduled backups after that.
No chain or an unrelated
chain
Issues an error message and fails the backup job. SPX
continues to retry the job at each scheduled interval and
will continue to fail until it discovers the correct chain at the
destination.
Page 57 of 76
16 VirtualBoot
SPX VirtualBoot lets you easily create server and workstation virtual machines from ShadowProtect backup files.
VirtualBoot works on three hypervisors:
VMware vSphere (ESXi clusters)
Oracle VirtualBox
Microsoft Hyper-V on Windows Server 2012 R2
You can VirtualBoot a system-volume backup image created with ShadowProtect SPX in a Virtual Machine (VM) environment on
these hypervisors. VirtualBoot does not require a restore operation to a VM or converting backup files to a different format.
VirtualBoot provides a quick, temporary replacement system for a failed server in these situations:
System Fail-over
A failed system with terabytes of storage can take days to restore using traditional methods. VirtualBoot for the same system
(backed up with ShadowProtect) takes only minutes and gives users full access to system resources and applications. Cut-over to
the new system with VirtualBoot can significantly reduce downtime.
Backup and Restore Test
Administrators in the past seldom performed restore tests due to the limitations of traditional methods such as tape. Now you can
quickly do a backup and restore test in a VM by VirtualBooting any system image that was backed up with ShadowProtect. The
restore test gives added confidence that a real restore using the same image files will be successful. Administrator's can configure
VirtualBoot operations at regular intervals in conjunction with ImageManager's Advanced Verification.
Access Application-specific Data
Backing up and restoring data is a critical operation, but the data files often aren't useful without their associated
applications. VirtualBoot mounts an entire system, both applications and data in a VM. This allows you to access your data from its
associated application.
For information about VirtualBoot usage scenarios, see VirtualBoot Scenarios.
Important: To prevent mixing backup files from the source system with those of the VirtualBooted VM, ShadowProtect
SPX pauses existing local and ShadowControl policy-based backup jobs when run on a VM launched through VirtualBoot.
Do not unpause these backup jobs if the source system (system down) is still on the same network as the VirtualBooted
VM. Mixing incremental backups from two sources in the same chain adversely affects future restore operations.
16.1 vSphere (ESXi Clusters)
ESXi Clusters and VirtualBoot
Overview
Requirements
Using vSphere with VirtualBoot
VirtualBoot Process
Installing
VirtualBoot Temporary Virtual Machines
VirtualBoot Migrating to a Permanent Virtual Machine
Overview
StorageCraft Shadow Protect ® SPX includes the patented VirtualBoot ™ for vSphere built on VAIO Filtering. VirtualBoot for vSphere allow s you to instantly virtualize an
SPX backup image as a virtual machine on VMw are ESXi hosts (see Requirements). You can VirtualBoot both physical and virtual machines as a temporary failover to safely
test changes in production systems or you can create permanent migrations. The machines recovered or migrated w ith VirtualBoot are the same as native VMw are virtual
machines.
VirtualBoot for vSphere creates the VMDK directly from the source SPX backup image. All it needs is ShadowProtect SPX (6.3 or
Page 58 of 76
newer) and your VMware infrastructure.
VirtualBoot for vSphere features include:
Quickly boots SPX backup images on an ESXi host.
VirtualBoot plugin for vSphere is automatically installed with SPX.
Wizard-driven configuration.
Replicates SPX backup images directly to the virtual disk.
Migrates from physical or virtual machines (from any hypervisor) into vSphere.
Optionally backfills data into the VMDK from the SPX backup image (including while the virtual machine is in use).
Migrated virtual machines are independent of the SPX backup images.
Requirements
VirtualBoot for vSphere General Requirements
A VMware vSphere cluster.
VMware vCenter appliance (version 6.0 U2 or newer).
ESXi.
SPX 6.3 or newer is required.
The vCenter appliance must be able to communcate with the ESXi hosts it needs to manage but cannot be running on them.
A licensed version of ESXi (version 6.0 Update 2 or newer) must be installed on at least one other machine in the cluster.
Note: The free version of ESXi is not supported for VirtualBoot. The configuration must include a vSphere cluster. Refer
to Creating a vSphere Cluster if you need to set up a cluster.
Storage Requirements
Warning: ESXi will fail if the volume runs out of space. StorageCraft recommends using a different volume/destination for
storing the caching files. The destination must have sufficient performance and space for the guest virtual machine to store the
VMDK created to contain all the data that will be written to the volume. Make sure you have enough storage space for the planned
virtual machines.
Page 59 of 76
Minimum vSphere permissions required to use the VirtualBoot plugin for vSphere
"Datastore.AllocateSpace"
"Datastore.Browse"
"Datastore.DeleteFile"
"Datastore.FileManagement"
"Datastore.UpdateVirtualMachineFiles"
"Datastore.UpdateVirtualMachineMetadata"
"Global.CancelTask"
"Host.Config.Maintenance"
"Host.Config.Patch"
"Resource.AssignVMToPool"
"StorageProfile.Update"
"StorageProfile.View"
"System.Anonymous"
"System.Read"
"System.View"
"VirtualMachine.Config.AddExistingDisk"
"VirtualMachine.Config.AdvancedConfig"
"VirtualMachine.Config.CPUCount"
"VirtualMachine.Config.EditDevice"
"VirtualMachine.Interact.CreateScreenshot"
"VirtualMachine.Interact.PowerOn"
"VirtualMachine.Inventory.Create"
"VirtualMachine.Inventory.CreateFromExisting"
"VirtualMachine.Inventory.Delete"
"VirtualMachine.Inventory.Register"
"VirtualMachine.Inventory.Unregister"
"VirtualMachine.Provisioning.Customize"
"VirtualMachine.State.CreateSnapshot"
"VirtualMachine.State.RemoveSnapshot
VirtualBoot a ShadowProtect Backup Image in vSphere
To VirtualBoot a ShadowProtect SPX backup image in vSphere:
1.
2.
3.
4.
5.
6.
Start SPX.
Click (the VirtualBoot icon) or select Tools > VirtualBoot. The wizard guides you through the VirtualBoot process.
Click Add Image File to select your backup image.
After selecting your backup image click Next.
On the Select a hypervisor screen, click VMware vSphere (radio button) then click Next.
Log into vSphere.
- Enter the IP address or DNS name.
- Enter the username.
- Enter the password.
- Uncheck the box for Verify the SSL/TLS Certificate.
- Click Log in to vSphere
- Click Next.
Page 60 of 76
7. Select the Backup File Network Location.
Important: This is telling the ESXi host where to find your backup images.
- Enter the full path to your backup files folder.
- Enter the Domain name if applicable.
- Enter the Username required to login to the machine where your backup images reside.
- Enter and confirm the password.
- Click Next.
8. Select a Cluster or Host.
Note: The warning icon in the image above indicates that the plugin hasn't been installed on this cluster.
9. Install the VirtualBoot Plugin
Page 61 of 76
Note: This window won't display if the plugin is already installed on the cluster (see step 7).
Install the VirtualBoot plugin from StorageCraft
StorageCraft automatically provides the most up to date plugin if you select this option.
Install the VirtualBoot plugin from this URL
If you want to set up your own location for installing the VirtualBoot plugin see the Install the VirtualBoot plugin from this
URL section below.
10. Select a Datastore.
Note: Only datastores available to the selected host are displayed in this menu.
11. Configure the Virtual Machine.
- Enter a machine name for the virtual machine being created.
- Select the number of CPUs for the machine.
- Select the amount of memory you want.
- If you want a permanent virtual machine check the Migrate the data drive to vSphere box.
- If you don't want to automatically start the virtual machine after creating it, uncheck the box.
Note: If both boxes are checked, the VM will not automatically start until the snapshot (backfill) is complete.
Page 62 of 76
12. The new virtual machine will start automatically if you check the "Automatically start the virtual machine" box.
Install the VirtualBoot plugin from this URL
If you choose the option to "Install the VirtualBoot plugin from this URL" you need to install the plugin on your own system. The
process is simple. The file just needs to be available as a "served" file on your web server.
Setting up your own download site:
1.
2.
3.
4.
This requires a local webserver running in your environment.
Download the plug-in from the StorageCraft Software Updates page.
Create a location on your webserver where the plugin can be stored and served as a URL.
Make the URL (full path) available to those who need it.
For example: If your server name is mywebserver, and if you stored the plugin in a subfolder named plugins under a folder named
www (i.e. www/plugins), and if your filename is plugin.zip then the URL and path required by SPX VirtualBoot for vSphere needs to
be: http://mywebserver/plugins/plugin.zip.
Verifying Success
There are multiple ways in which you can be sure the installation is working correctly. One way includes looking at the status in
vSphere:
Temporary VirtualBoot and Migrating
With VirtualBoot for vSphere, a temporary vSphere VirtualBoot creates a VMDK and connects remotely to your backup image for the
data. In this configuration the temporary VMDK is dependent on the original backup image and requires a connection to the remote
used to boot it.
If you select the Migrate the data drive to vSphere option SPX creates a VMDK and writes all the data from the backup image into
the VMDK and HIR does its work before the VM is booted. In this configuration the migrated VMDK is now independent and doesn't
require the backup image used to VirtualBoot.
Note: If you use VirtualBoot to create a temporary VM and decide you want to create a permanent VM simply create a vSphere
snapshot of the VM. Creating the snapshot writes the data from the backup image into the VMDK. This makes it the equivalent of a
migrated backup image.
Important: If you selected the option to migrate a VM, and want to continue your backup chain, you need to understand that
SPX creates a VirtualBoot backup image migration file (different than the standard backup image file). The new migration file causes
ImageManager to fail retention. To continue backing up after migration you need to choose one of the following options:
1. Re-base
Page 63 of 76
2. Delete the migration backup image file and run StorageCraft DiffGen.
Updating or Uninstalling the vSphere Plugin
If you need to update or uninstall the plugin use the vCenter appliance IoFilter Manager in the Managed Object Browser.
16.2 Troubleshooting VirtualBoot for vSphere
Summary
This page provides the following details and technical information about troubleshooting the VirtualBoot for vSphere plugin.
Background
Installation
Components
I/O Basics
Best Practices
Troubleshooting
Advanced Troubleshooting Knowledge Base Article
Background
The VirtualBoot for vSphere plugin provides VirtualBoot capability in the VMware virtualization environment. Using the vSphere
APIs for I/O Filtering it transparently provides an ESXi host with data from backup chains hosted on an external SMB store. As far
as the host is concerned, it is working with a standard .VMDK file. The volume data is persisted permanently in the .VMDK which
means it is possible to eventually migrate completely into the virtualization infrastructure and stop using the backup data.
Installation
The filter is installed just-in-time by SPX as part of the VirtualBoot process. The installation is driven by the vSphere APIs, which
handle distributing the bundle to an entire cluster.
Note: The installation bundle must always be available at the URL provided during the installation on the cluster. After it is
installed on a cluster, vSphere automatically installs the filter on any new host added to the cluster.
Components
There are two key binaries that work together to provide the disk filtering.
1. The daemon plugin: libvmiof-disk-daemon-stastcesxi.so
The daemon is the workhorse of the filtering solution. It is handles all communication with the SMB shares providing the
backup files; it also handles the file I/O and parsing of the image chains to provide access to the volume data at a given pointin-time.
2. The filter plugin: libvmiof-disk-stastcesxi.so
The filter plugin is the piece exercised directly by a virtual machine for which we're filtering one or more disks; it handles
communicating with the daemon from the virtual machine's process and drives the setup and connection to a backup chain's
data. The filter is responsbile for deciding whether a given I/O requires data from the backups as well as persisting that data
to the .VMDK in the case that is.
I/O Basics
Backfill – The process of reading data sectors from the volume represented by the image chain and writing it to the .VMDK
before the VM reads those sectors.
Bitmap – A tracking structure which keeps an up-to-date accounting of which data is in the .VMDK and which data is still in
the image files.
Page 64 of 76
I/O on a filtered disk is handled in a number of ways:
1. Writes – On write, the data is passed through to the .VMDK. The filter waits for confirmation of the write and clears the
tracking bitmap for those sectors.
2. Reads – Reads are a more complicated issue. The handling of a read depends on two key factors:
3. Whether the requested sectors correspond to data that is in the image files.
4. Whether the .VMDK is in a read-only state.
The data flow for a read is handled as shown in the following diagram:
Best Practices
Backfill Triggering
A full disk backfill is a resource-heavy process. If triggered on a running VM, it will compete for CPU and I/O resources. Depending
on system resources, this can have a substantial impact on performance. This is especially noticeable if you trigger the backfill while
the machine is booting for the first time.
In the case where a machine is being migrated or failed-over permanently, but there's no time to wait for an offline backfill, it's
recommended to allow the machine to boot fully and run it's normal duties for a time before triggering the backfill. Doing this
assures that all critical operating system and application data is resident in the VMDK beforehand, and will yield the best
performance.
Backfill Cleanup
In a migration scenario, StorageCraft recommends that the policy be removed once the backfill is complete. This is to save space
that will otherwise be taken up by tracking files maintained by ESXi. Since they are proportional to the size of the disk, this is a nontrivial space savings. The following steps are necessary:
1. Delete all snapshots on the VM – the policy cannot be changed if snapshots exist for the VM. Since every snapshot results in a
copy of the tracking files, StorageCraft recommends that you do this immediately after the first snapshot.
2. Remove the policy from the disk – set the disk's policy to Datastore Default in the VM's "Edit Settings" dialog.
Page 65 of 76
3. Delete the policy – The policy is found in the "VM Storage Policies" section of vSphere, either under "Policies and Profiles"
from the navigator pane, or in the "Monitoring" group of the Home page.
Troubleshooting
Logs Files
When diagnosing filter issues, the logs are typically the fastest way to see what's happening. There are a couple key places where
filter-related logs are written:
1. /var/log/iofilterd-stastcesxi.log – This is the filter daemon's log. The daemon does all the real work, so this is typically the
most important place to look. This log has a record when a filter opens and closes, outbound connection results, etc. If
VirtualBoot is failing because it can't apply a profile to a disk, this log file will tell you why.
2. vmware.log – This is the log file for a running virtual machine. If the filter is attached to a disk currently used by a running
VM, this is where the logs are found. The filter logs all contain the tag (STC ###) where ### is an incrementing count in the
log. Use this to find/exclude the non-filter logs. This is where you'll see logs for snapshots of running VMs, vMotion, etc.
Page 66 of 76
3. /var/log/hostd.log – This is the ESXi host process's log file. If disk operations are performed on a filtered disk while the VM is
powered off, the logs are found here. For example: taking a snapshot of a machine that is powered-off writes the log
information to this file. As mentioned before, you can use the STC prefix to filter out unwanted log messages.
Re-applying the Policy
Warning: Reapplying the policy WILL cause data loss for disks that have had I/O! Reapplying the policy resets the filter's
tracking and treats the disk as if the data has not been backfilled yet. Use this option carefully.
Attaching the policy to the disk is the last step of the VirtualBoot process. At that time, the disk, VM, and policy all exist in vSphere.
Because HIR was able to run successfully (meaning the destination/disks are accessible from the SPX host), a failure at this point
means that the daemon in the ESXi host wasn't able to connect to the destination.
Note: This can happen if DNS isn't working properly, or if the ESX host's network isn't able to route to the SMB share.
If this happens, follow these steps to fix VirtualBoot without re-running the whole process. This is possible because all the real work
has already been done.
1. Resolve the connectivity issue – verify that your hostname resolution works from the ESXi host to the SMB host (using
hostnames) and that traffic can flow between the two machines, i.e. on SMB port 445.
2. Apply the profile to the disk again.
This is done in the sub-settings for the disk under the VM's settings. Switch the VM storage policy to "Datastore Default" and
click OK. Once it's finished, change it back to the original policy.
Advanced Troubleshooting
See the VMware ESXi VirtualBoot Advanced Troubleshooting KB article for additional information.
Page 67 of 76
16.3 Oracle VirtualBox
VirtualBox is an open source VM environment and is available for both Linux and Windows.
ShadowProtect SPX supports various versions of Oracle VirtualBox. However, these versions are not supported on Windows due to
issues with loading plugins:
4.0.0, 4.3.14, 4.2.26, 4.2.28, 4.2.30, 4.2.32
It is recommended users directly download specific versions of VirtualBox supported by StorageCraft. The table below lists the
current supported versions of VirtualBox that are compatible with SPX. Download the specific VirtualBox package (e.g. rpm) for that
supported version using the normal download URL (e.g. download.virtualbox.org/virtualbox).
Warning: Staggered releases of ImageManager and ShadowProtect SPX may not always support the same versions of
VirtualBox. For systems using VirtualBox for both ShadowProtect SPX and ImageManager, ensure the installed VirtualBox
version is compatible with both products. See the ImageManager user guide for comapatible versions.
VIRTUALBOOT PLUGIN FILES
Version numbers here correspond to
the various versions of VirtualBox's
disk
*plugin interface*
SUPPORTED VIRTUALBOX VERSIONS
ForVBox4.0.0
4.0.2, 4.0.4, 4.0.6, 4.0.8, 4.0.10, 4.0.12,
4.0.14, 4.0.16, 4.0.18, 4.0.20, 4.0.22, 4.0.24
4.0.24, 4.0.26 (Linux only), 4.0.28 (Linux only),
4.0.30 (Linux only), 4.0.32 (Linux only)
(VirtualBox 4.0.0 not supported)
ForVBox4.1.0
4.1.0
ForVBox4.1.2
4.1.2, 4.1.4, 4.1.6, 4.1.8, 4.1.10, 4.1.12,
4.1.14, 4.1.16, 4.1.18, 4.1.20, 4.1.22, 4.1.24,
4.1.26, 4.1.28, 4.1.30, 4.1.32, 4.1.34 (Linux
only), 4.1.36 (Linux only), 4.1.38 (Linux only),
4.1.40 (Linux only)
ForVBox4.2.0
4.2.0, 4.2.2, 4.2.4, 4.2.6, 4.2.8, 4.2.10, 4.2.12,
4.2.14, 4.2.16, 4.2.18, 4.2.20, 4.2.22, 4.2.24,
4.2.26 (Linux only), 4.2.28 (Linux only), 4.2.30
(Linux only), 4.2.32 (Linux only)
ForVBox4.3.0
4.3.0, 4.3.2, 4.3.4, 4.3.6, 4.3.8, 4.3.10, 4.3.12
ForVBox4.3.14
4.3.14 (Linux only), 4.3.16, 4,3,18, 4.3.20,
4.3.22, 4.3.24, 4.3.26, 4.3.28, 4.3.30, 4.3.36,
4.3.38
ForVBox5.0.0
5.0.0, 5.0.2, 5.0.4, 5.0.6, 5.0.8, 5.0.10, 5.0.12,
5.0.14, 5.0.16, 5.0.18, 5.0.20, 5.0.22, 5.0.24,
and 5.0.26
Visit www.virtualbox.org For more information about VirtualBox and to download the software.
Note: Do not install VirtualBox on a Windows system already configured with Hyper-V. This can result in a failure of the
VirtualBoot functions.
Page 68 of 76
General Storage and Memory Requirements
Storage and memory requirements for VirtualBoot vary significantly depending on the number and size of mounted volumes. As
mentioned, VirtualBoot is intended to be used for testing backup chain integrity, content recovery or as a temporary replacement
for a downed system. (Should a user require a longer term solution, consider a permanent migration to a VM.) When using
VirtualBoot in its role as a testing or content recovery, it requires minimal space for mounting volumes. A rule of thumb for
determining a practical size for how much free space will be needed is to add up the currently used space of each anticipated VM's
volume(s) and divide this in half. For example, if the user mounts 5 active VMs with a total of 200GB of existing data across
multiple volumes, then allocate 100GB of free space on the hypervisor's data volume.
At the other extreme, if a mounted VM has writes to most or all of its sectors, the host's data drive would require free space equal
to the size of the original volume.
Caution: Both VirtualBox and Hyper-V use default paths to the OS volume for their VM file caching. StorageCraft recommends
defining a different path to an accessible drive other than the OS volume. This avoids creating a bottleneck with data transfers on
the OS volume.
VirtualBox Requirements
These guidelines apply equally to VirtualBox on Windows or on Linux. For more details, refer to the VirtualBox End-User
Documentation . Note that SPX supports various versions of VirtualBox. Please refer to the SPX ReadMe file for details on the latest
supported versions.
VirtualBox Hardware Requirements
These guidelines for Windows and Linux come from the VirtualBox End-User Documentation .
Hardware
Description
Processor Oracle recommends using a recent (within the last five years) "reasonably powerful" x86 processor (either Intel or
AMD), including AMD/Intel x64 processors. VirtualBoot does not support Itanium (IA64).
Memory
At least 1GB
Hard
Drive
Space
At least 10 GB. This is dependent upon the guest operating system loaded in the VM.
Host OS
VirtualBoot supports the same host operating systems as VirtualBox.
VirtualBoot on either a Linux or Windows host supports booting image files created from a Windows system volume
for these OSes:
Guest OS
Windows 10
• Windows 2008 (32- and 64-bit)
Windows Server 2012 and R2
• Windows Vista (32- and 64-bit)
Windows 8 (32- and 64-bit)
• Windows 2003 (32- and 64-bit)
Windows 7 (32- and 64-bit)
• Windows XP (32- and 64-bit)
Windows 2008 R2 (32- and 64-bit) • Windows 2000
VirtualBoot on a Linux host also supports booting image files of Linux boot volumes.
Warning: VirtualBoot does NOT support booting a Linux-based image file on a Windows host.
Note: When using VirtualBoot to boot an image of an x64 operating system, make sure that your host hardware supports
AMD-V or VT-x, and that AMD-V, or VT-x, is enabled in the host machine's hardware BIOS settings.
Linux Requirements
VirtualBox has two known issues when running on Linux--one with the VirtualBox repo, the other with SELinux.
Warning:
Page 69 of 76
It is possible to configure the VirtualBox Repo on a Linux machine. (A repo provides an easier way to download updates to
VirtualBox.) However, this option tends to download the most recent version of VirtualBox for that particular branch defined in the
Repo (e.g. 4.2.x or 4.3.x). This presents two potentially serious problems:
Some versions of VirtualBox are not supported in SPX. These are rare but they do occur when there are changes in the API
used by SPX. Configuring a VirtualBox Repo may result in an install of a new, untested version and VirtualBoot functions
would fail.
Some versions of VirtualBox may also update the system kernel. This may result in a kernel version that is not supported by
SPX. StorageCraft regularly releases updated kernel drivers as new kernels become available, so this issue should be rare.
However, it is still possible and would cause SPX functions to perform erratically or not at all.
For these reasons, StorageCraft recommends:
1. To not create a VirtualBox repo.
2. Confirming the new VirtualBox version appears on the SPX readme supported list.
3. Downloading this version directly from Oracle.
SELinux Conflict
A system with SELinux may prevent VirtualBox from mounting certain backup image files. To check the SELinux status, run the
command as ROOT:
sestatus
If enabled, check to see if SELinux is set to Permissive mode. If so, then VirtualBoot should perform as described. If SELinux is set
to Enforcing mode, change this setting using the command
setenforce 0
To reset Enforcing mode after completing the desired VirtualBoot operations, use the command:
setenforce 1
16.4 Microsoft Hyper-V
Hyper-V and VirtualBoot
To install and use the StorageCraft VirtualBoot Hyper-V Plugin, VirtualBoot requires:
Windows Server 2012 R2
Hyper-V must be installed and configured on the server.
The system cannot be a domain controller.
Refer to the Microsoft Server 2012 documentation to configure and launch Hyper-V (if needed) prior to installing the plugin.
Storage Requirements
The default location for Hyper-V VHD/VHDX files is in a sub-folder on the OS volume under the Hyper-V directory.
Page 70 of 76
Warning: Carefully consider the storage requirements for the anticipated virtual machines when selecting this destination.
Should this volume run out of room, Hyper-V will fail. StorageCraft recommends using a different destination for storing the
caching files. This destination should have sufficient performance and space for the guest to store the VHDX which it creates to
contain all the writes the guest will make to the volume.
Note: Do not install VirtualBox on a Windows system already configured with Hyper-V. This can result in a failure of the
VirtualBoot functions.
To install the plug-in:
1. Confirm that you have the right version of Hyper-V.
Note: The StorageCraft Hyper-V plugin currently supports only Windows Server 2012 R2 acting in a server role.
2. Download the plug-in from the Software Updates page on the StorageCraft website.
3. Run the installer using Administrator rights.
The installer completes the plugin integration.
Using Hyper-V with VirtualBoot
To use Hyper-V for a VirtualBoot operation:
1. Click
(the VirtualBoot icon) on the menu bar OR select Tools > VirtualBoot.
2. Select the Backup Image you want to VirtualBoot.
3. Select Hyper-V as the hypervisor.
4. Click Next.
5. Configure the Virtual Machine.
Continue with the remaining VirtualBoot options then click Create. VirtualBoot uses Hyper-V to complete the operation.
Uninstalling the Hyper-V Plugin
Do not attempt to uninstall the Hyper-V plugin while any VirtualBoot VMs are running. The uninstall process corrupts those VMs.
The uninstaller does check prior to the uninstall to attempt to prevent this from occurring. However, StorageCraft recommends a
check by the user to confirm that any VirtualBoot VMs have closed prior to performing the uninstall.
Occasionally, the uninstall process may fail. Use this command line instruction to then force the uninstall:
Page 71 of 76
msiexec /x <InstallFIleName> NOPLUGINCHECK=true
16.5 Launch a VM with VirtualBoot
To create a virtual machine from a system image file:
1. Select the backup image file containing the boot/root volume(s) for the desired system.
2. Start VirtualBoot using one of these methods::
Icon or
Option
Location
Image File Selection
SPX Menu bar
Click Add Image File to
browse and select the desired
boot volume backup image file
from the list.
Timeline Details Pane
Automatic (SPX creates the VM
up to the point in time of the
selected image file in the
Timeline.)
Main Menu > Tools > Image
Chain Browser > Image
Automatic file selection
Summary
Main Menu Click Add Image File to
> Tools > browse and select the desired
VirtualBoot boot volume backup image file
from the list.
Note: SPX automatically adds the selected boot volume and associated data volumes that are part of that backup job to
the VirtualBoot dialog when using the Details pane or Image Summary.
3. In the VirtualBoot dialog, confirm that SPX displays the correct hypervisor in the hypervisor list at the top. SPX defaults to
using the currently installed driver--the Hyper-V plugin or VirtualBox.
4. In the dialog, provide the required information then click Create.
The requested information includes:
Adds a backup image file to the VM. Use this if you have a
separate data volume you want to include in the VM.
Note: VirtualBoot attempts to automatically include all
volumes that are part of the boot volume's image set in this
list. Use this option to add in other volumes if this does not
Add Image File occur.
If the selected backup image file is encrypted, provide a valid
password to access it.
Caution: Use care when selecting image files from multiple
backup jobs. If the VM executes incremental backups, those
created for volumes that are not in the boot volume's image
set likely won't be useful or reliable.
Remove Image Removes a backup image file from the list. This can occur
when the backup contains multiple data volumes but are not
File
needed for the VM.
Boot
SPX automatically attempts to identify the boot volume in the
list of volumes. If necessary, manually select the correct boot
volume. (This can occur when the backup file contains
multiple bootable volumes.)
Machine Name
Specify a name for the VM.
Page 72 of 76
Memory (RAM) Specify the amount of memory, in MB, that VirtualBox should
allocate for use by the VM when it loads. The default is
Allocation
512MB.
Network
Adapter
Select whether to include a network adapter in the VM.
Supported options include:
NAT: Adds a generic network adapter to the VM that uses
Network Address Translation (NAT).
Not Attached: Excludes a network adapter from the VM.
(See Not Attached below.)
Note: Confirm the network configuration provides access
after the VirtualBoot. If the VirtualBoot VM is a failover, ensure
access to the backup destination(s) for any existing backup
jobs.
Automatically
start the
virtual
machine after
creating it
This is the default. Uncheck this box to run the VM at a later
time using the VirtualBox application.
Note: If you selected a backup image file when starting VirtualBoot, this dialog automatically lists the related backup
image file information.
5. VirtualBoot creates the VM and launches it for use.
Not Attached Network Option
Choosing not to have a network adapter in the VM allows VirtualBoot to boot a backup image while the source system is still
operational. Do not keep both systems operating with the same network configuration as this causes:
Routing problems particularly at the domain controllers.
Both the VM and the source system might save Incremental backup images to the same network location. While this does not
affect data integrity, it can lead to confusing backup image file names with Incremental backup image files from both branches
of the chain intermixed and erratic results with consolidation.
Keeping the VM off the network avoids these types of issues before they cause any problems. (Another option if a network
attachment is essential is to pause any existing SPX backup jobs once the VM loads.)
17 Can't Find a Feature
SPX tasks fall into several groups:
Backup Jobs
Restoring Volumes
Monitoring SPX
Configuring SPX
This page provides links to tasks in each of these groups where the main headings may not reflect these tasks or to tasks which
may be used infrequently.
Note: The following tasks are not sequential.
Tasks Related to Backup Jobs
To reduce the amount of space that backup files are taking, refer to the Retention section of Creating a Backup Job.
To later save backup files to optical disc, refer to how to split image files in the Images section of Creating a Backup Job.
To convert an existing backup chain into a VHD or VMDK, use the conversion function in the Restore Volume feature.
Tasks Related to Restoring Volumes or Files/Folders
To restore a data volume, refer to the Restore Volume option.
To restore a system volume, refer to the Recovery Environment CrossPlatform User Guide.
Page 73 of 76
To use the Mount feature, refer to Restoring Files or Folders.
To dismount a mounted backup image file, refer to Mounted Images in the Tools menu.
To create a VHD or VMDK virtual disk from a backup chain, use the Converting Backup Files.
To view detailed information on disks and partitions in Windows, use the Disk Management utility in the Microsoft Management
Console.
Tasks Related to Monitoring Backups
To send out notifications when issues arise with SPX, refer to the Notification section of the Menu Bar.
To verify the integrity of a volume's backup chain, refer to the Image Chain Browser section of the Menu Bar.
Tasks Related to Monitoring SPX
To perform a headless install or an install on a non-Xserver GUI-equipped server, refer to the Remote Management install steps.
To configure management of a headless server or manage remote SPX clients on the network, refer to the Remote access settings
section of the Menu Bar.
To change which remote SPX client SPX displays, refer to Session Login in Monitoring Backup Jobs.
To search or sort the Windows System Logs for SPX events, refer to the list in the last section of the Monitoring Backup Jobs page.
Tasks Related to SPX Configuration
To perform a remote install on a Windows system, refer to the Windows Silent Install page.
To perform a remote install on a Linux system, refer to Linux installation.
To deactivate the SPX license, refer to the Deactivation section of the Menu Bar
To change the SPX clock to 24-hour format, refer to Preferences under the File Menu section of the Menu Bar.
18 SPX and ShadowProtect Feature Comparison
SPX shares most features with ShadowProtect. SPX, however, has improved functions as shown below.
Page 74 of 76
Feature
ShadowProtect
SPX
Socket
Licensing
No
Yes
Backup
volumes
concurrently
Yes
Yes
Include Free
Space
Yes
Yes
Self-healing
incremental
(using
DiffGen)
Yes
Yes. SPX automatically detects that an unexpected
shutdown of a system occurred. It then generates
an incremental that captures the changes to the
disk since the last backup file. This process is called
"DiffGen" and the resulting backup file is called a
"self-healing incremental".
Throttling
Yes
Yes
Run missed
backups on
restart
Yes
Yes
Ignore read
failures
during
backup
Yes
Yes
Custom
Backup File
names
Yes
Yes. Both ShadowProtect and ShadowProtect SPX
support custom backup file names.
Uses a preexisting
Password
file (SPK)
Yes
No
Can add
Backup
comments
Yes
Yes. However, If the user manually triggers a
backup off an existing backup job, SPX offers the
option to provide a new comment. Important:
This comment is written into the backup file. It
replaces any existing comment provided when the
Backup Job was created. When ImageManager
consolidates backup files, the comment written to
the newly created consolidated backup file will
match the comment in the latest backup file
merged into the Consolidated file.
Local and
Network
Destinations
Yes
Yes
NetGear
ReadyDATA
Backups
Yes
No. ShadowProtect SPX does NOT support the
unique ShadowProtect NetGear backup type
Compress
backups
Yes (None,
Standard. High)
Yes (None, Standard. High)
Encrypt
(password
protect)
Backups
Yes (RC4 128
bit, AES 128 bit,
AES 256 bit)
Yes (RC4 128 bit, AES 128 bit, AES 256 bit)
Creating
Key Files
Yes
No. The instructions for Creating Key Files is now in
the ImageManager user guide. The KeyFileMaker is
now installed when you install ImageManager.
Page 75 of 76
Backup (Source Media)
Media
ShadowProtect SPX Comment
Internal HDD
(Non
removable)
Yes
Yes
External HDD
Yes
Yes
USB Flash drive Yes
No
Backup (Destination Media)
Backup to
CD/DVD
Yes
No
(Non
removable)
Yes
Yes
External HDD
Yes
Yes
Internal HDD
Network folder
Yes
Yes
Windows network shared
folder
Linux NAS with CIFS
shared folder
SPX Management API
Feature
ShadowProtect
SPX
Technology
COM interface
RESTful API
Access to RESTful API using:
Code and script
support
Access to com
using:
C++
VBScripts
C/C++
Java
Python
and any other language that can
communicate over an HTTP/RESTful API
Page 76 of 76

ShadowProtect SPX User Guide

Transcription

Similar documents

(C) Engine - Automotriz En Video

Extend Lube Filter life and reduce operating cost

AcendexAssure

Brochure - English

Snapshot EFB – Enterprise File Backup Rack 8b

Darshanen Vasanthan

longevity solutions

The Writing Side of Sales

Anhydro Triple-A® Spray Dryer

Transtar Presentation SPX