IBM Spectrum Protect for Virtual Environments
Version 8.1.4
Data Protection for Microsoft Hyper-V
Installation and User's Guide
IBM
IBM Spectrum Protect for Virtual Environments
Version 8.1.4
Data Protection for Microsoft Hyper-V
Installation and User's Guide
IBM
Note:
Before you use this information and the product it supports, read the information in “Notices” on page 181.
This edition applies to version 8, release 1, modification 4 of IBM Spectrum Protect for Virtual Environments
(product number 5725-X00) and to all subsequent releases and modifications until otherwise indicated in new
editions.
© Copyright IBM Corporation 2011, 2017.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
About this publication
. . . . . . . . v
Who should read this publication .
Publications . . . . . . . .
.
.
.
.
.
.
.
.
.
.
. v
. v
What's new in Version 8.1.4. . . . . . vii
Chapter 1. Protection for Microsoft
Hyper-V virtual machines . . . . . . . 1
|
|
Back up Hyper-V virtual machines . . . . . . . 1
Virtual machine backups with Volume Shadow
Copy Service (VSS) . . . . . . . . . . . 2
Virtual machine backups with resilient change
tracking (RCT) . . . . . . . . . . . . . 2
Restore Hyper-V virtual machines . . . . . . . 4
User interfaces for Hyper-V operations . . . . . 5
How IBM Spectrum Protect nodes are used in Data
Protection for Microsoft Hyper-V . . . . . . . 7
Policy management at the virtual machine level . . 9
Incremental forever backup strategy . . . . . . 9
Snapshot management with Windows PowerShell 10
Limitations on Hyper-V backup operations . . . . 10
Documentation resources . . . . . . . . . . 12
Chapter 2. Installation of Data
Protection for Microsoft Hyper-V . . . 15
|
|
|
|
|
|
|
|
|
|
Determine system requirements . . . . . . .
Features that are installed . . . . . . . . .
Upgrading Data Protection for Microsoft Hyper-V
Updating nodes on the IBM Spectrum Protect
server . . . . . . . . . . . . . . .
Upgrade considerations for RCT backups . . .
Migrating from VSS backups to RCT backups . .
Download and extract the installation package . .
Installing Data Protection for Microsoft Hyper-V . .
Installing the mount proxy feature on Linux systems
Installing the IBM Spectrum Protect recovery agent
Installing in silent mode . . . . . . . . . .
Installing and configuring Data Protection for
Microsoft Hyper-V on Windows Server Core
systems. . . . . . . . . . . . . . . .
Uninstalling Data Protection for Microsoft Hyper-V
Removing the file restore feature . . . . . . .
15
16
16
16
18
19
19
20
22
23
24
25
27
28
Chapter 3. Configuring Data Protection
for Microsoft Hyper-V . . . . . . . . 29
|
|
|
|
|
|
|
|
Configuring Data Protection for Microsoft Hyper-V
with the wizard . . . . . . . . . . . . .
Configuring security settings for Data Protection for
Microsoft Hyper-V . . . . . . . . . . . .
Configuring security settings to connect to IBM
Spectrum Protect server V8.1.1 or earlier or
V7.1.7 or earlier . . . . . . . . . . . .
Enabling the environment for file restore operations
© Copyright IBM Corp. 2011, 2017
29
33
34
35
|
|
|
|
|
|
|
|
|
|
Configuring the Linux mount proxy for file restore
operations . . . . . . . . . . . . . .
Modifying options for file restore operations . .
Options for file restore operations . . . . .
Configuring Data Protection for Microsoft Hyper-V
log activity . . . . . . . . . . . . .
Data Protection for Microsoft Hyper-V log
activity options . . . . . . . . . . .
Configuring the IBM Spectrum Protect recovery
agent GUI . . . . . . . . . . . . . .
Enabling secure communication from the
recovery agent to the IBM Spectrum Protect
server . . . . . . . . . . . . . .
Manually configuring an iSCSI device . . . .
Advanced configuration . . . . . . . . .
Configuring non-default port numbers for Data
Protection for Microsoft Hyper-V operations .
Tuning scheduled VM backups for Windows
Server 2012 and 2012 R2 clusters . . . . .
. 37
. 39
. 39
. 40
. 41
. 42
. 46
. 49
. 51
. 51
. 52
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Chapter 4. Managing data with the Data
Protection for Microsoft Hyper-V
Management Console . . . . . . . . 55
|
|
|
|
|
|
Chapter 5. Getting started with file
restore operations . . . . . . . . . . 73
|
|
|
|
Chapter 6. Protecting virtual machines
by using Windows PowerShell cmdlets. 79
Starting the Data Protection for Microsoft Hyper-V
Management Console . . . . . . . . . .
Navigating the Data Protection for Microsoft
Hyper-V Management Console . . . . . . .
Navigation pane . . . . . . . . . . .
Results pane . . . . . . . . . . . .
Actions pane . . . . . . . . . . . .
Managing backup schedules for a host or cluster
machine . . . . . . . . . . . . . .
Setting the at-risk policy for a virtual machine. .
Viewing the schedule history for a Hyper-V host or
cluster . . . . . . . . . . . . . . .
Viewing the backup status and backup history of a
virtual machine . . . . . . . . . . . .
Running an ad hoc backup of a virtual machine .
Restoring a virtual machine . . . . . . . .
Best practices for Data Protection for Microsoft
Hyper-V . . . . . . . . . . . . . .
File restore tasks. . . . . . . . . . .
File restore prerequisites . . . . . . . .
Logging in to restore files . . . . . . .
Restoring files from a virtual machine backup .
.
.
.
.
Preparing to use PowerShell cmdlets with Data
Protection for Microsoft Hyper-V . . . . . .
. 55
.
.
.
.
56
56
56
62
. 63
. 65
. 66
. 66
. 67
. 69
. 71
.
.
.
.
73
74
76
76
. 79
iii
|
|
|
|
Chapter 9. Mount and file restore . . . 137
PowerShell cmdlets for Data Protection for
Microsoft Hyper-V . . . . . . . . . .
Data Protection for Microsoft Hyper-V cmdlet
examples . . . . . . . . . . . . .
.
. 80
.
. 83
IBM Spectrum Protect recovery agent
configurations . . . . . . . . .
Snapshot mount overview . . . . .
Mount guidelines . . . . . . .
File restore overview . . . . . . .
File restore guidelines . . . . .
Restoring one or more files . . . . .
Chapter 7. Command reference . . . . 89
Reading syntax diagrams . . . . . . . . . . 89
Backup VM . . . . . . . . . . . . . . . 91
Expire . . . . . . . . . . . . . . . . 99
Query VM . . . . . . . . . . . . . . . 100
Restore VM . . . . . . . . . . . . . . 104
iv
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
107
109
109
112
114
115
116
117
119
120
121
122
123
123
125
125
126
126
127
128
129
130
131
133
134
135
136
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
137
138
139
139
141
141
Chapter 10. IBM Spectrum Protect
recovery agent commands . . . . . 145
Mount . . . . . . . . . . . . . .
Set_connection. . . . . . . . . . .
Help . . . . . . . . . . . . . .
Recovery agent command-line interface return
codes . . . . . . . . . . . . . .
Chapter 8. Options reference. . . . . 107
Dateformat . . . . . .
Detail. . . . . . . .
Domain.vmfull . . . . .
Exclude.vmdisk . . . . .
Filelist . . . . . . .
Inactive . . . . . . .
Include.vm . . . . . .
Include.vmdisk . . . . .
INCLUDE.VMSNAPSHOTATTEMPTS
Mode . . . . . . . .
Mbobjrefreshthresh . . .
Mbpctrefreshthresh . . .
Noprompt . . . . . . .
Numberformat . . . . .
Pick . . . . . . . .
Pitdate . . . . . . .
Pittime . . . . . . .
Skipsystemexclude . . .
Timeformat . . . . . .
Vmbackdir . . . . . .
Vmctlmc . . . . . . .
Vmmaxparallel . . . . .
Vmmaxpersnapshot . . . .
Vmmaxsnapshotretry . . .
Vmmc . . . . . . . .
Vmprocessvmwithphysdisks .
Vmskipphysdisks . . . .
.
.
.
.
.
.
.
.
.
. 145
. 148
. 149
.
. 150
Appendix A. Troubleshooting . . . . 153
|
|
|
|
Troubleshooting Data Protection for Microsoft
Hyper-V operations . . . . . . . . . .
Trace options for Data Protection for Microsoft
Hyper-V . . . . . . . . . . . . . .
. 156
. 157
Appendix B. Data Protection for
Microsoft Hyper-V messages. . . . . 159
Appendix C. Accessibility features for
the IBM Spectrum Protect product
family. . . . . . . . . . . . . . . 179
Notices . . . . . . . . . . . . . . 181
Glossary . . . . . . . . . . . . . 185
Index . . . . . . . . . . . . . . . 187
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
About this publication
This publication provides overview, planning, and user instructions for IBM
Spectrum Protect™ for Virtual Environments: Data Protection for Microsoft
Hyper-V.
Who should read this publication
This publication is intended for administrators and users who are responsible for
implementing a backup solution with IBM Spectrum Protect for Virtual
Environments: Data Protection for Microsoft Hyper-V in one of the supported
environments.
In this publication, it is assumed that you have an understanding of the following
applications:
v Microsoft Windows Server 2016 with the Hyper-V role installed
v Microsoft Windows Server 2012 or 2012 R2 with the Hyper-V role installed
v The IBM Spectrum Protect backup-archive client
v The IBM Spectrum Protect server
Publications
The IBM Spectrum Protect product family includes IBM Spectrum Protect
Snapshot, IBM Spectrum Protect for Space Management, IBM Spectrum Protect for
Databases, and several other storage management products from IBM®.
To view IBM product documentation, see IBM Knowledge Center.
© Copyright IBM Corp. 2011, 2017
v
vi
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
What's new in Version 8.1.4
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V Version 8.1.4 introduces new features and updates.
New and changed information in this product documentation is indicated by a
vertical bar (|) to the left of the change.
The following features and updates are new in this release:
Take advantage of the streamlined installation procedure
The installation of Data Protection for Microsoft Hyper-V is integrated into
a single, simplified installation process with the suite installer.
For more information, see Chapter 2, “Installation of Data Protection for
Microsoft Hyper-V,” on page 15.
If you want to install the IBM Spectrum Protect recovery agent separately,
see “Installing the IBM Spectrum Protect recovery agent” on page 23.
Simplify product configuration and daily operations by using the new
management console
Use the new Data Protection for Microsoft Hyper-V Management Console
to help you simplify configuration and daily operations of Data Protection
for Microsoft Hyper-V.
You can use the Data Protection for Microsoft Hyper-V Management
Console to complete the following tasks:
v “Configuring Data Protection for Microsoft Hyper-V with the wizard”
on page 29
v “Managing backup schedules for a host or cluster machine” on page 63
v “Setting the at-risk policy for a virtual machine” on page 65
v “Viewing the schedule history for a Hyper-V host or cluster” on page 66
v “Viewing the backup status and backup history of a virtual machine” on
page 66
v “Running an ad hoc backup of a virtual machine” on page 67
v “Restoring a virtual machine” on page 69
For a description of the main areas of the Data Protection for Microsoft
Hyper-V Management Console, see “Navigating the Data Protection for
Microsoft Hyper-V Management Console” on page 56.
With the availability of the Data Protection for Microsoft Hyper-V
Management Console, you no longer have to use the IBM Spectrum Protect
backup-archive client GUI to run Data Protection for Microsoft Hyper-V
operations.
Restore files from a web-based interface
After the configuration of the IBM Spectrum Protect file restore interface is
completed, file owners can search for, locate, and restore files from virtual
machine (VM) backups by using a specific URL that is provided by the
administrator. Help desk personnel can also use this URL to restore files on
behalf of file owners.
For more information, see:
v Chapter 5, “Getting started with file restore operations,” on page 73
© Copyright IBM Corp. 2011, 2017
vii
v “Logging in to restore files” on page 76
Protect Hyper-V VM data by using Windows PowerShell cmdlets
Windows PowerShell cmdlets are available to run Data Protection for
Microsoft Hyper-V operations. For more information, see Chapter 6,
“Protecting virtual machines by using Windows PowerShell cmdlets,” on
page 79.
For a list of new features and updates in previous V8.1 releases, see Data
Protection for Microsoft Hyper-V updates.
viii
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Chapter 1. Protection for Microsoft Hyper-V virtual machines
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V is a licensed product that provides storage management services for
virtual machines (VMs) in a Microsoft Hyper-V environment.
Data Protection for Microsoft Hyper-V works with the IBM Spectrum Protect
backup-archive client to protect Hyper-V virtual machines on the following
operating systems:
v Microsoft Windows Server 2012
v Microsoft Windows Server 2012 R2
v Microsoft Windows Server 2016
Back up Hyper-V virtual machines
Data Protection for Microsoft Hyper-V creates an incremental-forever full or
incremental-forever incremental backup of Hyper-V virtual machines (VMs). A
consistent snapshot is taken of the VM, and the VM is backed up to the IBM
Spectrum Protect server.
You can back up Hyper-V VMs that exist on a local disk, a SAN-attached disk, or
Cluster Shared Volume (CSV). For example, you can back up VMs that are stored
on CSVs in a Hyper-V cluster environment or on Server Message Block (SMB) file
shares that are on a remote system. You can back up any guest operating systems
that are supported by the Hyper-V server on remote shares, regardless of whether
IBM Spectrum Protect supports them directly.
The following backup types are supported for Microsoft Hyper-V VMs with virtual
disks that use the VHDX disk format:
Incremental-forever full backup
Creates a backup of snapshot disk data to the IBM Spectrum Protect server.
Incremental-forever incremental backup
Creates a snapshot of the blocks that changed since the last
incremental-forever full backup or incremental-forever incremental backup.
If you are running the Hyper-V host on the Windows Server 2012 or Windows
Server 2012 R2 operating system, Microsoft Volume Shadow Copy Service (VSS) is
used to create a consistent snapshot of the VM. Changes that occur in the VM
between each backup are tracked in a snapshot differencing file.
If you are running the Hyper-V host on a Windows Server 2016 or later operating
system, snapshots are created by using a Windows API, and resilient change
tracking (RCT) is used to track changes in a VHDX disk between each backup
operation.
© Copyright IBM Corp. 2011, 2017
1
Virtual machine backups with Volume Shadow Copy Service
(VSS)
For Hyper-V backups on Windows Server 2012 and 2012 R2, Microsoft Volume
Shadow Copy Service (VSS) is used to create consistent snapshots of virtual
machines (VMs) during backup operations.
During an initial incremental-forever full backup operation, the client creates a
snapshot of the virtual machine hard disk (VHDX) and sends the content to the
IBM Spectrum Protect server. Changes that occur after the initial snapshot are
stored in a snapshot differencing file (.avhdx). Subsequent incremental-forever
incremental backup operations back up only the data that was changed since the
last backup.
If you run an incremental-forever incremental backup before you create an
incremental-forever full backup, the client will run an incremental-forever full
backup.
How snapshots work with VSS backups
During each VM backup, a new snapshot differencing file (.avhdx) is created to
track the changes to the VM that occur after the backup operation. This
differencing snapshot is saved on the Hyper-V host to collect the writes for the
next incremental backup.
In previous releases of Data Protection for Microsoft Hyper-V, a snapshot could
contain only one VM. This behavior could cause scheduling contention during
cluster backup operations because too many snapshots had to be taken. By using
the vmmaxpersnapshot option that was introduced in Data Protection for Microsoft
Hyper-V Version 8.1.2, you can reduce the number of snapshots that are taken for
a backup operation by grouping several VMs in a single snapshot. For more
information, see “Tuning scheduled VM backups for Windows Server 2012 and
2012 R2 clusters” on page 52.
Virtual machine backups with resilient change tracking (RCT)
For Hyper-V backups on Microsoft Windows Server 2016 or later versions, the
resilient change tracking (RCT) feature is used to back up virtual machines (VMs).
RCT is a feature that provides built-in change block tracking capability for
Hyper-V VM disks. Data Protection for Microsoft Hyper-V uses RCT to track
changes to a VM disk (VHDX) that occur in between backup operations. The
changes are tracked at the data block level. Only blocks that have changed since
the last backup operation are candidates for the next incremental-forever
incremental backup.
Windows Server 2016 also provides the capability to create backup snapshots (also
known as checkpoints) directly without using Microsoft Volume Shadow Copy
Service (VSS) (although VSS is still used inside Windows guest VMs to quiesce the
VMs for application-consistent backups).
VM backup operations with RCT require the Hyper-V VM to be Version 6.2 or
later.
If your VM was created on the Windows Server 2012 R2 or earlier operating
system, and then later moved to a Windows Server 2016 host server (or the host
server was upgraded to Windows Server 2016), you must take the VM offline and
2
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
upgrade the VM version before it can be backed up. You can upgrade the VM
Version by using the Hyper-V Manager or the Update-VMVersion cmdlet.
Data Protection for Microsoft Hyper-V V8.1.0 uses VSS to back up VMs in the
Hyper-V environment on Windows Server 2016. Starting in V8.1.2, all Hyper-V VM
backup operations in the Windows Server 2016 or later environment uses RCT. If
you are upgrading from V8.1.0, because previous VSS backups do not have RCT
change-tracking information, the first time you use Data Protection for Microsoft
Hyper-V V8.1.4 to back up your VMs on Windows Server 2016, an
incremental-forever full backup is created.
After you backed up a VM using RCT, you can no longer use Data Protection for
Microsoft Hyper-V V8.1.0 to run VSS backups on that VM.
How snapshots work with RCT backups
During an incremental-forever full backup operation for a VM, a snapshot is
created of the VM disk and the snapshot contents are backed up to the IBM
Spectrum Protect server. The snapshot is deleted automatically after the backup
operation is completed.
During the next incremental-forever incremental backup, a new snapshot is created
and verified against the RCT change-tracking information from the previous
backup operation to determine the data that has changed. Only the changed blocks
are backed up to the IBM Spectrum Protect server.
After the backup operation, the snapshot is merged with the VM by Hyper-V, and
the snapshot differencing file (.avhdx) is deleted automatically. This process is
unlike the VSS snapshot processing on Windows Server 2012 and 2012 R2
operating systems, in which the snapshot differencing file is retained on the VM to
store incremental changes.
Any snapshot that you create manually or with another backup product do not
affect the backup chain that is created by the RCT process. You can create
snapshots manually or with a third-party backup product before or after a Data
Protection for Microsoft Hyper-V RCT backup operation, and the next incremental
backup operation by Data Protection for Microsoft Hyper-V will be based on the
RCT change-tracking information from the previous backup operation.
Features that are available for RCT backups
Most Data Protection for Microsoft Hyper-V features that work on Windows Server
2012 and 2012 R2 also apply to Windows Server 2016.
However, snapshot operations are different between VSS and RCT backups. For
more information, see “How snapshots work with RCT backups.”
Support for host failover with Cluster Shared Volumes (CSVs) is unchanged from
V8.1.0 and earlier, but running a VM backup during a rolling upgrade of a
Hyper-V cluster operating system is not supported.
In addition to the features that are available with VSS, the following features also
apply to RCT backup operations on Windows Server 2016.
Chapter 1. Protection for Microsoft Hyper-V virtual machines
3
Table 1. Features available only for RCT backup operations
Feature
More information
Control backup operations for VMs with
physical disks (pass-through disks).
v “Vmprocessvmwithphysdisks” on page 135
v “Vmskipphysdisks” on page 136
Choose the level of data consistency to
“INCLUDE.VMSNAPSHOTATTEMPTS” on page 119
achieve during backup operations by
specifying the number of snapshot attempts.
Specify whether VM disks (VHDX) are
included in or excluded from RCT backup
operations.
v “Exclude.vmdisk” on page 112
v “Include.vmdisk” on page 117
v “Domain.vmfull” on page 109
v “Backup VM” on page 91
How to query RCT backups
You can use the query VM command to display information about a VM that was
backed up to the IBM Spectrum Protect server. Use the -detail parameter with the
query vm command to show detailed information about the backup operation. For
more information, see “Query VM” on page 100.
You can also use the backup vm -preview command to display the VM disk
locations that can be used for the backup vm command. For more information, see
“Backup VM” on page 91.
Related concepts:
“Upgrading Data Protection for Microsoft Hyper-V” on page 16
“Limitations on Hyper-V backup operations” on page 10
“Virtual machine backups with Volume Shadow Copy Service (VSS)” on page 2
Related tasks:
“Migrating from VSS backups to RCT backups” on page 19
Related reference:
Appendix A, “Troubleshooting,” on page 153
Restore Hyper-V virtual machines
You can restore Hyper-V virtual machines (VMs) by using several methods. You
can restore an entire virtual machine, restore an entire virtual machine to an
alternative location, or restore individual files from a virtual machine.
Full VM Restore
Restore an entire Hyper-V VM
Each Hyper-V VM backup is restored from the IBM Spectrum
Protect server as a single entity. You can restore any guest
operating systems that are hosted by the Hyper-V server regardless
of whether the guest operating system is supported by IBM
Spectrum Protect.
A Data Protection for Microsoft Hyper-V restore operation ensures
that the same block on the production disk is restored only once.
Older backup versions expire according to the IBM Spectrum
Protect server management class policy that is associated with the
virtual machine.
4
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Restore an entire Hyper-V VM to an alternative location
You can restore a Hyper-V VM to an alternative VM name, to an
alternative location on the Hyper-V host, or both. You can also
restore a Hyper-V VM to a different Hyper-V host by using the
Data Protection for Microsoft Hyper-V Management Console. If
you must use the command line to restore a VM to a different host,
you must run the restore operation from the Hyper-V host where
the VM is being restored to.
|
|
|
|
|
|
|
|
Restore files with the file restore interface
Use the IBM Spectrum Protect file restore interface to restore one or more
files with a web-based interface. File owners can search, locate, and restore
files from a VM backup with minimal administrator assistance. Help desk
personnel can also use the file restore interface to restore files on behalf of
file owners.
For more information, see Chapter 5, “Getting started with file restore
operations,” on page 73.
Restore files with the recovery agent
Use this restore method only if you want to run in-guest mount operations.
Files are manually copied from a mounted virtual machine disk that is
accessed through an Internet Small Computer Systems Interface (iSCSI)
target or partition. This method requires the IBM Spectrum Protect
recovery agent to be installed.
For more information, see Chapter 9, “Mount and file restore,” on page
137.
User interfaces for Hyper-V operations
You can use several user interfaces to complete Data Protection for Microsoft
Hyper-V Hyper-V operations. The data mover must be installed on the Hyper-V
host server or on each host in a cluster.
The following user interfaces are available for Data Protection for Microsoft
Hyper-V operations:
|
|
|
|
|
Data Protection for Microsoft Hyper-V Management Console
A graphical user interface that you can use to perform daily backup
management tasks, such as managing virtual machine (VM) backups,
monitoring VM backups, running ad hoc backup and restore operations,
and updating the configuration.
|
|
|
|
IBM Spectrum Protect file restore interface
A web-based interface that file owners or help desk personnel can use to
restore one or more files from a VM backup with minimal administrator
assistance. The administrator provides a URL for the file restore interface.
|
|
|
|
Data mover
A component, also known as the backup-archive client, that moves data to
and from the IBM Spectrum Protect server during backup and restore
operations.
|
|
The data mover includes a command-line interface (dsmc commands) that
you can use for backup, query, restore, and other operations.
|
|
|
Data Protection for Microsoft Hyper-V cmdlets
Windows PowerShell cmdlets that help you automate Data Protection for
Microsoft Hyper-V operations with PowerShell scripts.
Chapter 1. Protection for Microsoft Hyper-V virtual machines
5
IBM Spectrum Protect recovery agent
An agent that provides virtual mount and file restore capability.
|
|
The following figures are the high-level overviews of Data Protection for Microsoft
Hyper-V in the Windows Server 2016 or later and the Windows Server 2012
environments.
Windows Server 2016 Hyper-V Host
IBM Spectrum
Protect Server
Incrementalforever
full backup
Incrementalforever
incremental
backup
Guest machine
Windows
API
IBM Spectrum
Protect for Virtual
Environments: Data
Protection for Microsoft
Hyper-V management
console
Data
mover
Snapshot of the VM
IBM Spectrum Protect
file restore interface
Figure 1. High-level overview of Data Protection for Microsoft Hyper-V in the Windows Server 2016 environment
6
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Windows Server 2012 Hyper-V Host
IBM Spectrum
Protect Server
Incrementalforever
full backup
Incrementalforever
incremental
backup
Guest machine
VSS
API
IBM Spectrum
Protect for Virtual
Environments: Data
Protection for Microsoft
Hyper-V management
console
Data
mover
Shadowcopy of the VM
IBM Spectrum Protect
file restore interface
Figure 2. High-level overview of Data Protection for Microsoft Hyper-V in the Windows Server 2012 environment
|
|
How IBM Spectrum Protect nodes are used in Data Protection for
Microsoft Hyper-V
|
|
Data Protection for Microsoft Hyper-V communicates to VMs during backup,
restore, and mount operations through IBM Spectrum Protect nodes.
|
|
|
|
|
A node represents a system on which the data mover, Data Protection for Microsoft
Hyper-V, or other application client is installed. This system is registered to the
IBM Spectrum Protect server. Each node has a unique name (node name) that is
used to identify the system to the server. Communication, storage policy, authority,
and access to VM data are defined based on a node.
|
|
In a Data Protection for Microsoft Hyper-V environment, the most basic node
configuration consists of two nodes: the data mover node and the target node.
|
|
|
v The data mover node represents a specific data mover that "moves data" from
one system to another. No data is stored under this node on the IBM Spectrum
Protect server.
|
|
v The target is the node name under which VM data is stored on the IBM
Spectrum Protect server.
|
|
|
In a cluster environment, the node configuration consists of a target node that is
associated with the name of the cluster, and one data mover node for each host in
the cluster.
Chapter 1. Protection for Microsoft Hyper-V virtual machines
7
|
|
|
|
|
|
|
|
For mount operations, a mount proxy node pair is required for each host system.
A mount proxy node represents the Linux or Windows proxy system that accesses
the mounted VM disks through an iSCSI connection. These nodes enable the file
systems on the mounted VM disks to be accessible as mount points on the proxy
system. You can then use the file restore interface to restore individual files, or use
the recovery agent to retrieve the files by copying them from the mount points to
your local disk. Mount proxy nodes are created in pairs and are required by the
Hyper-V host node for each Windows or Linux system that serves as a proxy.
|
|
|
|
|
|
To simplify the configuration, the Data Protection for Microsoft Hyper-V
configuration wizard automatically creates the various nodes that are required for
backup, restore, and file restore operations. The configuration wizard also registers
the nodes on the IBM Spectrum Protect server, creates the necessary proxy
relationships, creates the local options files, configures and starts the services for
the data mover node on local Windows hosts.
|
|
|
|
The types of nodes that are created depend on your Hyper-V environment and
whether you enabled the file restore feature. The node names that are created
follow a specific naming convention that is based on the cluster or host name, and
the node type. Custom node names cannot be used.
|
|
|
|
If you are upgrading from Data Protection for Microsoft Hyper-V V8.1.2 or earlier
and have nodes that are already defined on the IBM Spectrum Protect server, you
must update the node names on the server. For more information, see “Updating
nodes on the IBM Spectrum Protect server” on page 16.
|
|
The following table contains a comparison of the different types of nodes in the
Data Protection for Microsoft Hyper-V environment.
|
Table 2. Types of nodes configured by the configuration wizard
|
Node type
Naming convention
Description
|
|
|
|
|
|
|
|
|
|
Target node
For a stand-alone host:
hostname_HV_TGT
The node name where all VM
backups are stored on the IBM
Spectrum Protect server.
|
|
|
|
Data mover node
For a cluster: clustername_HV_TGT
For clusters, VMs are backed up to a
single container on the IBM Spectrum
Protect server under a single node
name (cluster node), regardless of
which host in the cluster is backing
them up.
hostname_HV_DM
|
|
|
|
|
|
The node that backs up data to the
target node on the IBM Spectrum
Protect server. No data is stored
under the data mover node.
For clusters, a data mover node is
created for each host in the cluster.
Windows mount proxy node
|
|
|
hostname_HV_MP_WIN
One of two nodes in a mount proxy
node pair that is required for mount
operations for the file restore
interface.
For clusters, a Windows mount proxy
node is created for each host in the
cluster.
8
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Table 2. Types of nodes configured by the configuration wizard (continued)
|
Node type
Naming convention
Description
|
|
|
|
Linux mount proxy node
hostname_HV_MP_LNX
One of two nodes in a mount proxy
node pair that is required for mount
operations for the file restore
interface.
|
|
|
|
For clusters, a Linux mount proxy
node is created for each host in the
cluster.
|
Policy management at the virtual machine level
Storage requirements for Hyper-V virtual machine backups are determined by IBM
Spectrum Protect server management classes.
You can set different policies for different virtual machines. Although the default
management class determines storage characteristics for all Hyper-V backups, you
can override the default management class or specify a management class to use
for the Hyper-V control files.
You can change the default management class for Hyper-V virtual machine
backups with the vmmc option. You can change the default management class for
Hyper-V control files with the vmctlmc option.
Related reference:
“Vmmc” on page 134
“Vmctlmc” on page 129
Incremental forever backup strategy
An incremental forever backup strategy minimizes backup windows while
providing faster recovery of your data.
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V provides a backup strategy called incremental forever. This backup
solution requires only one initial full backup. Afterward, an ongoing (forever)
sequence of incremental backups occurs. The incremental forever backup solution
provides these advantages:
v Reduces the amount of data that goes across the network.
v Reduces data growth because all incremental backups contain only the blocks
that changed since the previous backup.
v No comparison with the backup target is needed since only changed blocks are
identified.
v Minimizes impact to the client system.
v Reduces the length of the backup window.
v No need to schedule an initial full backup as a separate schedule: the first issue
of an incremental forever backup automatically defaults to an incremental
forever full backup.
In addition, the restore process is optimized, as only the latest versions of blocks
that belong to a restored backup are restored. Since the same area on the
production disk is recovered only one time, the same block is not written to
multiple times. As a result of these advantages, incremental forever is the preferred
Chapter 1. Protection for Microsoft Hyper-V virtual machines
9
backup strategy.
Snapshot management with Windows PowerShell
On a Microsoft Hyper-V system, you can use Windows PowerShell “cmdlets” to
remove (undo) snapshots that were created by IBM Spectrum Protect for a
Hyper-V virtual machine.
You can use these cmdlets only on the Hyper-V system; you cannot remove
snapshots from the Microsoft System Center Virtual Machine Manager.
Hyper-V systems issue cautionary messages to discourage you from editing virtual
hard disks that contain snapshots, or virtual hard disks that are associated with a
chain of differencing (incremental-forever) snapshots. Instead, use the cmdlets to
manage snapshots to minimize the risk of data loss.
For a list of cmdlets that are available for Hyper-V, go to http://
technet.microsoft.com/en-us/library/hh848559.aspx and read the information for
the available cmdlets. Use the Get-VMSnapshot cmdlet with the -SnapshotType
Recovery parameter to retrieve snapshots for a virtual machine. Use the
Remove-VMSnapshot cmdlet to remove a snapshot. Removing a snapshot merges the
information that the snapshot wrote to the snapshot differences file (the AVHDX
file) back to the virtual machine hard disk (the VHDX file).
Limitations on Hyper-V backup operations
Before you start a Hyper-V backup operation, review the limitations. Some
limitations apply to all Hyper-V backup operations, while others apply only to
Hyper-V backups on Windows Server 2012 or 2012 R2 or Windows Server 2016
environments.
Limitations that apply to all Hyper-V backups
Data Protection for Microsoft Hyper-V supports incremental-forever full backup
and incremental-forever incremental backup operations for Microsoft Hyper-V
virtual machines (VMs) in VHDX disk format only. If you need to back up
Hyper-V VMs in VHD disk format, use the Version 7.1.6 or earlier backup-archive
client without Data Protection for Microsoft Hyper-V to create an image backup of
the full VM. Issue the backup-archive client dsmc backup vm vmname -mode=full
command to create an image backup of all objects on a Microsoft Hyper-V virtual
machine VHD or VHDX disk. Optionally, convert .vhd files to .vhdx format
according to instructions available in Microsoft documentation.
Data Protection for Microsoft Hyper-V support for VM backup operations is
limited to VM names and Hyper-V host or cluster names that contain English 7-bit
ASCII characters only. VM names and Hyper-V host or cluster names that use
other language characters are not currently supported. More character restrictions
are listed in “Unsupported characters in virtual machine and Hyper-V host or
cluster names” on page 154.
|
|
|
|
|
|
The Microsoft Windows Management Instrumentation (WMI) Service (winmgmt)
must be running on the systems where Data Protection for Microsoft Hyper-V, IBM
Spectrum Protect backup-archive client, and IBM Spectrum Protect recovery agent
are installed. Operations fail if the WMI Service is not running. Therefore, do not
turn off the WMI Service.
10
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Verify that no Exchange Server database is hosted on raw device mapped (RDM)
disks in physical compatibility mode, independent disks, or on disks that are
attached directly to the guest through in-guest iSCSI.
You cannot back up a VM with a shared virtual hard disk.
Limitations that apply only to VSS backups on Windows Server
2012 and 2012 R2
Data Protection for Microsoft Hyper-V does not back up VMs with attached
physical disks (pass-through disks such as iSCSI disks). This limitation occurs
because Data Protection for Microsoft Hyper-V uses Volume Shadow Copy Service
(VSS) for backup operations and VSS cannot create a snapshot of the physical
disks. If you try to back up a VM with attached physical disks, the backup
operation of the VM with the physical disk fails, but backup operations continue
for other VMs.
Hyper-V configurations on the Windows Server 2012 R2 operating system are not
compatible with Windows Server 2012. As a result, a restore operation from
Windows Server 2012 R2 to Windows Server 2012 fails. However, a restore
operation from Windows Server 2012 to Windows Server 2012 R2 succeeds. For
more information, got to the Microsoft Knowledge Base and search for Article
2868279.
Limitations that apply only to RCT backups on Windows Server
2016 or later
You cannot run a VM backup operation during a rolling upgrade of a Hyper-V
cluster operating system.
If Data Protection for Microsoft Hyper-V is unable to retrieve the change tracking
information, an incremental-forever full backup is run.
You cannot run concurrent backup operations on the same VM. For example, if
you run two backup vm commands on the same VM at the same time, one of the
backup operations fails with an error message.
Data Protection for Microsoft Hyper-V cannot create an application-consistent
snapshot of a VM that is in the Paused state. Only a crash-consistent snapshot can
be created of a VM in the Paused state. For example, set the following option in the
dsm.opt file:
INCLUDE.VMSNAPSHOTATTEMPTS VM_name 1 1
You cannot install Data Protection for Microsoft Hyper-V on Nano Server for
Windows Server 2016. However, you can use Data Protection for Microsoft
Hyper-V on Windows Server 2016 to create crash-consistent backups of Nano
Server guest VMs.
For late-breaking updates about known issues and limitations, see technote
1993768.
Chapter 1. Protection for Microsoft Hyper-V virtual machines
11
Documentation resources
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V software provides several components to assist with protecting your
virtual machines. As a result, multiple documentation resources are provided to
assist with specific tasks.
Table 3. Data Protection for Microsoft Hyper-V documentation resources
Documentation
Contents
Location
IBM Spectrum Protect for Virtual
Environments Data Protection for
Microsoft Hyper-V Installation and
User's Guide
Overview information, strategy
planning, installation, configuration,
back up and restore scenarios, and
command-line reference.
IBM Knowledge Center at
https://www.ibm.com/support/
knowledgecenter/SSERB6_8.1.4/
ve.user/r_pdf_ve.html
Online help for the Data Protection
for Microsoft Hyper-V Management
Console GUI
Back up and restore tasks related to
Hyper-V guest virtual machines,
configuration, backup management,
and backup monitoring.
Start the virtual machines using
either of the following methods:
v On the Windows system, click
Start > IBM Spectrum Protect >
DP for Hyper-V Management
Console.
v Open an Administrator command
prompt window and enter the
following command:
"C:\Program Files\IBM\
SpectrumProtect\DPHyperV\
DpHv.msc"
Access the help using either of the
following methods:
v Click the Help icon ("?") in the
interface.
v In the menu bar, click Help >
Help on Data Protection for
Microsoft Hyper-V. You can also
press the F1 key to open the online
help.
Online help for the IBM Spectrum
Protect file restore interface
Restore individual files and folders
from a VM backup.
Start the file restore interface with
the URL that is provided by the file
restore administrator.
Access the help by clicking Help >
Product documentation.
12
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Table 3. Data Protection for Microsoft Hyper-V documentation resources (continued)
Documentation
Contents
Location
Online help for the data mover
command-line client
Back up and restore tasks related to
Hyper-V guest virtual machines.
Start the data mover command-line
client by using either of the
following methods:
v On the Windows system, go to
Start > IBM Spectrum Protect >
Backup-Archive Command Line.
v Open an Administrator command
prompt window and change to the
backup-archive client installation
directory ( cd "C:\Program
Files\tivoli\tsm\baclient").
Run dsmc.exe.
Access the help by using either of
the following methods:
v After you start the command-line
client, at the Protect> prompt,
enter help to display the table of
contents for the help.
v To display the help in its own
window, open an Administrator
command prompt window and
change to the backup-archive
client installation directory (cd
"C:\Program Files\tivoli\tsm\
baclient").
Run dsmc.exe help to display the
help table of contents. You can
also append a topic title to the
command to display help for a
topic. For example, dsmc help
options displays the help topic
that describes how to use client
options; dsmc help backup vm
displays the help for the backup vm
command.
Chapter 1. Protection for Microsoft Hyper-V virtual machines
13
14
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Chapter 2. Installation of Data Protection for Microsoft
Hyper-V
Installation of IBM Spectrum Protect for Virtual Environments: Data Protection for
Microsoft Hyper-V includes understanding the system requirements, determining
which features to install, and installation. Upgrade considerations and
uninstallation procedures are also provided.
Determine system requirements
Data Protection for Microsoft Hyper-V requires a minimum amount of hardware,
disk space, memory, and software.
|
|
The following table describes the hardware requirements that are needed to install
Data Protection for Microsoft Hyper-V.
|
Table 4. Hardware requirements for Data Protection for Microsoft Hyper-V
|
Component
Minimum requirement
Preferred
|
System
x64 processor
Not applicable
|
Memory
4 GB RAM
Not applicable
|
Available hard disk
700 MB
1.5 GB
|
|
NIC Card
1 NIC - 100 Mbps
1 NIC - 10 Gbps
Data Protection for Microsoft Hyper-V requires the Hyper-V role to be installed on
the Microsoft Windows Server 2012, 2012 R2, or 2016 system. The Hyper-V Server,
a stand-alone product that contains only the Windows hypervisor, is also
supported.
To ensure robustness and performance on a Windows Server 2012 or 2012 R2
system, it is best practice to use a VSS hardware provider rather than a software
provider.
|
|
|
|
|
|
|
You can also install Data Protection for Microsoft Hyper-V on Hyper-V hosts on
Windows Server operating systems that were installed with the Server Core option.
You can then install Data Protection for Microsoft Hyper-V Management Console
on another Windows Server or Windows 10 client to remotely manage Data
Protection for Microsoft Hyper-V. For more information, see “Installing and
configuring Data Protection for Microsoft Hyper-V on Windows Server Core
systems” on page 25.
You cannot install Data Protection for Microsoft Hyper-V on Nano Server for
Windows Server 2016. However, you can use Data Protection for Microsoft
Hyper-V on Windows Server 2016 to create crash-consistent backups of Nano
Server guest VMs.
For detailed Data Protection for Microsoft Hyper-V software and hardware
requirements, see technote 1993754.
© Copyright IBM Corp. 2011, 2017
15
Features that are installed
All features for Data Protection for Microsoft Hyper-V are part of the installation
suite.
The data mover, Data Protection for Microsoft Hyper-V Management Console, file
restore feature, PowerShell cmdlets, recovery agent, and the IBM Spectrum Protect
web server are included in a typical installation.
You do not have to install any of these features separately. For installation
instructions, see “Installing Data Protection for Microsoft Hyper-V” on page 20.
If you want to install the IBM Spectrum Protect recovery agent without first
completing a typical installation, follow the instructions in “Installing the IBM
Spectrum Protect recovery agent” on page 23.
Upgrading Data Protection for Microsoft Hyper-V
Review the tasks that you need to do before you upgrade to Data Protection for
Microsoft Hyper-V Version 8.1.4 from a previous version.
Updating nodes on the IBM Spectrum Protect server
|
|
|
|
Before you upgrade a system from Data Protection for Microsoft Hyper-V Version
8.1.2 or earlier to V8.1.4, you and the IBM Spectrum Protect server administrator
must update the nodes on the server.
|
About this task
|
|
|
The installation and configuration improvements that are introduced in Data
Protection for Microsoft Hyper-V V8.1.4 require that existing node names on the
IBM Spectrum Protect server use the new naming convention.
|
|
|
|
|
Restriction: If you use the configuration wizard to configure Data Protection for
Microsoft Hyper-V 8.1.4, you must complete the configuration before you can
restore older virtual machine (VM) backups that were created with Data Protection
for Microsoft Hyper-V V8.1.2 or earlier. Otherwise, you cannot restore older VM
backups with the Data Protection for Microsoft Hyper-V Management Console.
|
|
|
If you manually configure Data Protection for Microsoft Hyper-V and use the data
mover command line to restore VMs, the older node names are still operational
until you run the configuration wizard.
|
Procedure
|
The IBM Spectrum Protect server administrator completes the following steps:
|
|
|
1. Use the RENAME NODE server command to rename the existing Hyper-V
node name (specified by the asnodename option) to a new target node name
that conforms to the following naming convention:
|
|
v For a stand-alone Hyper-V host environment, rename the existing node to
hostname_HV_TGT.
|
v For a cluster environment, rename the existing node to clustername_HV_TGT.
|
|
For example, for a cluster with cluster node name Cluster1, the new target
node name becomes Cluster1_HV_TGT.
16
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
|
|
|
|
|
|
|
|
Restriction: You cannot use node names that do not conform to this naming
convention. When you run the Data Protection for Microsoft Hyper-V
configuration wizard, the new target node and associated data mover nodes
with the new naming conventions are automatically registered on the IBM
Spectrum Protect server. The necessary Windows services are also configured
on the local Windows host.
2. Use the UPDATE SCHEDULE server command to update existing schedules
with the following required parameters:
v Include the ACTION=BACKUP and SUBACTION=VM parameters in the
schedule definition.
v Update the option string as follows:
|
|
– For a stand-alone host: options=’-asnodename=hostname_HV_TGT
-domain.vmfull="all-vm"’
|
|
– For a cluster: options=’-asnodename=clustername_HV_TGT
-domain.vmfull="all-vm"’
|
|
|
|
|
|
For more information, see “Managing backup schedules for a host or cluster
machine” on page 63.
3. Optional: Update the node replication parameters by issuing the REPLICATE
NODE command on the IBM Spectrum Protect server:
v For a stand-alone host, replicate data on the hostname_HV_TGT node.
v For a cluster, replicate data on the clustername_HV_TGT node.
|
Complete the following tasks on a Hyper-V host:
|
|
4. Upgrade Data Protection for Microsoft Hyper-V to V8.1.4 on a stand-alone host
or on all hosts in a cluster.
|
|
For instructions, see “Installing Data Protection for Microsoft Hyper-V” on page
20.
|
|
5. Run the configuration wizard on the Hyper-V host. For clusters, run the wizard
on one of the hosts in the cluster, typically your local Windows host.
|
|
For instructions, see “Configuring Data Protection for Microsoft Hyper-V with
the wizard” on page 29.
|
|
|
6. Associate a schedule with the new target node name by using the Backup
Management window in the Data Protection for Microsoft Hyper-V
Management Console.
|
|
For instructions, see “Managing backup schedules for a host or cluster
machine” on page 63.
|
|
7. Verify your configuration by running backup and restore operations in the Data
Protection for Microsoft Hyper-V Management Console.
|
|
For instructions, see:
v “Running an ad hoc backup of a virtual machine” on page 67
|
v “Restoring a virtual machine” on page 69
|
8. Complete the following cleanup tasks after the configuration is verified:
|
|
v The IBM Spectrum Protect server administrator deletes the old data mover
nodes by using the REMOVE NODE server command.
|
|
|
v The Hyper-V administrator removes the services that were created for the
old cluster node and data mover nodes by running the dsmcutil remove
command on the stand-alone host or each host in a cluster.
|
|
For more information, see the REMove command in Dsmcutil commands:
Required options and examples.
Chapter 2. Installation of Data Protection for Microsoft Hyper-V
17
|
Results
|
You can protect your Hyper-V VMs with Data Protection for Microsoft Hyper-V.
|
|
|
|
Tips for viewing backup history: The backup history that occurred before the
node update is no longer available. However, all backups can still be restored with
the Restore wizard or the command line. After the node update, the backup
history is available for the initial and subsequent backup operations.
|
|
|
|
|
Immediately after the node update in cluster configurations, you can view and
restore VM backups only from the cluster view, not from the host view. The host
view contains only the VMs that are owned by that host node. After the node
update, the backups are not owned by the host node. After successful backups are
run, the VMs can again be backed up and restored from the host view.
|
What to do next
|
In some situations, one or both of the following tasks might need to be completed:
|
|
|
v The IBM Spectrum Protect server administrator verifies that the target node is
granted proxy authority for the data mover node by issuing the QUERY
PROXYNODE server command.
|
|
v The Hyper-V administrator restarts the client acceptor service on the Hyper-V
host.
|
|
The IBM Spectrum Protect server administrator runs the schedule so that backup
reporting can be displayed correctly for the updated nodes.
|
Related concepts:
|
|
“How IBM Spectrum Protect nodes are used in Data Protection for Microsoft
Hyper-V” on page 7
Upgrade considerations for RCT backups
Before you upgrade to Data Protection for Microsoft Hyper-V Version 8.1.2 or later,
review the considerations that apply to virtual machine (VM) backup operations
on Windows Server 2016.
v When you upgrade your Hyper-V environment from Windows Server 2012 or
2012 R2 to Windows Server 2016, the VM version of the virtual machines is not
updated automatically. The Hyper-V administrator must update the VMs to the
new version after the environment is upgraded to Windows Server 2016. Data
Protection for Microsoft Hyper-V V8.1.2 or later does not back up VMs that are
not updated to the new VM version.
Ensure that the guest VM is offline before you update the VM version. You can
update the VM version in the Hyper-V Manager or the Update-VMVersion
cmdlet.
v VM backup operations with resilient change tracking (RCT) require the Hyper-V
VM to be Version 6.2 or later.
Data Protection for Microsoft Hyper-V V8.1.0 and earlier continues to support
earlier VM versions by using the VSS backup method.
Related tasks:
“Migrating from VSS backups to RCT backups” on page 19
18
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Migrating from VSS backups to RCT backups
To take advantage of the resilient change tracking (RCT) backup feature in Data
Protection for Microsoft Hyper-V Version 8.1.2 or later, migrate your virtual
machine (VM) backup operations from the Microsoft Volume Shadow Copy Service
(VSS) to RCT.
Before you begin
v Verify that the Hyper-V VM is at Version 6.2 or later. You can determine the VM
version in the Hyper-V Manager or by running the Get-VM cmdlet.
v When you migrate your Hyper-V environment from Windows Server 2012 or
2012 R2 to Windows Server 2016, the VM version of the Hyper-V VMs is not
updated automatically. You must update the VMs to the new version before they
can be backed up by Data Protection for Microsoft Hyper-V.
Ensure that you take the guest VM offline before you update the VM version of
a VM. You can update the VM version in the Hyper-V Manager or with the
Update-VMVersion cmdlet.
Procedure
To migrate VSS backups to RCT:
1. Install and configure Data Protection for Microsoft Hyper-V V8.1.4 on the
Hyper-V host server on the Windows Server 2016 operating system.
2. Run an incremental-forever full backup operation on your VMs.
All Data Protection for Microsoft Hyper-V backup operations in the Windows
Server 2016 or later environment use RCT backups.
Results
v Because previous VSS backups do not have RCT change-tracking information, an
incremental-forever full backup is created the first time you back up a VM with
Data Protection for Microsoft Hyper-V V8.1.4.
v VSS backups are disabled after the initial backup of a VM with RCT.
v With Data Protection for Microsoft Hyper-V V8.1.4, you can still restore VMs
that were backed up on Windows Server 2016 in V8.1.0. Subsequent backups of
VMs use RCT.
Related concepts:
“Virtual machine backups with resilient change tracking (RCT)” on page 2
“Virtual machine backups with Volume Shadow Copy Service (VSS)” on page 2
|
Download and extract the installation package
|
|
Before you install Data Protection for Microsoft Hyper-V, you must download the
installation package and extract the installation files from the package.
|
Before you begin
|
|
For the most recent information, updates, and maintenance fixes, go to IBM
Spectrum Protect for Virtual Environments - IBM Support.
|
Procedure
|
|
1. Download the Data Protection for Microsoft Hyper-V package from IBM
Passport Advantage® or Fix Central.
|
2. Extract the compressed installation file that you downloaded:
Chapter 2. Installation of Data Protection for Microsoft Hyper-V
19
a. Copy the downloaded compressed installation package to a local disk or to
a network-accessible share. Be sure to extract the installation files to an
empty directory (extract_folder).
b. To extract the installation files to the same directory, double-click the
compressed installation package.
By default, the uncompressed files are stored in the current disk drive, in
the extract_folder\TSMHYPERV_WIN directory.
|
|
|
|
|
|
|
If the installation program detects files from another Data Protection for
Microsoft Hyper-V installation attempt in this directory, you are prompted
to specify whether to overwrite the old files. If you see a prompt about
overwriting files, enter (A)lways to overwrite the existing files; this selection
ensures that only the files from the current installation are used.
|
|
|
|
|
|
Results
|
|
The Data Protection for Microsoft Hyper-V installation program (spinstall.exe) is
located in the extract_folder\TSMHYPERV_WIN directory.
|
What to do next
|
Install Data Protection for Microsoft Hyper-V.
|
Installing Data Protection for Microsoft Hyper-V
|
|
Instructions are provide for a typical installation of the IBM Spectrum Protect for
Virtual Environments: Data Protection for Microsoft Hyper-V software.
|
Before you begin
|
|
If you are in a cluster environment, ensure that you install the Data Protection for
Microsoft Hyper-V package on each host in the cluster.
|
|
|
|
On each host where Data Protection for Microsoft Hyper-V is installed, ensure that
the HTTPS port that is used to communicate with Data Protection for Microsoft
Hyper-V is open in the firewall. The default port number is 9081, unless you are
using a different port..
|
|
|
If you are upgrading from Data Protection for Microsoft Hyper-V Version 8.1.2 or
earlier, complete the tasks in “Updating nodes on the IBM Spectrum Protect
server” on page 16.
|
|
Ensure that you downloaded and extracted the installation package as described in
“Download and extract the installation package” on page 19.
|
About this task
|
|
A typical installation includes all the features of Data Protection for Microsoft
Hyper-V, including the data mover and the IBM Spectrum Protect recovery agent.
|
|
To install only the IBM Spectrum Protect recovery agent, follow the instructions in
“Installing the IBM Spectrum Protect recovery agent” on page 23.
|
|
Restriction: The Data Protection for Microsoft Hyper-V installer automatically
disables the automount feature with the diskpart command on the Windows
20
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
operating system. This action is required to show correct drive letter assignments
and to hide the system reserved disk in the IBM Spectrum Protect file restore
interface.
|
|
|
|
If you do not plan to run file restore operations, or if you do not care that incorrect
drive letter assignments and the system reserved disk are displayed in the file
restore interface, you can enable the automount feature after completing the
installation.
|
Procedure
|
Complete the following steps on a single Hyper-V host or on each host in a cluster:
|
1. “Download and extract the installation package” on page 19.
|
|
2. To start the installation program, double-click the spinstall.exe file. Choose
the language for the installation process, and then click Next.
|
|
3. On the Welcome to the InstallShield Wizard for IBM Spectrum Protect for
Virtual Environments: Data Protection for Hyper-V suite page, click Next.
|
|
|
|
|
|
4. On the License Agreement page, read the terms of the license agreement. Click
I accept the terms in the license agreement and click Next. If you do not
accept the terms of the license agreement, the installation ends and you must
click Cancel to exit the installation wizard.
5. On the Change Current Destination Folder page, accept the default installation
location or specify a different installation location. Click Next.
|
|
|
6. On the Installation Type page, click Typical Installation. The installation
process begins immediately. You cannot change your selection after the
installation process begins.
|
|
|
Tip: The installation process might take several minutes to complete while the
Data Protection for Microsoft Hyper-V, JVM, data mover, web server,
framework, and recovery agent packages are being installed.
|
|
|
7. On the Install Wizard Completed page, click Finish to exit the installation
wizard. The Data Protection for Microsoft Hyper-V Management Console starts
immediately after the wizard is closed.
|
|
|
If you do not want to start the configuration wizard now, clear the Launch
Data Protection for Microsoft Hyper-V Management Console now box and
click Finish to exit the wizard.
|
Results
|
Data Protection for Microsoft Hyper-V is installed.
|
|
The following installed components appear in the Programs and Features control
panel in the Windows operating system:
|
v IBM Spectrum Protect Client
|
|
v IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V
|
|
v IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V License
|
|
v IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V suite
|
v IBM Spectrum Protect for Virtual Environments: Framework
|
v IBM Spectrum Protect for Virtual Environments: Recovery agent
Chapter 2. Installation of Data Protection for Microsoft Hyper-V
21
|
|
v IBM Spectrum Protect JVM
v IBM Spectrum Protect WebServer
|
What to do next
|
|
|
Before you attempt a backup or restore operation, or use the file restore interface,
complete the tasks in Configure Data Protection for Microsoft Hyper-V with the
wizard.
|
|
|
Before you attempt to mount the backup of a Hyper-V virtual machine disk to
restore a file, complete the tasks in “Configuring the IBM Spectrum Protect
recovery agent GUI” on page 42.
|
Installing the mount proxy feature on Linux systems
|
|
|
If you plan to run file restore operations on Linux guest virtual machines (VMs),
you must install the mount proxy feature on Linux systems by using the rpm
packages.
|
Before you begin
|
|
|
The Linux mount proxy software is the same as the Linux backup-archive client
software, but it is not included in the Data Protection for Microsoft Hyper-V
installation package. You must download the Linux client package separately.
|
You can download the appropriate package file from one of the following websites:
|
v Download the client package from Passport Advantage or Fix Central.
|
|
v For the latest information, updates, and maintenance fixes, go to the IBM
Support Portal.
|
|
|
Determine whether your storage environment uses the processor value unit (PVU)
licensing model. This decision affects the steps in the following procedure. For
more information about the model, see Verifying license compliance.
|
About this task
|
|
|
A mount proxy node is required for mount operations for the file restore interface.
The mount proxy node enables the file systems on the mounted VM disks of VM
backups to be accessible as mount points for file restore operations.
|
Procedure
|
Install the mount proxy feature by completing the following steps:
|
|
1. Download the Linux backup-archive client software to a location where you
want to store the installation files.
|
|
|
|
2. Open a command line and extract the installation package with the tar
command:
|
|
4. If the IBM Spectrum Protect API is not already installed on the system,
complete the following steps from a command line:
tar -xvf tar file name
3. Change to the bacli directory.
a. Install the 64-bit Global Security Kit (GSKit) packages:
|
|
rpm -U gskcrypt64-version.linux.x86_64.rpm gskssl64-version.linux.x86_64.rpm
22
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
where version represents the GSKit version in the file name on the
installation media.
For example, in the gskcrypt64-8.0.50.78.linux.x86_64.rpm and
gskssl64-8.0.50.78.linux.x86_64.rpm files, the version is 8.0.50.78.
b. Install the 64-bit IBM Spectrum Protect API:
rpm -ivh TIVsm-API64.x86_64.rpm
c. Optional: Install the Common Inventory Technology package that is used by
the API to support PVU calculations. This package depends on the API, so
the Common Inventory Technology package must be installed after the API
package is installed.
rpm -ivh TIVsm-APIcit.x86_64.rpm
5. Install the backup-archive client:
rpm -ivh TIVsm-BA.x86_64.rpm
6. Optional: Install the Common Inventory Technology package that the client
uses to send PVU metrics to the server. This package depends on the client
package, so the Common Inventory Technology package must be installed after
the client package is installed.
rpm -ivh TIVsm-BAcit.x86_64.rpm
|
What to do next
|
|
|
If you did not run the Data Protection for Microsoft Hyper-V configuration wizard,
run the wizard now and enable the file restore feature. For instructions, see
“Configuring Data Protection for Microsoft Hyper-V with the wizard” on page 29.
|
|
Configure the Linux mount proxy for file restore operations. For instructions, see
“Configuring the Linux mount proxy for file restore operations” on page 37.
|
Installing the IBM Spectrum Protect recovery agent
|
|
|
You can install the IBM Spectrum Protect recovery agent without first running a
typical installation. Run this installation only if you want to run in-guest mount
operations to restore files by using the recovery agent interface.
|
Before you begin
|
|
|
|
v The IBM Spectrum Protect recovery agent installation requires the system to be
restarted. Therefore, to avoid possible issues that are related to restarting the
Hyper-V host system, do not install the recovery agent on the Hyper-V host
system.
|
|
|
|
|
|
|
|
v TCP ports 22 (Secure Shell (SSH) default port) and 3260 (iSCSI default port)
must be open and available. To check the port status, open a command prompt
and issue the following commands:
|
Procedure
|
|
To install the IBM Spectrum Protect recovery agent, complete the following steps
on a virtual machine or other system that is not the Hyper-V host system:
netstat -np TCP | find "22"
netstat -np TCP | find "3260"
v Ensure that you downloaded and extracted the installation package as described
in “Download and extract the installation package” on page 19.
Chapter 2. Installation of Data Protection for Microsoft Hyper-V
23
|
|
|
|
1. To start the installation program, double-click the spinstall.exe file. Choose
the language for the installation process, and then click Next.
2. On the Welcome to the InstallShield Wizard for IBM Spectrum Protect for
Virtual Environments: Data Protection for Hyper-V suite page, click Next.
|
|
|
|
3. On the License Agreement page, read the terms of the license agreement. Click
I accept the terms in the license agreement and click Next. If you do not
accept the terms of the license agreement, the installation ends and you must
click Cancel to exit the installation wizard.
|
|
4. On the Change Current Destination Folder page, accept the default installation
location or specify a different installation location. Click Next.
|
5. On the Installation Type page, click Advanced Installation.
|
|
|
6. On the Advanced Installation page, the installation process begins immediately
after you click Install the IBM Spectrum Protect recovery agent only. You
cannot change your selection after the installation process begins.
|
|
|
Tip: The installation process might take several minutes to complete while the
Data Protection for Microsoft Hyper-V, JVM, web server, and recovery agent
packages are being installed.
|
7. Click Finish to exit the installation wizard.
|
Results
|
The IBM Spectrum Protect recovery agent is installed.
|
|
The following installed components are shown in the Programs and Features
control panel in the Windows operating system:
|
|
v IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V
|
|
v IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V License
|
|
v IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft
Hyper-V suite
|
v IBM Spectrum Protect for Virtual Environments: Recovery agent
|
v IBM Spectrum Protect JVM
|
v IBM Spectrum Protect WebServer
|
What to do next
|
|
|
Before you mount the backup of a Hyper-V virtual machine disk to restore a file,
complete the tasks in “Configuring the IBM Spectrum Protect recovery agent GUI”
on page 42.
Installing in silent mode
You can install all IBM Spectrum Protect for Virtual Environments: Data Protection
for Microsoft Hyper-V and data mover features silently on a single system.
Before you begin
Ensure that you downloaded and extracted the installation package as described in
“Download and extract the installation package” on page 19.
24
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
About this task
Restriction: All features are installed to their default location. You cannot silently
install IBM Spectrum Protect for Virtual Environments: Data Protection for
Microsoft Hyper-V and data mover features to a non-default location.
Procedure
1. From a command prompt, issue the following command:
cd extract folder\TSMHYPERV_WIN
|
2. Enter the following command:
|
|
|
spinstall.exe /silent
The following message is displayed the first time that you mount a volume:
|
|
|
|
|
|
|
|
|
The Virtual Volume Driver is not yet registered. Recovery Agent can register
the driver now. During registration, a Microsoft Windows Logo warning may be displayed.
Accept this warning to allow the registration to complete.
Do you want to register the Virtual Volume Driver now?
To proceed with the IBM Spectrum Protect recovery agent operations, enter Yes
to register the Virtual Volume Driver.
3.
|
|
Installing and configuring Data Protection for Microsoft Hyper-V on
Windows Server Core systems
|
|
|
You can install and configure Data Protection for Microsoft Hyper-V on Hyper-V
hosts on Windows Server operating systems that were installed with the Server
Core option.
|
Before you begin
|
|
|
|
On each host where Data Protection for Microsoft Hyper-V is installed, ensure that
the HTTPS port that is used to communicate with Data Protection for Microsoft
Hyper-V is open in the firewall. The default port number is 9081, unless you are
using a different port.
|
About this task
|
|
|
Because local user interfaces are not supported on Server Core, you must install
Data Protection for Microsoft Hyper-V silently on a stand-alone host or on each
host in a cluster.
|
|
|
You must manage Data Protection for Microsoft Hyper-V by using the Data
Protection for Microsoft Hyper-V Management Console from another deployment
and pointing it to a stand-alone host or a host in a cluster.
|
|
|
Procedure
|
1. Run a silent installation of Data Protection for Microsoft Hyper-V on a
stand-alone host or on all hosts in a cluster.
For instructions, see “Installing in silent mode” on page 24.
Chapter 2. Installation of Data Protection for Microsoft Hyper-V
25
2. To manage Data Protection for Microsoft Hyper-V remotely, you must
separately install the Data Protection for Microsoft Hyper-V Management
Console on another Windows Server or Windows 10 operating system.
a. “Download and extract the installation package” on page 19.
|
|
|
|
|
|
|
|
|
|
|
|
|
b. Change to the directory where you extracted the installation package. For
example:
|
|
|
e. Start the Data Protection for Microsoft Hyper-V Management Console by
clicking Start > IBM Spectrum Protect > DP for Hyper-V Management
Console.
|
|
|
|
|
Alternatively, issue the following command at the command prompt:
f. In the Connect to Data Protection for Hyper-V window, enter the host name
and credentials of the stand-alone host or host in the cluster that you want
to manage.
|
g. Configure Data Protection for Microsoft Hyper-V with the wizard.
cd extract_folder
c. Install the Data Protection for Microsoft Hyper-V Management Console and
the Data Protection for Microsoft Hyper-V license by issuing the following
command in the installation folder:
TSMHYPERV_WIN\hyperv\spinstall.exe
d. Follow the prompts in the installation wizard and click Finish when the
installation is completed.
"C:\Program Files\IBM\SpectrumProtect\DPHyperV\DpHv.msc"
|
Results
|
|
|
|
You can use the Data Protection for Microsoft Hyper-V Management Console to
remotely manage daily operations of Data Protection for Microsoft Hyper-V in a
stand-alone host or cluster on an operating system that was installed with the
Server Core option.
|
What to do next
|
|
|
You can also specify the preferred host to log in to by using the
Set-DpHvMmcLoginPreferences cmdlet. For more information, see Chapter 6,
“Protecting virtual machines by using Windows PowerShell cmdlets,” on page 79.
|
Related concepts:
|
|
Chapter 4, “Managing data with the Data Protection for Microsoft Hyper-V
Management Console,” on page 55
|
Related tasks:
|
|
“Configuring non-default port numbers for Data Protection for Microsoft Hyper-V
operations” on page 51
26
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Uninstalling Data Protection for Microsoft Hyper-V
The process for uninstalling IBM Spectrum Protect for Virtual Environments: Data
Protection for Microsoft Hyper-V is the same for a new installation and for an
upgraded version.
Before you begin
|
|
|
|
|
|
Restriction: You can uninstall the IBM Spectrum Protect recovery agent as part of
the uninstallation for the IBM Spectrum Protect for Virtual Environments: Data
Protection for Microsoft Hyper-V suite, or you can uninstall the recovery agent
separately. You must unmount all virtual volumes before uninstalling the IBM
Spectrum Protect recovery agent. Otherwise, these mounted virtual volumes cannot
be unmounted when you reinstall the recovery agent the next time.
Procedure
|
1. Open the Control Panel and click Uninstall a program.
|
|
2. Uninstall the IBM Spectrum Protect for Virtual Environments: Data Protection
for Microsoft Hyper-V suite:
|
|
|
a. On the Uninstall or change a program page, select IBM Spectrum Protect
for Virtual Environments: Data Protection for Microsoft Hyper-V suite
and click Uninstall.
|
b. In the Remove the Program page of the InstallShield Wizard, click Remove.
|
|
|
|
|
|
|
|
|
|
Tip: The uninstallation process might take several minutes to complete.
c. Click Finish in the InstallShield Wizard Completed page when the
uninstallation is completed. Click the Refresh icon to refresh the list of
programs.
3. Uninstall the Data Protection for Microsoft Hyper-V license:
a. On the Uninstall or change a program page, select IBM Spectrum Protect
for Virtual Environments: Data Protection for Microsoft Hyper-V License
and click Uninstall.
b. Click Yes when prompted.
4. Uninstall the IBM Spectrum Protect web server:
|
|
a. On the Uninstall or change a program page, select IBM Spectrum Protect
Web Server and click Uninstall.
|
b. Click Yes when prompted.
|
5. Uninstall the IBM Spectrum Protect Java™ Virtual Machine (JVM):
|
|
a. On the Uninstall or change a program page, select IBM Spectrum Protect
JVM and click Uninstall.
|
b. Click Yes when prompted.
What to do next
You must remove the file restore feature separately. For more information, see
“Removing the file restore feature” on page 28.
Chapter 2. Installation of Data Protection for Microsoft Hyper-V
27
|
Removing the file restore feature
|
|
|
|
If you no longer want to run file restore operations, you can remove the file restore
feature by updating a configuration file. If you uninstall Data Protection for
Microsoft Hyper-V, you must update the same configuration file to remove the file
restore feature.
|
About this task
|
|
|
To remove the services that are related to the file restore feature, you must update
the frConfig.props file and remove the services that are related to the mount
proxy nodes.
|
Procedure
|
|
|
1. Manually edit the C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\
tsmVmGUI\frConfig.props file by changing the following option:
enable_filerestore=true
Change the option as shown:
|
|
|
|
|
|
2. Open the Services control panel in the Windows operating system and remove
the services that are related to the mount proxy node. Typically, the services are
called TSM CAD - hostname_HV_MP_platform and TSM Agent hostname_HV_MP_platform.
|
|
3. Remove the mount proxy nodes on the IBM Spectrum Protect server with the
REMOVE NODE command.
|
Results
|
|
|
The file restore feature is removed. You do not have to restart the IBM Spectrum
Protect for Virtual Environments Derby Database or IBM Spectrum Protect Web
Server services.
enable_filerestore=false
28
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
After successfully installing the IBM Spectrum Protect for Virtual Environments:
Data Protection for Microsoft Hyper-V software, you must configure the Data
Protection for Microsoft Hyper-V before performing any backup and restore
operations. If you want to run mount operations on guest VMs with the IBM
Spectrum Protect recovery agent, you must also configure the recovery agent.
|
Configuring Data Protection for Microsoft Hyper-V with the wizard
|
|
|
|
You can use the configuration wizard for the initial configuration or to update the
configuration of Data Protection for Microsoft Hyper-V for a stand-alone Hyper-V
host or a cluster environment. You can also use the wizard to enable Data
Protection for Microsoft Hyper-V for file restore operations.
|
Before you begin
|
|
|
|
v If you are upgrading from Data Protection for Microsoft Hyper-V Version 8.1.2
or earlier and have nodes that are already defined on the IBM Spectrum Protect
server, complete the tasks in “Updating nodes on the IBM Spectrum Protect
server” on page 16.
|
|
|
v The Hyper-V host where Data Protection for Microsoft Hyper-V is installed must
have network connectivity to the IBM Spectrum Protect server that is used to
store virtual machine (VM) backups.
|
|
v To help improve performance, use at least a 10 Gb connection between the
Hyper-V hosts and the IBM Spectrum Protect server.
|
|
v You must have the login credentials for the IBM Spectrum Protect server
administrator account.
|
|
|
v You must connect to a secure IBM Spectrum Protect server that uses Secure
Sockets Layer (SSL) communications. A security certificate is downloaded
automatically when you are completing the configuration wizard.
|
|
|
|
|
v In a cluster environment, ensure that you install the Data Protection for
Microsoft Hyper-V package on each host in the cluster. After you install the
packages on all the hosts, run the installation wizard on one of the hosts in the
cluster. The configuration wizard will connect to each host to complete the
configuration.
|
|
|
|
|
|
|
|
|
|
Any node that does not have the Data Protection for Microsoft Hyper-V
software installed is omitted from the cluster configuration, and does not affect
the configuration of any other nodes where the software is installed. If you add
a node to the cluster later, install Data Protection for Microsoft Hyper-V on that
node and run the configuration wizard for that node (locally or from any other
nodes in the cluster).
v On each host where Data Protection for Microsoft Hyper-V is installed, ensure
that the HTTPS port that is used to communicate with Data Protection for
Microsoft Hyper-V is open in the firewall. The default port number is 9081,
unless you are using a different port.
|
About this task
|
|
To simplify the configuration, the configuration wizard automatically creates the
nodes that are required for backup, restore, and optionally file restore operations.
© Copyright IBM Corp. 2011, 2017
29
|
|
The configuration wizard also registers the nodes on the IBM Spectrum Protect
server and configures the services on the local Windows host.
|
|
|
For more information about the types of nodes that are used for Data Protection
for Microsoft Hyper-V, see “How IBM Spectrum Protect nodes are used in Data
Protection for Microsoft Hyper-V” on page 7.
|
|
Restriction: The configuration wizard determines the node names to use based on
the host or cluster name. You cannot specify custom node names.
|
Procedure
|
|
|
To configure Data Protection for Microsoft Hyper-V, complete the following steps
on the Hyper-V host. For a cluster environment, complete the following steps on
any host in the cluster where Data Protection for Microsoft Hyper-V is installed.
|
|
|
1. Start the Data Protection for Microsoft Hyper-V Management Console by
clicking Start > IBM Spectrum Protect > DP for Hyper-V Management
Console.
|
|
|
|
|
Alternatively, issue the following command at the command prompt:
2. When prompted, log on to the Data Protection for Microsoft Hyper-V
Management Console. Enter the same credentials that you use to log on to the
Hyper-V host.
|
|
The account that you use must be a member of the local administrators group
on the machine so that Hyper-V and cluster operations can be completed.
"C:\Program Files\IBM\SpectrumProtect\DPHyperV\DpHv.msc"
3. If you are configuring Data Protection for Microsoft Hyper-V Management
Console for the first time, the configuration wizard opens automatically.
|
|
|
|
|
|
If you are changing the existing configuration in a stand-alone host
environment, click a host in the navigation pane, and click Configure in the
actions pane. In a cluster environment, click select a cluster node in the
navigation pane, and click Configure.
|
4. Complete each page of the wizard and click Next to advance to the next page.
||
Page
Action
|
Before you Begin
Click Next to start the wizard.
30
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Page
Action
|
|
|
Backup Server
Enter information about the IBM Spectrum
Protect server that is used to store VM
backups.
|
|
|
Backup server address
The host name or IP address of the
IBM Spectrum Protect server.
|
|
|
|
|
|
|
|
|
Backup server SSL port
Specify the port number for the
server port that allows
administrative connections by using
the SSL protocol with TLS 1.2
enabled. The default port number is
provided. Accept the default port
number unless your server is
configured to use a different port.
|
|
|
|
|
|
|
Administrative credentials
The user name and password of the
IBM Spectrum Protect server
administrator. The administrator
must have system privilege, and be
able to register client nodes on the
server.
|
|
|
|
|
|
|
|
|
|
|
|
Accept Certificate
This window appears only if you are
connecting to the IBM Spectrum Protect
server for the first time, or if the existing
security certificate is no longer valid. Click
Accept to download and import the
certificate automatically.
If you are connecting to the V8.1.1 or earlier
V8 server, or V7.1.7 or earlier server, and the
download process fails, see “Configuring
security settings to connect to IBM Spectrum
Protect server V8.1.1 or earlier or V7.1.7 or
earlier” on page 34.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
31
|
Page
Action
|
Cluster and Host Configuration
The following options are available:
|
|
|
|
|
|
|
|
|
Policy domain
Select a policy domain from the list.
The policy domain contains rules
that determine how long VM
backups are kept on the IBM
Spectrum Protect server and how
many versions of the VM backup
are retained. The default policy
domain is STANDARD.
|
|
|
|
|
|
|
|
Target node name
Displays the node name where VM
backups are stored on the IBM
Spectrum Protect server. For
clusters, all VM backups are stored
under the target node, regardless of
which node in the cluster is
running the backup.
|
|
|
|
|
|
Node Definitions
Displays the node definitions for
the stand-alone host or hosts in the
cluster. For information about the
types of nodes, see Table 2 on page
8.
|
|
|
|
|
|
|
|
Enable File Restore
If you want to use the file restore
web interface to restore individual
files from a VM backup, check this
box. When you select this check
box, the mount proxy node pair for
each host is automatically added to
the list.
|
|
|
|
|
|
|
|
This node pair represents the Linux
and Windows proxy systems that
access the mounted VM disks
through an iSCSI connection. These
nodes enable the file systems on the
mounted VM disks to be accessible
as mount points for file restore
operations.
|
|
|
During the initial configuration,
Enable File Restore is checked by
default.
|
|
|
File Restore Settings
Click this button to enter the file
restore administrator credentials.
|
|
|
|
|
File Restore Settings
This window appears only if you enabled
the file restore feature. Enter the file restore
administrator credentials. The account must
be a Windows domain user account with
local administrative authority over all VMs.
|
|
Summary
Review the settings and click Next to
complete the configuration.
32
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Page
Action
|
|
|
|
Results
The results of the configuration are
displayed. If the configuration did not
succeed, a list of errors is displayed. Correct
the errors and run the configuration again.
|
|
|
|
|
|
If the file restore feature is successfully
configured, information about the host,
Linux mount proxy, and file restore URLs
are displayed in the file restore results table.
You can click Copy to copy all the
information to the clipboard.
|
|
|
|
|
You must complete the file restore
configuration by following the instructions
in “Enabling the environment for file restore
operations” on page 35.
|
Results
|
|
|
Upon successful completion of the wizard, you can run backup and restore
operations by using the command prompt, PowerShell cmdlets, or the Data
Protection for Microsoft Hyper-V Management Console.
|
|
For your convenience, you can also open the file restore interface by clicking File
Restore in the Actions pane.
|
What to do next
|
|
|
You can also specify the preferred host to log in to by using the
Set-DpHvMmcLoginPreferences cmdlet. For more information, see Chapter 6,
“Protecting virtual machines by using Windows PowerShell cmdlets,” on page 79.
|
Related tasks:
|
|
“Configuring non-default port numbers for Data Protection for Microsoft Hyper-V
operations” on page 51
|
Configuring security settings for Data Protection for Microsoft Hyper-V
|
|
The settings that are required to securely connect to the IBM Spectrum Protect
server depend on the server version that you are connecting to.
|
About this task
|
|
|
|
|
|
IBM Spectrum Protect Version 8.1.2 or later and V7.1.8 servers provide an
improved security protocol that uses Transport Layer Security (TLS) 1.2 to encrypt
all communication between the server and clients. Data Protection for Microsoft
Hyper-V and the server are automatically configured to communicate with each
other by using the Secure Sockets Layer (SSL) protocol. Certificates are distributed
automatically.
|
|
|
|
When you use the configuration wizard to configure Data Protection for Microsoft
Hyper-V, you are prompted to accept the security certificate. No manual steps are
required to obtain and import the certificate. For more information, see
“Configuring Data Protection for Microsoft Hyper-V with the wizard” on page 29.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
33
If you are connecting to earlier versions of IBM Spectrum Protect servers and the
automatic download process of the certificate fails, you must manually download
and import the security certificate before running the configuration wizard. For
more information, see “Configuring security settings to connect to IBM Spectrum
Protect server V8.1.1 or earlier or V7.1.7 or earlier.”
|
|
|
|
|
Configuring security settings to connect to IBM Spectrum
Protect server V8.1.1 or earlier or V7.1.7 or earlier
|
|
|
|
|
You can enable Data Protection for Microsoft Hyper-V to communicate with IBM
Spectrum Protect server Version 8.1.1 or earlier or V7.1.7 or earlier with the
Transport Layer Security (TLS) protocol.
|
About this task
|
|
|
|
If the server is configured to use SSL with TLS 1.2 enabled, a truststore with a
certificate is created automatically by accepting the security certificate from the
configuration wizard. However, if the automatic download process fails, you must
manually create the truststore and run the configuration wizard again.
|
|
The following procedure uses the Java key and certificate management tool
keytool.
|
|
|
This tool is in the C:\Program Files\Common Files\Tivoli\TSM\jvm80406\jre\bin
directory. This location is subject to change based on the version of Java software
that you are using.
|
Procedure
|
|
Complete the following steps on the stand-alone Hyper-V host. In a cluster
environment, complete the following steps for each host in the cluster.
|
|
|
1. Obtain the necessary certificate from the IBM Spectrum Protect server
administrator and download it to a location on your host, for example, the
c:\cert directory.
|
|
2. From the command prompt, change to the truststore directory by issuing the
following command:
|
|
cd C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\tsmVmGUI\
truststores
|
If this folder does not exist, create it.
3. Import the certificate with the following command:
|
|
|
|
"C:\Program Files\Common Files\Tivoli\TSM\jvm80406\jre\bin\keytool.exe"
-importcert -alias my-cert -file "cert-filename" -keystore
tsm-ve-truststore.jks -storepass password
|
where:
|
|
-alias my-cert
The unique alias that identifies the certificate in the truststore.
|
|
|
-file "cert-filename"
The name of the file that contains the server self-signed certificate or
the CA root certificate. For example, "C:\cert\cert256.arm".
|
|
|
-storepass password
The keystore password. Ensure that you remember this password for
future use.
4. Start the Data Protection for Microsoft Hyper-V Management Console.
|
34
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
|
|
|
|
For instructions, see “Starting the Data Protection for Microsoft Hyper-V
Management Console” on page 55.
5. Click Configure to open the configuration wizard.
6. On the Backup Server page, specify the port number in the Backup server SSL
port field. This port is the server port that allows administrative connections by
using SSL with TLS 1.2 enabled.
7. Complete the wizard.
|
Results
|
|
|
Upon successful completion of the wizard, you can run backup and restore
operations by using the command prompt, PowerShell cmdlets, or the Data
Protection for Microsoft Hyper-V Management Console.
|
Enabling the environment for file restore operations
|
|
When the file restore feature is enabled by an administrator, file owners can restore
files with minimal assistance.
|
About this task
|
|
|
When you enable the file restore feature with the configuration wizard, the
software that is needed for file restore operations is installed on the data mover
node on a stand-alone Hyper-V host or on each host in a cluster.
|
|
|
|
In a cluster environment, the file restore software on each host in the cluster is
independent of each other. In order for the file owner to be able to log on to the
file restore interface, the host name and the virtual machine (VM) name that
contains the file owner's data are required in the file restore URL.
|
Procedure
|
|
1. To start the configuration wizard, select a host or cluster from the navigation
pane and click Configure.
|
|
|
2. Follow the instructions on each page of the wizard. For instructions, see
“Configuring Data Protection for Microsoft Hyper-V with the wizard” on page
29.
|
|
a. When you reach the Cluster and Host Configuration page, check the Enable
File Restore check box.
|
|
|
|
b. If you are enabling file restore for the first time, you are prompted to enter
the file restore administrator credentials. The administrator account must be
a Windows domain user account with local administrative authority over all
VMs.
|
|
|
|
3. Optional: If you plan to run file restore operations on Linux guest VMs, click
Copy in the file restore results table in the Results page to copy the file restore
URL and Linux mount proxy options to the clipboard. You can paste the mount
proxy options to the dsm.sys file when you configure the Linux mount proxy.
|
|
You can also obtain this file restore information at any time after the
configuration by clicking Properties in the Actions pane.
|
|
For more information about configuring the Linux mount proxy, see
“Configuring the Linux mount proxy for file restore operations” on page 37.
|
4. Complete the configuration in the wizard.
|
|
5. Verify that you can access the file restore interface by selecting a VM from the
Results pane and clicking File Restore in the Actions pane.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
35
6. Construct the custom URL for each file owner based on the following template
for the file restore URL:
https://<dphvhost>:9081/FileRestoreUI/login?vmName=<guestvm_name>
&vmHost=<guestvm_host>&vmPlatform=<guestvm_platform>
|
|
|
|
|
where:
|
|
|
dphvhost
The Hyper-V host where you installed and configured Data Protection for
Microsoft Hyper-V.
|
|
guestvm_name
The name of the guest VM that contains data for the file owner.
|
|
|
guestvm_host
The name of the VM host that is hosting the guest VM. The value for the
guestvm_host can be the computer name, IP address, or DNS name.
|
|
|
guestvm_platform
The operating system of the guest VM. Specify one of the following values:
LINUX or WINDOWS.
|
|
|
For example, if Data Protection for Microsoft Hyper-V is installed on a Hyper-V
host called Cluster1, and the file owner's data is on a Windows guest VM
called MyVM-Win2k26 on VM host HostB, the file restore URL is as follows:
|
|
https://Cluster1:9081/FileRestoreUI/login?vmName=MyVM-Win2k16
&vmHost=HostB&vmPlatform=WINDOWS
|
|
|
Fast path: You can also obtain the file restore URL by selecting a host, a VM,
and clicking File Restore in the Actions pane. You can copy the URL address
that is displayed in the web browser.
Tip: If you are using a non-default port number, replace port 9081 with the
port that you configured. To show what port numbers that are being used, see
“Configuring non-default port numbers for Data Protection for Microsoft
Hyper-V operations” on page 51.
7. Distribute the file restore URL depending on the following scenarios:
|
|
|
|
|
|
|
v For the help desk model, the Hyper-V or file restore administrator sends a
custom URL to each file owner.
|
|
|
|
v For the self-service model, the Hyper-V or file restore administrator sends
instructions to file owners so they can construct their own file restore URLs.
You can use the information about the URL from Step 6 in your instructions
to file owners.
|
|
|
|
Tip: VMs can fail over to different hosts in a cluster at any time. In this
situation, you must send a new URL with the updated guest VM to the file
owner, or the file owner must contact you to determine which host is hosting
the VM.
|
Results
|
|
File owners are able to log in to the file restore interface to restore individual files
and folders.
36
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Configuring the Linux mount proxy for file restore operations
|
|
To prepare a Linux guest virtual machine (VM) for file restore operations, you
must configure the Linux mount proxy.
|
Before you begin
|
Ensure that you completed the following tasks:
|
|
|
1. Run the Data Protection for Microsoft Hyper-V configuration wizard and
enable the file restore feature. For instructions, see “Configuring Data
Protection for Microsoft Hyper-V with the wizard” on page 29.
|
|
2. Install the mount proxy on a Linux system. For instructions, see “Installing the
mount proxy feature on Linux systems” on page 22.
|
About this task
|
|
|
|
|
|
When you enable the file store feature with the configuration wizard, the mount
proxy node pair for a stand-alone host or for each host in a cluster is automatically
registered with the IBM Spectrum Protect server, along with the definition of proxy
relationships. To enable the guest VM for file restore operations, you must
configure the Linux mount proxy by adding the Linux mount proxy options that
are provided by the configuration wizard to the dsm.sys file.
|
|
The following procedure sets up the mount proxy node by updating the mount
proxy node options and verifying connectivity to the IBM Spectrum Protect server.
|
Procedure
|
Complete the following steps on the Linux mount proxy system:
|
|
1. If the client-user options file (dsm.opt) is not in the installation directory
(opt/tivoli/tsm/client/ba/bin), create the file with a text editor.
|
|
|
2. Open the dsm.opt file with a text editor and add the following statement to the
file:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
servername MPNODE_hostname_HV_MP_LNX
where hostname is the host name of the Linux mount proxy system.
Ensure that this statement is the only statement in the file. Save your updates
and close the file.
3. Open the dsm.sys file with a text editor. Copy the mount proxy options from
the Linux Mount Proxy Options window of the configuration wizard and paste
them into the file.
For example, paste the following stanza to the dsm.sys file:
SERVERNAME
NODename
PASSWORDAccess
TCPServeraddress
TCPPort
HTTPPort
COMMMethod
ERRORLOGName
MPNODE_hostname_HV_MP_LNX
hostname_HV_MP_LNX
generate
backup_server_addess
1500
1581 ** Must be unique for each node
tcpip
dsmerror.hostname_HV_MP_LNX.log
|
|
|
where hostname is the host name of the Linux mount proxy system and
backup_server_address is the host name or IP address of the IBM Spectrum
Protect server where VMs are backed up.
|
Save your changes and close the dsm.sys file.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
37
|
|
|
4. Start a command-line session on the mount proxy system with the -asnodename
and -optfile command-line parameters:
|
|
|
|
where hyperv_target_node is the Hyper-V node name under which your VM
backups are stored. The Hyper-V target node has the following naming
convention:
v For a stand-alone host environment: hostname_HV_TGT
|
v For a cluster environment: clustername_HV_TGT
|
|
During the initial sign-on, you are prompted for a user ID and password. Enter
your IBM Spectrum Protect server administrator ID and password.
|
|
After the initial sign-on, a new password is generated and stored so that you
will not be prompted for the password again.
|
|
|
To ensure that you are not prompted for the password, run the dsmc command
again. If you are prompted for the password, ensure that the passwordaccess
generate option is set in the dsm.sys file, and repeat Step 4 again.
dsmc -asnodename=hyperv_target_node -optfile=dsm.opt
|
|
|
5. Verify the connection to the IBM Spectrum Protect server by issuing the
following command:
|
|
|
|
This command shows information about your session, including the current
node name, the session start time, server information, and server connection
information.
6. Set up the client acceptor service (CAD) by taking the following actions:
|
|
|
|
|
a. Set the following environment variable in the /etc/init.d/dsmcad file:
dsmc query session
export LD_LIBRARY_PATH=/opt/tivoli/tsm/client/ba/bin
b. The installation program creates a startup script for the client acceptor
(dsmcad) in the /etc/init.d directory. The client acceptor must be started
before it can manage scheduler tasks.
|
|
|
|
Ensure that you are logged in with the root user ID, and then use the
following command to start the client acceptor:
|
|
|
To enable the client acceptor to start automatically after a system restart,
add the service as follows, at a shell prompt:
export LD_LIBRARY_PATH=/opt/tivoli/tsm/client/ba/bin
service dsmcad start
# chkconfig --add dsmcad
|
What to do next
|
Verify that the Linux mount proxy node is set up correctly:
|
|
1. Start the Data Protection for Microsoft Hyper-V Management Console on the
Hyper-V host or cluster.
|
|
2. Select a Linux VM, and click File Restore in the Actions pane to go to the file
restore interface.
|
3. Verify that you can run file restore operations for the Linux guest VM.
|
38
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Modifying options for file restore operations
|
|
To allow administrators to configure and control file restore operations, modify the
options in the frConfig.props file.
|
About this task
|
|
Complete these steps on the system where the Data Protection for Microsoft
Hyper-V Management Console is installed.
|
Procedure
|
|
|
|
|
|
1. Go to the directory where the frConfig.props file is located. For example, open
a command prompt and issue the following command:
|
3. Save your changes and close the frConfig.props file.
|
Results
|
Modified options are applied to the IBM Spectrum Protect file restore interface.
|
cd C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\tsmVmGUI
2. Open the frConfig.props file with a text editor in administrator mode and
modify the options as needed. To determine which options to modify, see
“Options for file restore operations” .
Options for file restore operations
|
|
The options in the frConfig.props file control configuration, support, and restore
processing for file restore operations.
|
|
|
|
|
backup_info_duration_hours=num_hrs
Specify the amount of time, in hours, that information about recent backup
activity is retained in the local Data Protection for Microsoft Hyper-V Derby
database. The maximum value is 14 days (336 hours). The default value is one
week (168 hours).
|
|
|
enable_contact_info=false | true
Specify whether to provide administrator contact information that file owners
can use to obtain support in the IBM Spectrum Protect file restore interface.
|
|
|
false
File owners do not receive administrator contact information. This value is
the default.
|
|
true
File owners receive administrator contact information.
|
|
If you specify enable_contact_info=true, you must provide information in the
contact_info option.
|
|
|
enable_filerestore=false | true
Specify whether file owners can restore their files from a virtual machine with
the IBM Spectrum Protect file restore interface.
|
|
|
false
File owners cannot restore their files with the IBM Spectrum Protect file
restore interface. This value is the default.
|
|
|
true
File owners can restore their files with the IBM Spectrum Protect file
restore interface.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
39
|
|
|
|
maximum_mount_points=num_mount_points
Specify the maximum number of simultaneous recovery points that are
available to the user account. The minimum value is 1 recovery point. The
maximum value is 256 mount points. The default value is 2 mount points.
|
|
Tip: To prevent a virtual machine from being mounted multiple times for
simultaneous restore operations, set this option with a low value.
mount_session_timeout_minutes=num_mins
Specify the amount of time, in minutes, that a restore and the mounted
recovery point can be idle before the session is canceled. A cancellation
unmounts the recovery point. The maximum value is 8 hours (480 minutes).
The default value is 30 minutes.
|
|
|
|
|
|
|
Tip: To prevent the session from being canceled unexpectedly, increase the
number of minutes.
|
|
|
|
|
|
|
restore_info_duration_hours=num_hrs
Specify the amount of time, in hours, that information about recent restore
activity is retained for the IBM Spectrum Protect file restore interface. Use the
restore activity window to view error information and recently completed
tasks. This information provides a way to locate recently restored files. The
maximum value is 14 days (336 hours). The default value is one week (168
hours).
|
|
|
|
contact_info=administrator information
Provide administrator contact information that file owners can use to obtain
support. Contact information displays in the IBM Spectrum Protect file restore
interface in the following locations:
|
v Login window
|
v The About pane in the help menu
|
v The support information link in interface messages
They Data Protection for Microsoft Hyper-V Management Console wizard can
overwrite the enable_filerestore option, but only to the true value. You must
manually set the option to false if you want to disable the file restore feature.
|
|
|
|
Configuring Data Protection for Microsoft Hyper-V log activity
|
|
|
To allow administrators to configure and control how content is formatted and
logged for Data Protection for Microsoft Hyper-V Management Console and file
restore operations, modify the options in the FRLog.config file.
|
Before you begin
|
|
The FRLog.config file is generated the first time that the Data Protection for
Microsoft Hyper-V Management Console or file restore interface is accessed.
|
About this task
|
|
Complete these steps on the system where the Data Protection for Microsoft
Hyper-V Management Console is installed.
|
|
|
Procedure
1. Go to the directory where the FRLog.config file is located. Open a command
prompt and issue the following command:
40
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
|
2. Open the FRLog.config file with a text editor in administrator mode and
modify the options as needed. To determine which options to modify, see “Data
Protection for Microsoft Hyper-V log activity options.”
|
|
|
|
3. Save your changes and close the FRLog.config file.
4. Restart the GUI web server:
a. Click Start > Control Panel > System and Security > Administrative Tools
> Services.
|
|
b. Right-click IBM Spectrum Protect for Virtual Environments Web Server
and click Restart.
cd C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\frGUI
|
Results
|
|
Settings are applied to the content and format of logging information for Data
Protection for Microsoft Hyper-V Management Console and file restore operations.
|
Data Protection for Microsoft Hyper-V log activity options
|
|
|
The FRLog.config options control the content and format of logging information
for Data Protection for Microsoft Hyper-V Management Console and file restore
operations.
|
|
The following options log information for Data Protection for Microsoft Hyper-V
Management Console and file restore tasks in the fr_gui.log file:
|
|
|
MAX_LOG_FILES=number
Specify the maximum number of fr_gui.log files to retain. The default value
is 8.
|
|
|
MAX_LOG_FILE_SIZE=number
Specify the maximum size of the fr_gui.log file in KBs. The default value is
8192 KB.
|
|
|
|
The following options log information for Data Protection for Microsoft Hyper-V
Management Console and file restore services in the fr_api.log file. These services
are internal API services that are related to Data Protection for Microsoft Hyper-V
Management Console and file restore activity:
|
|
|
API_MAX_LOG_FILES=number
Specify the maximum number of fr_api.log files to retain. The default value
is 8.
|
|
|
API_MAX_LOG_FILE_SIZE=number
Specify the maximum size of the fr_api.log file in KBs. The default value is
8192 KB.
|
|
API_LOG_FILE_NAME=API_log_file_name
Specify the name of the API log file. The default value is fr_api.log.
|
|
|
|
API_LOG_FILE_LOCATION=API_log_file_name
Specify the location of the API log file. The location must be specified with a
forward slash (/). The default location is install_directory/IBM/
SpectrumProtect/webserver/usr/servers/veProfile/logs.
|
|
|
|
FR.API.LOG=ON | OFF
Specify whether to enable logging for Data Protection for Microsoft Hyper-V
Management Console and file restore services.
v To enable logging, specify ON. The default value is ON.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
41
v To disable logging, specify OFF.
|
|
Configuring the IBM Spectrum Protect recovery agent GUI
You must set up the IBM Spectrum Protect recovery agent GUI for mount and file
restore operations.
Before you begin
These configuration tasks must be completed before you use the IBM Spectrum
Protect recovery agent GUI.
Procedure
1. Log on to the system where you want to restore files. The IBM Spectrum
Protect recovery agent must be installed on the system.
2. Click Select IBM Spectrum Protect server in the IBM Spectrum Protect
recovery agent GUI to connect to the IBM Spectrum Protect server.
Specify the following options:
Server address
Enter the IP address or host name of the IBM Spectrum Protectserver.
Server port
Enter the port number that is used for TCP/IP communication with the
server. The default port number is 1500.
Node access method:
Asnodename
Select this option to use a proxy node to access the virtual machine
backups that are in the target node. The proxy node is a node that is
granted "proxy" authority to perform operations on behalf of the target
node.
Typically, you use the grant proxynode command to create the proxy
relationship between two existing nodes.
If you select this option, complete the following steps:
a. Enter the name of the target node (the node where the virtual
machine backups are located) in the Target Node field.
b. Enter the name of the proxy node in the Authentication node field.
c. Enter the password for the proxy node in the Password field.
d. Click OK to save these settings and exit the IBM Spectrum
Protectpage.
When you use this method, the IBM Spectrum Protect recovery agent
user knows only the proxy node password, and the target node
password is protected.
Fromnode
Select this option to use a node with access limited only to the snapshot
data of specific virtual machines in the target node.
Typically, this node is given access from the target node that owns the
virtual machine backups by using the set access command:
set access backup -TYPE=VM vmdisplayname mountnodename
For example, this command gives the node named myMountNode the
authority to restore files from the virtual machine named myTestVM:
42
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
set access backup -TYPE=VM myTestVM myMountNode
If you select this option, complete the following steps:
a. Enter the name of the target node (the node where the virtual
machine backups are located) in the Target Node field.
b. Enter the name of the node that is given limited access in the
Authentication node field.
c. Enter the password for the node that is given limited access in the
Password field.
d. Click OK to save these settings and exit the IBM Spectrum Protect
page.
When you use this method, you can see a complete list of backed-up
virtual machines. However, you can restore only those virtual machine
backups to which the node was granted access. In addition, the
snapshot data is not protected from expiration on the server.
Direct Select this option to authenticate directly to the target node (the node
where the virtual machine backups are located).
If you select this option, complete the following steps:
a. Enter the name of the target node (the node where the virtual
machine backups are located) in the Authentication node field.
b. Enter the password for the target node in the Password field.
c. Click OK to save these settings and exit the IBM Spectrum
Protectpage.
Use Password access generate
When this option is selected and the password field is empty, the IBM
Spectrum Protect recovery agent authenticates with an existing
password that is stored in the password store. If not selected, you must
manually enter the password.
To use this option, you must first manually set an initial password for
the node to which the option applies. You must specify the initial
password when you connect to the IBM Spectrum Protect node for the
first time by entering the password in the Password field and selecting
the Use Password access generate check box.
However, when you use the local data mover node as the
Authentication node, the password might already be stored in the
password store. As a result, select the Use Password access generate
check box and do not enter a password.
For more information about the password store, see Secure password
storage.
The IBM Spectrum Protect recovery agent queries the specified server for a list
of protected virtual machines, and shows the list.
3. Set the following mount, backup, and restore options by clicking Settings:
Virtual Volume write cache
The IBM Spectrum Protect recovery agent that is running on the
backup proxy host saves data changes on a virtual volume in the write
cache. By default, the write cache is enabled and the maximum cache
size is 90% of the available space for the selected folder. To prevent the
system volume from becoming full, change the write cache to a path on
a volume other than the system volume.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
43
Folder for temporary files
Specify the path where data changes are saved. The write cache
must be on a local drive and cannot be set to a path on a
shared folder.
Cache size
Specify the size of the write cache. The maximum allowed
cache size is 90% of the available space for the selected folder.
Restriction: To prevent any interruption during restore processing,
exclude the write cache path from all antivirus software protection
settings.
Data Access
Specify the type of data to be accessed. If you are using an offline
device (such as tape or virtual tape library), you must specify the
applicable data type.
Storage type
Specify one of the following storage devices from which to
mount the snapshot:
Disk/File
The snapshot is mounted from a disk or file. This
device is the default.
Tape
The snapshot is mounted from a tape storage pool.
When this option is selected, it is not possible to mount
multiple snapshots.
VTL
The snapshot is mounted from an offline virtual tape
library. Concurrent mount sessions on the same virtual
tape library are supported.
Requirement: When the storage type is changed, you must
restart the service for the changes to take effect.
Disable expiration protection
During a mount operation, the snapshot on the IBM Spectrum
Protect server is locked to prevent it from expiring during the
operation. Expiration might occur because another snapshot is
added to the mounted snapshot sequence. This value specifies
whether to disable expiration protection during the mount
operation.
v To protect the snapshot from expiration, do not select this
option. This option is cleared by default. The snapshot on the
IBM Spectrum Protect server is locked and the snapshot is
protected from expiration during the mount operation.
v To disable expiration protection, select this option. The
snapshot on the IBM Spectrum Protect server is not locked
and the snapshot is not protected from expiration during the
mount operation. As a result, the snapshot might expire
during the mount operation. This expiration can produce
unexpected results and negatively impact the mount point.
For example, the mount point can become unusable or
contain errors. However, expiration does not affect the
current active copy. The active copy cannot expire during an
operation.
44
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
When the snapshot is on a target replication server, the
snapshot cannot be locked because it is in read-only mode. A
lock attempt by the server causes the mount operation to fail.
To avoid the lock attempt and prevent such a failure, disable
expiration protection by selecting this option.
Read Ahead size (in 16-KB blocks)
Specify the number of extra data blocks that are retrieved from
the storage device after a read request is sent to a single block.
The default values are as follows:
v Disk or file: 64
v Tape: 1024
v VTL: 64
The maximum value for any device is 1024.
Read Ahead cache size (in blocks)
Specify the size of the cache where the extra data blocks are
stored. The default values are as follows:
v Disk or file: 10000
v Tape: 75000
v VTL: 10000
Since each snapshot has its own cache, make sure to plan how
many snapshots are mounted or restored simultaneously. The
cumulative cache size cannot exceed 75000 blocks.
Driver timeout (seconds)
This value specifies the amount of time to process data requests
from the file system driver. If processing is not completed in
time, the request is canceled and an error is returned to the file
system driver. Consider increasing this value when you
experience timeouts. For example, timeouts might occur when
the network is slow, the storage device is busy, or multiple
mount sessions are being processed. The default values are as
follows:
v Disk or file: 60
v Tape: 180
v VTL: 60
Click OK to save your changes and exit the Settings.
4. Verify that each IBM Spectrum Protect server node (that was specified with the
Asnodename and Fromnode options) allows backups to be deleted. The IBM
Spectrum Protect recovery agent creates unused temporary objects during
operations. The BACKDELete=Yes server option allows these objects to be
removed so that they do not accumulate in the node.
a. Log on to the IBM Spectrum Protect server and start an administrative
client session in command-line mode:
dsmadmc -id=admin -password=admin -dataonly=yes
b. Enter this command:
Query Node <nodename> Format=Detailed
Make sure the command output for each node includes the following
statement:
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
45
Backup Delete Allowed?: Yes
If this statement is not included, update each node with this command:
UPDate Node <nodename> BACKDELete=Yes
Run the Query Node command again for each node to verify that each node
allows backups to be deleted.
Enabling secure communication from the recovery agent to
the IBM Spectrum Protect server
If the IBM Spectrum Protect server is configured to use the Secure Sockets Layer
(SSL) or Transport Layer Security (TLS) protocol, you can enable the recovery
agent to communicate with the server by using the protocol.
Before you begin
Consider the following requirements before you begin configuration for secure
communication to the server:
v Each server that is enabled for SSL must have a unique certificate. The certificate
can be one of the following types:
– A certificate that is self-signed by the server.
– A certificate that is issued by a third-party certificate authority (CA)
certificate. The CA certificate can be from a company such as Symantec or
Thawte, or an internal certifcate that is maintained within your company.
v For performance reasons, use SSL or TLS only for sessions where security is
required. Consider adding more processor resources on the server system to
manage the increased requirements.
v For a client to connect to a server that is using TLS Version 1.2, the certificate
signature algorithm must be Secure Hash Algorithm 1 (SHA-1) or later. If you
are using a self-signed certificate to a server that is using TSL V1.2, you must
use the cert256.arm certificate. Your IBM Spectrum Protect administrator might
need to change the default certificate on the server.
v To disable security protocols that are less secure than TLS 1.2, add the
SSLDISABLELEGACYtls yes option to the C:\windows\system32\fb.opt or
C:\Windows\SysWOW64\fb.opt file. TLS 1.2 or later helps to prevent attacks by
malicious programs.
Enabling secure communication by using an IBM Spectrum
Protect server self-signed certificate
If the IBM Spectrum Protect server is using a self-signed certificate, you must
obtain a copy of that certificate from the server administrator and configure the
recovery agent to communicate with the server by using the SSL or TLS protocol.
About this task
Each server generates its own certificate. Version 6.3 and later servers generate files
that are named cert256.arm if the server is using TLS 1.2 or later or cert.arm if the
server is using an earlier version of SSL or TLS. Server versions earlier than V6.3
generate files that are named cert.arm regardless of the protocol. You must choose
the certificate that is set as the default on the server.
46
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
The certificate file is stored on the server workstation in the server instance
directory. For example, C:\IBM\tivoli\tsm\server\bin\cert256.arm. If the
certificate file does not exist, the certificate file is created when you restart the
server with these options set.
Procedure
To enable SSL or TLS communication from the recovery agent to the server by
using a self-signed certificate:
1. Append the GSKit binary path and library path to the PATH environment
variable on the client. For example:
set PATH=C:\Program Files\Common Files\Tivoli\TSM\api64\gsk8\bin\;
C:\Program Files\Common Files\Tivoli\TSM\api64\gsk8\lib64;%PATH%
2. If you are configuring SSL or TLS on the client for the first time, you must
create the client local key database dsmcert.kdb. From the C:\Windows\SysWOW64
directory, run the gsk8capicmd_64 command as shown in the following
example:
gsk8capicmd_64 -keydb -create -populate -db dsmcert.kdb -pw password -stash
The password that you provide is used to encrypt the key database. The
password is automatically stored encrypted in the stash file (dsmcert.sth). The
stash file is used by the client to retrieve the key database password.
3. Obtain the server self-signed certificate.
4. Import the certificate in to the dsmcert.kdb database. You must import the
certificate for each client in to the dsmcert.kdb. From the C:\Windows\SysWOW64
directory, run the gsk8capicmd_64 command as shown in the following
example:
gsk8capicmd_64 -cert -add -db dsmcert.kdb -stashed -label "Server server_name self-signed key"
-file path_to_certificate -format ascii -trust enable
Multiple server certificates can be added to the dsmcert.kdb database so that
the client can connect to different servers. Different certificates must have
different labels. Use meaningful names for the labels.
Important: For a disaster recovery of the server, if the certificate has been lost,
the server automatically generates a new certificate. Each client must then
import the new certificate.
5. After the server certificate is added to the dsmcert.kdb database, add the ssl
yes option to the C:\Windows\SysWOW64\fb.opt file and update the value of the
tcpport option.
Important:
The server is normally set up for SSL and TLS connections on a different port
than non-SSL and TLS connections. Do not specify a non-SSL or TLS port
number for the tcpport value. If the value of tcpport is incorrect, the recovery
agent cannot connect to the server.
You cannot connect to a non-SSL or TLS port with a recovery agent that is
enabled for SSL or TLS or connect a SSL or TLS port to a recovery agent that is
not enabled for SSL or TLS.
6. Set the correct SSL or TLS ports in the following recovery agent configuration
files:
v C:\ProgramData\Tivoli\TSM\RecoveryAgent\mount\RecoveryAgent.conf
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
47
v C:\ProgramData\Tivoli\TSM\RecoveryAgent\mount\
RecoveryAgentDMNodes.conf
Enabling secure communication by using a third-party certificate
If the IBM Spectrum Protect server is using a third-party certificate authority (CA),
you must obtain the CA root certificate.
About this task
If the certificate was issued by a CA such as Symantec or Thawte, the client is
ready for SSL or TLS and you can skip the following configuration steps. For the
list of preinstalled CA root certificates, see Certificate Authorities root certificates.
If the certificate was not issued by a preinstalled root certificate or is an internal
CA certificate that is maintained within your company, you must configure the
recovery agent to communicate with the server by using the SSL or TLS protocol.
Procedure
To enable SSL or TLS communication from the recovery agent to the server by
using a CA certificate:
1. Append the GSKit binary path and library path to the PATH environment
variable. For example:
set PATH=C:\Program Files\Common Files\Tivoli\TSM\api64\gsk8\bin\;
C:\Program Files\Common Files\Tivoli\TSM\api64\gsk8\lib64;%PATH%
2. If you are configuring SSL or TLS on the client for the first time, you must
create the client local key database dsmcert.kdb. For clients, from the
C:\Windows\SysWOW64 directory, run the gsk8capicmd_64 command as shown in
the following example:
gsk8capicmd_64 -keydb -create -populate -db dsmcert.kdb -pw password -stash
The password that you provide is used to encrypt the key database. The
password is automatically stored encrypted in the stash file (dsmcert.sth). The
stash file is used by the client to retrieve the key database password.
3. Obtain the CA certificate.
4. Import the certificate in to the dsmcert.kdb database. You must import the
certificate for each client in to the dsmcert.kdb. For clients, from the
C:\Windows\SysWOW64 directory, run the gsk8capicmd_64 command as shown in
the following example:
gsk8capicmd_64 -cert -add -db dsmcert.kdb -stashed -label "XYZ Certificate Authority"
-file path_to_CA_root_certificate -format ascii -trust enable
Multiple server certificates can be added to the dsmcert.kdb database so that
the client can connect to different servers. Different certificates must have
different labels. Use meaningful names for the labels.
Important: For a disaster recovery of the server, if the certificate has been lost,
the server automatically generates a new certificate. Each client must import
the new certificate.
5. After the server certificate is added to the dsmcert.kdb database, add the ssl
yes option to the C:\Windows\SysWOW64\fb.opt file and update the value of the
tcpport option.
Important:
48
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
The server is normally set up for SSL and TLS connections on a different port
than non-SSL and TLS connections. Do not specify a non-SSL or TLS port
number for the tcpport value. If the value of tcpport is incorrect, the recovery
agent cannot connect to the server.
You cannot connect to a non-SSL or TLS port with a recovery agent that is
enabled for SSL or TLS or connect a SSL or TLS port to a recovery agent that is
not enabled for SSL or TLS.
6. Set the correct SSL or TLS ports in the following recovery agent configuration
files:
v C:\ProgramData\Tivoli\TSM\RecoveryAgent\mount\RecoveryAgent.conf
v C:\ProgramData\Tivoli\TSM\RecoveryAgent\mount\
RecoveryAgentDMNodes.conf
Manually configuring an iSCSI device
You must configure the Windows system that is used during an iSCSI mount
operation. The snapshot is mounted from IBM Spectrum Protect server storage.
Before you begin
Review the following iSCSI requirements before you proceed with this task:
v During an iSCSI mount, an iSCSI target is created on the IBM Spectrum Protect
recovery agent system. You can connect to the iSCSI target from any system to
create a volume that contains the backup data. Also, you can then mount this
volume from another system.
v iSCSI initiator is required on any system that must connect to the iSCSI target.
v Make sure that an iSCSI initiator is installed on the system where the data is to
be restored.
v Microsoft iSCSI Initiator is not required on the IBM Spectrum Protect recovery
agent system.
Review the following disk and volume requirements before you proceed with this
task:
v If a volume spans several disks, you must mount all the required disks. When
mirrored volumes are used, mount only one of the mirrored disks. Mounting
one disk prevents a time-consuming synchronization operation.
v If multiple dynamic disks were used on the backup system, these disks are
assigned to the same group. As a result, Windows Disk Manager might consider
some disks as missing and issue an error message when you mount only one
disk. Ignore this message. The data on the backed up disk is still accessible,
unless some of the data is on the other disk. This issue can be solved by
mounting all the dynamic disks.
About this task
Complete these tasks to configure the Windows system that is used during an
iSCSI mount operation:
Procedure
1. On the IBM Spectrum Protect recovery agent system, open port 3260 in the
LAN firewall and the Windows client firewall. Record the iSCSI initiator name
on the system where data is to be restored.
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
49
The iSCSI initiator name is shown in the iSCSI initiator configuration window
of the Control Panel. For example:
iqn.1991-05.com.microsoft:hostname
2. Complete these tasks on the system where the IBM Spectrum Protect recovery
agent (or iSCSI target) is installed:
a. Start the IBM Spectrum Protect recovery agent GUI. Complete the Select
IBM Spectrum Protect server and Select snapshot dialogs and click Mount.
b. In the Choose mount destination dialog, select Mount an iSCSI target.
c. Create a target name. Make sure that it is unique and that you can identify
it from the system that runs the iSCSI initiator. For example:
iscsi-mount-tsm4ve
d. Enter the iSCSI Initiator name that was recorded in Step 1 and click OK.
e. Verify that the volume you just mounted is displayed in the Mounted
Volumes field.
3. Locate and start the iSCSI Initiator program on the initiator system that was
selected in Step 1:
a. Connect to the iSCSI target:
1)
In the Targets tab, enter the TCP/IP address of the IBM Spectrum
Protect recovery agent (iSCSI target) used in Step 2 in the Target: dialog.
Click Quick Connect.
2) The Quick Connect dialog shows a target that matches the target name
that was specified in Step 2c. If it is not already connected, select this
target and click Connect.
b. On the initiator system, go to Control Panel > Administrative Tools >
Computer Management > Storage > Disk Management.
1) If the mounted iSCSI target is listed as Type=Foreign, right-click Foreign
Disk and select Import Foreign Disks. The Foreign Disk Group is
selected. Click OK.
2) The next screen shows the type, condition, and size of the Foreign Disk.
Click OK and wait for the disk to be imported.
3) When the disk import completes, press F5 (refresh). The mounted iSCSI
snapshot is visible and contains an assigned drive letter. If drive letters
are not automatically assigned, right-click the required partition and
select Change Drive Letters or Paths. Click Add and select a drive
letter.
4. Open Windows Explorer (or other utility) and browse the mounted snapshot
for a file restore operation.
5. After the file is restored, complete these tasks:
a. Disconnect each iSCSI target by using the iSCSI Initiator Properties dialog.
b. Dismount the volume from Step 2 by selecting the volume in the IBM
Spectrum Protect recovery agent GUI and clicking Dismount.
50
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Advanced configuration
Use advanced configuration tasks to further customize the configuration of Data
Protection for Microsoft Hyper-V.
|
Configuring non-default port numbers for Data Protection for
Microsoft Hyper-V operations
|
|
|
If you do not want to use the default port numbers for the Data Protection for
Microsoft Hyper-V web server or REST API services, you can configure different
port numbers by using Windows PowerShell cmdlets.
|
About this task
|
|
|
The default port number that is assigned to the web server provides services to the
Data Protection for Microsoft Hyper-V Management Console, file restore interface,
and PowerShell cmdlets.
|
Complete the steps in the following procedure to change the port number.
|
Procedure
|
|
1. Start PowerShell by following the instructions in “Preparing to use PowerShell
cmdlets with Data Protection for Microsoft Hyper-V” on page 79.
|
|
2. Optional: Show what port numbers that are being used by running the
following cmdlets:
|
v To show the web server port, use the Show-DpHvHttpsPort cmdlet.
|
v To show the REST API port, use the Show-DpHvMmcLoginPreferences cmdlet.
|
|
|
|
|
|
|
This cmdlet shows the login preferences, including the REST API port
number, for the Data Protection for Microsoft Hyper-V Management Console.
The preferences are created when the management console is run the first
time. If you run this cmdlet before the management console is ever run, no
information is returned.
3. To change the default port numbers, use the following cmdlets:
|
|
|
|
|
v To change the web server port, use the Set-DpHvHttpsPort cmdlet. For
example, to change the web server port number to 9082, use the following
cmdlet:
|
|
|
|
v To change the REST API port, use the Set-DpHvMmcLoginPreferences cmdlet.
For example, to change the REST API port number to 9082, use the following
cmdlet:
|
Tip: For more examples, use the Get-Help cmdlet_name command.
Set-DpHvHttpsPort -httpsPort 9082
All hosts in a cluster must use the same HTTPS port.
Set-DpHvMmcLoginPreferences -RestApiPort 9082
|
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
51
Tuning scheduled VM backups for Windows Server 2012 and
2012 R2 clusters
Beginning with Data Protection for Microsoft Hyper-V Version 8.1.2, you can back
up more virtual machines (VMs) in parallel and across nodes in a cluster. A cluster
node backup operation always retries the snapshot on volumes with snapshots that
failed with a recoverable condition. You can also tune the number of VMs in a
snapshot to reduce the workload of a snapshot for the Hyper-V host.
You can use the following options to tune how snapshots are taken during the
backup:
v Use the vmmaxparallel option to control how many VMs are sent in parallel to
the IBM Spectrum Protect server. The setting for this option has the most notable
impact on performance.
v Use the vmmaxpersnapshot option to control how many VMs can be included in
each snapshot that is created during the backup operation.
Before you back up a cluster, review and tune the values for these two options for
the environment.
Use the following general approach to tune your cluster backup operations:
1. Plan to use an appropriately sized and configured IBM Spectrum Protect server
that uses container pools. For information about how to size the server, see IBM
Spectrum Protect Blueprints.
2. As a starting point, use the default values for the vmmaxpersnapshot and
vmmaxparallel options.
3. Run the backup schedule and note the results, such as whether backups
completed within the schedule window or whether too many snapshot retries
occurred.
4. Adjust the value for the vmmaxparallel option to work in your environment.
For example, set the value to 10.
5. Adjust the value of vmmaxpersnapshot to a value that minimizes the number of
retries that occur. The retries are reported in the backup statistics.
When you choose a smaller number of VMs per snapshot, you increase the
number of snapshots that are needed to complete a backup operation. This
increase in snapshots can lead to delays during cluster backup operations of
VMs on CSVs. The delay occurs because only one snapshot can be created at a
time, and backup operations of other nodes in the schedule are delayed during
snapshot creation. By increasing the number of VMs in a snapshot, you can
reduce the number of snapshots that are taken for a backup operation.
To determine the number of VMs to include in a snapshot, consider the
following factors:
v A snapshot with more VMs takes longer to complete and increases the load
on the system. A larger number of VMs means that the snapshot persists
longer, which can affect system performance.
v The vmmaxpersnapshot and vmmaxparallel options work together to
determine how many snapshots are taken in a backup operation. The
vmmaxparallel option specifies how many VMs can be backed up
simultaneously. Data Protection for Microsoft Hyper-V takes as many
snapshots as needed to meet the vmmaxparallel setting.
VMs are sorted and selected based on the volumes that are needed to create
the snapshot for the VMs. A snapshot is created for a set of VMs that share a
set of volumes. Thus, the number of snapshots varies depending upon the
52
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
volumes that are used by the VMs. The number of VMs per snapshot never
exceeds the value for the vmmaxpershapshot option.
The following table shows examples of how many VMs can be processed per
snapshot with various vmmaxpersnapshot and vmmaxparallel settings. In these
examples, assume that all the VMs are on the same volume.
Table 5. Number of snapshots and VMs (on the same volume) processed with the
vmmaxpersnapshot and vmmaxparallel settings
vmmaxpersnapshot
setting
vmmaxparallel
setting
10
20
Two snapshots are created with 10 VMs each.
When the number of VMs being processed is
less than the vmmaxparallel setting, another
snapshot is taken.
20
20
One snapshot is created containing 20 VMs.
20
10
One snapshot is created containing 20 VMs, and
10 VMs are backed up due to the vmmaxparallel
setting during the first run. The remaining 10
VMs are backed up during the second run (a
second snapshot is not needed).
Number of snapshots created
You can also use the vmmaxsnapshotretry option to specify the maximum number
of times to retry a snapshot operation of a VM if the initial snapshot fails with a
recoverable condition.
For more detailed guidelines about optimizing snapshots, see technote 2004284.
Related concepts:
“Limitations on Hyper-V backup operations” on page 10
Related reference:
“Vmmaxpersnapshot” on page 131
“Vmmaxsnapshotretry” on page 133
“Vmmaxparallel” on page 130
Chapter 3. Configuring Data Protection for Microsoft Hyper-V
53
54
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
Chapter 4. Managing data with the Data Protection for
Microsoft Hyper-V Management Console
|
|
|
The Data Protection for Microsoft Hyper-V Management Console provides a single
environment to help you manage the daily operations of Data Protection for
Microsoft Hyper-V.
|
|
|
You can use the Data Protection for Microsoft Hyper-V Management Console to
start ad hoc backup and restore operations and to view the most recent backup
information for all virtual machines (VMs) that are in a Hyper-V host or cluster.
|
|
|
|
This information includes the identification of VMs that are at risk of being
unprotected because the VM has never been backed up or because a backup did
not occur in the time interval that is set in the at-risk policy. The at-risk policy only
applies to VMs that have been previously backed up.
|
|
|
Tip: You can also use the configuration wizard to initially configure or update the
configuration of Data Protection for Microsoft Hyper-V. For more information, see
“Configuring Data Protection for Microsoft Hyper-V with the wizard” on page 29.
|
|
|
Starting the Data Protection for Microsoft Hyper-V Management
Console
|
|
|
To manage day-to-day operations for Data Protection for Microsoft Hyper-V, start
the Data Protection for Microsoft Hyper-V Management Console and enter your
logon credentials.
|
Procedure
|
|
|
1. Start the Data Protection for Microsoft Hyper-V Management Console by
clicking Start > IBM Spectrum Protect > DP for Hyper-V Management
Console.
|
|
|
|
|
Alternatively, issue the following command at the command prompt:
2. When prompted, log on to the Data Protection for Microsoft Hyper-V
Management Console. Enter the same credentials that you use to log on to the
Hyper-V host.
|
|
The account that you use must be a member of the local administrators group
on the computer so that Hyper-V and cluster operations can be completed.
|
|
|
|
Tip: If you did not configure Data Protection for Microsoft Hyper-V or if the
configuration is incomplete, the configuration wizard appears automatically.
For more information, see “Configuring Data Protection for Microsoft Hyper-V
with the wizard” on page 29.
"C:\Program Files\IBM\SpectrumProtect\DPHyperV\DpHv.msc"
|
What to do next
|
|
You can start using the Data Protection for Microsoft Hyper-V Management
Console to manage your virtual machine backups and monitor their status.
© Copyright IBM Corp. 2011, 2017
55
|
|
|
After a period of inactivity, your connection to Data Protection for Microsoft
Hyper-V Management Console can time out. If a timeout occurs, you are prompted
to enter your credentials in the Reconnect - Session Expired window.
|
|
|
|
Tip for running in a custom console: You can add the Data Protection for
Microsoft Hyper-V Management Console to a custom Microsoft management
console so that it can be run in a single console along with, for example, the
Hyper-V manager and Cluster Failover manager.
|
|
1. Start an empty Microsoft Management Console by issuing the mmc command
from a command prompt.
|
2. Click File > Add/Remove Snap-in.
|
3. Select Data Protection for Microsoft Hyper-V and click Add.
|
|
4. Select and add any other snap-ins, for example, select and add Hyper-V
Manager and Failover Cluster Manager.
|
5. To name and store the .msc file, click File > Save as.
|
6. To start the custom console, run the .msc file that you saved.
|
|
|
Navigating the Data Protection for Microsoft Hyper-V Management
Console
|
|
|
Use the Data Protection for Microsoft Hyper-V Management Console for daily
management of backup operations. You can monitor virtual machine backup
operations, run backup and restore operations, and update the configuration.
|
|
|
The Data Protection for Microsoft Hyper-V Management Console contains three
main work areas: the navigation pane, the results pane, and the actions pane.
Information about these work areas is provided.
Navigation pane
|
|
|
|
The navigation pane on the left, labeled Data Protection for Hyper-V, contains a
tree view that shows the clusters or hosts in the Hyper-V environment. In the
cluster view, children nodes of the cluster node represent each host in the cluster.
|
|
|
|
|
When you select a host or cluster in the navigation pane, the backup status of
virtual machines (VMs) in the selected host or cluster and the history of schedule
runs are displayed in the Virtual Machines and Schedule History views in the
results pane. The list of available actions for the selected cluster, host, or VM is
also displayed in the actions pane on the right of the management console.
Results pane
|
|
|
|
The results pane in the middle of the Data Protection for Microsoft Hyper-V
Management Console shows detailed information about the virtual machine
backups and the backup schedule history for a selected cluster or host.
|
|
The workspace contains two views, labeled as Virtual Machines and Schedule
History. Click the corresponding tab in the results pane to display each view.
56
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
|
Virtual Machines view
|
|
|
You can enter all or part of a VM name in the Filter field to display only VMs with
names that contain the text string. You can also click Refresh to refresh the
contents in the tables.
|
VM table
|
|
|
At the top of the Virtual Machines view, you see the table of VMs in a host or
cluster, and details about the last backup operation for each VM. The following
data is shown in the table.
|
Table 6. Descriptions of columns in the VM table
|
Column
Description
|
Name
The name of the VM.
|
|
|
|
Host
When a cluster is selected in the navigation
pane, the name of the current active host for
the VM. If the VM status is Deleted, the
host name is still shown.
The Virtual Machines view in the results pane shows the data protection status of
each virtual machine (VM) in a cluster or host and the backup history for
individual VMs.
|
|
|
|
|
|
|
However, if the environment was upgraded
from Data Protection for Microsoft Hyper-V
Version 8.1.2 or earlier, the field will be
empty until VM backups are run with
V8.1.4.
Status
The data protection status of the VM. A VM
can have one of the following states:
|
|
|
|
|
At Risk
|
|
|
|
No Backup
The VM is configured for backup
operations, but no backup has been
run.
|
|
|
|
Normal
|
|
|
Ignored
|
|
|
|
Deleted
|
|
The most recent backup operation
did not occur within the time limit
that is specified by the at-risk
policy.
A backup operation occurred within
the time limit that is specified by
the at-risk policy.
The at-risk policy is set to suppress
at-risk warnings for the VM.
The VM was deleted from the
Hyper-V environment, but its
backup is available to be restored.
Last Backup
The date of the last successful backup
operation.
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
57
|
Table 6. Descriptions of columns in the VM table (continued)
|
Column
Description
|
|
|
Data Transmitted
The amount of data that was sent to the IBM
Spectrum Protect server during the backup
operation.
|
|
Duration
The length of time it took to run the backup
operation.
|
|
Backup Type
The type of backup operation that was run
(full or incremental).
|
|
|
Schedule
The name of the schedule that ran during
the last successful backup operation.
|
Backup History table
|
|
|
The Backup History table shows the details of previously scheduled or ad hoc
backup tasks of a single virtual machine (VM) that you selected in the VM table. If
you selected multiple VMs, no data is displayed in the Backup History table.
|
|
|
The number of backup tasks that are shown in the Backup History table depends
on the number of days that are set by the SET EVENTRETENTION command on the
IBM Spectrum Protect server.
|
The following data is shown in the table.
|
Table 7. Descriptions of columns in the Backup History table
|
Column
Description
|
|
Last Run Time
The actual start date and time of the last
backup run.
|
Status
The status of the backup operation.
|
|
|
Succeeded
The backup operation was
completed successfully.
|
|
Failed
|
|
In Progress
A backup operation is in progress.
The backup operation encountered
an error and was not completed.
|
Duration
The duration of the backup operation.
|
|
|
Error Code
If a backup operation failed, an error code is
shown. If the backup operation completed
successfully, a zero (0) is displayed.
|
|
|
Data Transmitted
The amount of data that was sent to the IBM
Spectrum Protect server during the backup
operation.
|
|
Backup Type
The type of backup operation that was run
for the VM:
|
|
|
|
Incremental
Backs up the blocks that changed
since the last backup (full or
incremental).
|
|
Full
58
Backs up a snapshot of an entire
VM.
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Table 7. Descriptions of columns in the Backup History table (continued)
|
Column
Description
|
|
|
|
|
Backup Host
The host that contains the data mover for
the VM when it was backed up. For clusters,
this data mover host can change due to
failover clustering.
|
Tasks table
|
|
The Tasks table shows a list of recent tasks that started since the Data Protection
for Microsoft Hyper-V Management Console was started.
|
For more information, see “Tasks table” on page 61.
|
|
|
Schedule History view
|
You can click Refresh to refresh the contents in the tables.
|
Schedule history table
|
|
The Schedule history table shows the history of backup schedules for the host or
cluster.
|
|
|
The number of listings of backup history that are shown depends on the number
of days that are set by the SET EVENTRETENTION command on the IBM Spectrum
Protect server.
|
The following data is shown in the schedule history table.
|
Table 8. Descriptions of columns in the schedule history table
|
Column
Description
|
|
|
Schedule Start Time
The actual date and time that the schedule
started. If a schedule was missed, the
scheduled start time is shown.
|
Name
The name of the schedule.
The Schedule History view in the results pane displays the run history for the
backup schedules that are associated with a Hyper-V host or cluster.
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
59
|
Table 8. Descriptions of columns in the schedule history table (continued)
|
Column
Description
|
|
|
Status
The status of the schedule is based on all
data movers that are associated with the
schedule. The following states are possible:
|
|
|
|
|
|
Succeeded
The schedule ran to completion for
all data movers. The details of
individual VMs that were backed
up or failed to be backed up are
shown in the second table.
|
|
|
Failed
|
|
|
In Progress
The schedule started on all data
movers and has not completed.
|
|
|
Missed The schedule failed to start on at
least one data mover within the
startup window for the schedule.
The schedule did not run to
completion on at least one data
mover.
|
|
VM Succeeded
The number of VMs that were successfully
backed up during the schedule run.
|
|
|
VM Failures
The number of VMs that failed to be backed
up during the schedule run. If the schedule
was missed or failed, a dash is displayed.
|
|
|
|
|
|
Duration
The length of time that the schedule ran.
The duration is measured from the start of
the first schedule activity to the final
schedule activity. If the schedule was missed
or failed, a dash is displayed.
|
Schedule Detail table
|
|
|
When you select a schedule entry in the schedule history table, the Schedule Detail
table shows the list of virtual machines (VMs) that were backed up for the selected
schedule run.
|
|
|
When multiple nodes are associated with a schedule, the number of virtual
machines (VMs) that are shown reflects the information from all the data mover
nodes for that schedule run.
|
|
You can enter all or part of a VM name in the Filter field to display only VMs with
names that contain the text string.
|
The following data is shown in the table.
|
Table 9. Descriptions of columns in the Schedule Detail table
|
Column
Description
|
Name
The name of the VM.
60
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Table 9. Descriptions of columns in the Schedule Detail table (continued)
|
Column
Description
|
Status
The backup status of the VM.
|
|
|
Succeeded
The VM was successfully backed
up.
|
Failed
The VM failed to be backed up.
|
|
Start Time
The date and time when the VM backup
operation started.
|
|
|
Reason
If the VM backup failed, an error code is
provided. If the backup operation was
successful, a zero (0) is displayed.
|
Duration
The duration of the backup operation.
|
|
|
Data Transmitted
The amount of data that was sent to the IBM
Spectrum Protect server during the backup
operation.
|
|
Backup Type
The type of backup operation that was run
for the VM:
|
|
|
|
Incremental
Backs up the blocks that changed
since the last backup (full or
incremental).
|
|
Full
Backs up a snapshot of an entire
VM.
|
|
|
|
|
Backup Host
|
Tasks table
|
|
The Tasks table shows a list of recent tasks that started since the Data Protection
for Microsoft Hyper-V Management Console was started.
|
For more information, see “Tasks table.”
|
|
|
Tasks table
|
|
|
The same list of tasks is displayed in the Virtual Machines view or the Schedule
History view. You can monitor long-running tasks such as backup or restore
operations.
|
You can also take the following actions:
|
Stop
Cancel a running task.
|
Copy
Copy the results of the selected tasks to the clipboard.
|
|
|
Remove Completed
Remove all completed tasks from the table. Tasks that are running are not
removed.
The host that contains the data mover that is
used to run the VM backup operation. For
clusters, this data mover host can change
due to failover clustering.
The Tasks table shows the list of recent backup or restore tasks that began since
you started the Data Protection for Microsoft Hyper-V Management Console.
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
61
|
The following data is shown in the Tasks table.
|
Table 10. Descriptions of columns in the Tasks table
|
Column
Description
|
Host
The host on which the task is running.
|
|
Task
The type of task that is running (Backup or
Restore).
|
|
Status
The status of the task (Working, Succeeded,
or Failed).
|
Start Time
The start date and time of the task.
|
|
|
Duration
The length of time it took for the task to run
or the length of time the task has been
running.
|
|
|
Messages
If the task failed, the related error messages
are shown. If the task was completed
successfully, no messages are shown.
|
|
|
The messages field also shows status
messages for a task that is in progress.
Actions pane
|
|
|
|
The Actions pane on the right side of the Data Protection for Microsoft Hyper-V
Management Console shows the list of available actions for the selected item in the
navigation pane and any selected VMs in the results pane.
|
|
The actions pane contains one section for a host or cluster, and one section for a
VM.
|
Actions that apply at the host or cluster level
|
|
Log out
|
|
Connect
Log in to Data Protection for Microsoft Hyper-V.
|
|
|
Backup Management
Assign a backup schedule to a single Hyper-V host or cluster
environment.
|
|
|
Configure
Open the configuration wizard to update the configuration of Data
Protection for Microsoft Hyper-V.
|
|
|
Properties
Show the current configuration for Data Protection for Microsoft
Hyper-V. To update the configuration, click Configure.
|
|
|
View > Customize
Customize what is displayed in the Data Protection for Microsoft
Hyper-V Management Console.
|
|
|
Refresh
|
|
Help
Log out of Data Protection for Microsoft Hyper-V.
Refresh the contents in the Data Protection for Microsoft Hyper-V
Management Console.
62
Open the online help for Data Protection for Microsoft Hyper-V
Management Console.
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Actions that apply at the VM level
|
|
Backup
|
|
Restore
|
|
|
File Restore
Open the file restore interface in a web browser. Available only if
you enabled the file restore feature.
|
|
Set At Risk
Set the at-risk policy for one or more VMs.
|
|
Help
|
|
Back up one or VMs.
Restore a single VM with the Restore wizard.
Open the online help for Data Protection for Microsoft Hyper-V
Management Console.
Managing backup schedules for a host or cluster machine
|
|
You can select a schedule to specify how often and when to automatically back up
virtual machines (VMs) in a Hyper-V host or cluster.
|
About this task
|
|
Schedules are set up by the IBM Spectrum Protect server administrator to
automatically back up VMs.
|
|
|
|
To enable schedules to be used for Data Protection for Microsoft Hyper-V, the IBM
Spectrum Protect server administrator must set up a list of schedules that are
specifically for backing up Hyper-V VMs. The schedule definition must include the
following parameters and options:
|
|
v The -domain.vmfull="all-vm" option must be specified in the option string. No
other parameters are required for the -domain.vmfull option.
|
|
v The schedule must contain the ACTION=BACKUP and SUBACTION=VM
parameters.
|
|
|
|
|
|
|
For example, the administrator defines a schedule with the following DEFINE
SCHEDULE command:
|
|
|
|
|
The Hyper-V administrator then associates a data mover with the schedule by
using the Backup Management window. The -asnodename= option is automatically
added to the schedule definition. For example, for a stand-alone host, the following
option is added:
|
|
For a cluster environment, the following options is added:
|
|
Tip: The server administrator can also use the IBM Spectrum Protect Operations
Center to define the HyperV schedule. If some VMs need to be excluded, include
define schedule hyperv_domain_name schedule_name
description=schedule_description action=backup subaction=VM
starttime=NOW+00:10 schedstyle=Classic period=1 perunits=Weeks
durunits=minutes duration=10 options=’-vmbackuptype=hypervfull
-mode=IFIncremental -domain.vmfull="all-vm"’
-asnodename=Hyper-V_host_HV_TGT
-asnodename=clustername_hv_tgt
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
63
|
|
|
|
the -vm parameter in the -domain.vmfull option in the option string. For example,
to exclude the VM named TestVm1, specify the following option in the option
string:
|
|
|
You set the backup policy for a host or cluster by associating a backup schedule
with the host or cluster. You can also remove the schedule association from a host
or cluster.
|
|
In a cluster environment, the selected schedule applies to all hosts in the cluster.
You cannot assign a different schedule to a host that is part of a cluster.
|
Procedure
|
1. Start the Data Protection for Microsoft Hyper-V Management Console
|
|
2. In the navigation pane, click a stand-alone host or cluster from the navigation
pane.
|
|
|
3. In the Actions pane, click Backup Management.
A summary of the schedules is displayed in a table. The following properties of
the schedules are displayed:
-domain.vmfull="all-vm;-vm=TestVM1"
|
|
Schedule Name
The name of the schedule.
|
|
Repeats
How often the schedule repeats.
|
|
|
Host Names
A list of hosts that correspond to the data mover nodes that are
associate with the schedule.
|
|
Description
A description of the schedule.
4. Select a schedule in the Backup Management window and take one f the
following actions.
|
|
v To associate the selected schedule with the cluster or host and refresh the
window, click Assign Schedule.
|
|
When a schedule is assigned to a cluster or host, the -asnodename in the
option string in the schedule definition is specified with the target node
(hostname_HV_TGT or clustername_HV_TGT). Only the relevant schedules for
this target node are shown or schedules that are not associated with any
other target nodes are shown.
|
|
|
|
|
v To remove the selected schedule association from the cluster or host, click
Unassign Schedule.
When you remove the schedule association from the cluster or host, the
asnodename option is removed from the option string in the schedule
definition and the nodes related to the cluster or host are removed from the
association.
|
|
|
|
|
|
5. Click Close to close the window.
|
|
64
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
Setting the at-risk policy for a virtual machine
|
|
|
|
Hyper-V virtual machines (VMs) can be at risk of being unprotected because of
failed or missed backup operations. You can set a policy for a VM that specifies
whether the VM is shown as being at-risk if a backup operation does not occur in
a specified time interval.
|
About this task
|
|
|
|
By default, each VM uses the policy that is set for the IBM Spectrum Protect server.
You can use the default policy, set a custom policy, or choose to ignore the policy
for one or more VMs that are selected in the cluster or host view in the Data
Protection for Microsoft Hyper-V Management Console.
|
|
The Status column in the Virtual Machines pane shows the data protection status
of each VM in the host or cluster. The following data protection states are possible.
|
|
|
At Risk
|
|
No Backup
The VM is configured for backup operations, but no backup has been run.
|
|
|
Normal
|
|
Ignored
The at-risk policy is set to suppress at-risk warnings for the VM.
|
|
|
Deleted
The VM was deleted from the Hyper-V environment, but its backup is
available to be restored.
|
|
You can assign an at-risk policy only to VMs that have been backed up. If a VM
has never been backed up, the set at-risk action is disabled.
|
Procedure
|
|
To use the default at-risk policy, select a custom at-risk policy for selected VMs, or
set selected VMs to ignore the at-risk policy, complete the following steps:
|
1. Start the Data Protection for Microsoft Hyper-V Management Console
|
|
2. In the navigation pane, click a host or cluster, and click one or more VMs in the
VM table.
|
3. Click Action > Set At Risk.
|
4. Complete one of the following actions in the Set At Risk window.
||
Action
Step
|
|
To use the default at-risk policy
Click Default to accept the default duration
of 1 day.
|
To suppress at-risk warnings for the VM
Click Ignore.
|
|
|
|
|
To set a custom at-risk policy
Click Custom and move the slider to set the
time interval since the last backup. The
default is 6 hours.
The most recent backup operation did not occur within the time limit that
is specified by the at-risk policy.
A backup operation occurred within the time limit that is specified by the
at-risk policy.
5. To save your setting, click Set at Risk.
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
65
|
6. To close the window, click Close.
|
Results
|
|
|
|
If the at-risk policy is set to Default or Custom for a VM, the At Risk status is
shown for the VM if a backup operation did not occur within the time limit that is
set by the policy. If the VM has never been backed up, the VM is also considered
to be at-risk and the No Backup status is shown.
|
|
If the at-risk policy is set to Ignore for a VM, the risk status Ignored is shown for
the VM regardless of the status of the backup.
|
|
Viewing the schedule history for a Hyper-V host or cluster
|
|
|
|
You can view the run history for the backup schedules that are associated with a
Hyper-V host or cluster. This history includes the dates and times that a schedule
ran, the status of the schedule run, and the number of virtual machines (VMs) that
were backed up successfully or failed to back up.
|
About this task
|
|
|
The number of runs that are shown for a schedule depends on the number of days
that are set by the SET EVENTRETENTION command on the IBM Spectrum Protect
server.
|
Procedure
|
1. Start the Data Protection for Microsoft Hyper-V Management Console.
|
|
2. In the navigation pane, click a host or cluster, and click the Schedule History
tab.
You can view the run history for all of the backup schedules that are associated
with the cluster or host. You can also select a schedule to view the backup
status for the VMs that are associated with that schedule in the Schedule Detail
table.
|
|
|
|
For information, see “Schedule History view” on page 59.
|
Related information:
|
SET EVENTRETENTION (Set the retention period for event records)
|
|
|
Viewing the backup status and backup history of a virtual machine
|
|
|
You can view the status of scheduled virtual machine (VM) backups in a host or
cluster to identify the VMs that might require attention. You can also view the
backup history of individual VMs.
|
|
Procedure
|
2. From the navigation pane, click a host or cluster.
|
3. Click the Virtual Machines tab.
|
|
4. In the VM table, view the status of the most recent scheduled backup
operations of VMs in the host or cluster.
1. Start the Data Protection for Microsoft Hyper-V Management Console.
A VM with a status of At Risk indicates that a last scheduled backup was
missed or completed with errors.
|
|
5. To view the backup history of a VM, select a VM from the VM table.
|
66
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
|
|
|
The backup history that is specific to that VM is shown in the Backup History
table.
The number of backup tasks that are shown in the Backup History table
depends on the number of days that are set by the SET EVENTRETENTION
command on the IBM Spectrum Protect server.
For more information, see “Virtual Machines view” on page 57.
|
|
Tip: If you are using a data mover command (dsmc) to access information
about the VM backups, specify the following options with the dsmc command:
|
|
v For clusters, include the -optfile=hostname_HV_DM.opt and
-asnodename=clustername_HV_TGT options.
|
|
v For a stand-alone host, include the -optfile=hostname_HV_DM.opt and
-asnodename=hostname_HV_TGT options.
|
|
|
For example, use the following command syntax to query information about
VM backups on the IBM Spectrum Protect server:
|
|
|
If you do not include the -asnodename and -optfile options in the dsmc query
vm command, the output of the command will not match the VM backup
results in the Data Protection for Microsoft Hyper-V Management Console.
dsmc query vm vmname -optfile=hostname_HV_DM.opt -asnodename=clustername_HV_TGT
|
What to do next
|
|
If you want to back up an at-risk VM without waiting for the schedule to run,
select the VM, and click Backup from the Actions pane.
|
Related information:
|
|
|
SET EVENTRETENTION (Set the retention period for event records)
Running an ad hoc backup of a virtual machine
|
|
When you start an ad hoc backup of a virtual machine (VM), the backup operation
begins immediately without waiting for a schedule to run.
|
About this task
|
|
|
|
Typically, the VMs in your Hyper-V host or cluster are backed up when a schedule
is run. However, you can start an ad hoc backup if you notice that a backup
schedule was missed or if a VM backup was completed with errors. You can also
start an ad hoc backup of a VM that is excluded from scheduled backup services.
|
|
Procedure
|
2. In the navigation pane, click a host or cluster.
|
|
3. In the VM table in the Virtual Machines view, click a VM. For example, click a
VM whose data protection status is At Risk.
|
4. Click Backup in the VM section of the Actions pane.
|
5. Complete the following fields in the Ad Hoc Backup window:
1. Start the Data Protection for Microsoft Hyper-V Management Console.
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
67
||
Option
Description
|
Backup Type
Select the type of backup to run:
|
|
|
|
|
|
|
|
|
|
|
Incremental
Backs up the blocks that changed
since the previous backup (full or
incremental). The most recent
incremental backup is appended to
the previous backup. If a full
backup does not exist for this VM,
a full backup is automatically
performed. As a result, you do not
have to verify that a full backup
exists.
|
|
|
|
Full
|
|
Data Consistency
Backs up a snapshot of an entire
VM. After the full backup is
completed, you do not have to
make additional full backups.
Available only for Hyper-V hosts or clusters
on Windows Server 2016 operating systems.
|
|
|
Select the type of snapshot and retry
attempts that are used during backup
operations:
|
|
|
|
Always application consistent
Attempts two quiesced snapshots to
create application-consistent
backups before failing the backup.
|
|
|
|
|
Attempt application consistent
Attempts one quiesced snapshot
and as a final attempt, a
nonquiesced, machine-consistent
snapshot.
|
|
|
|
Machine consistent only
Attempts only a nonquiesced
snapshot for VMs that can never
complete a quiesced snapshot.
|
|
Disk Protection
Available only for Hyper-V hosts or clusters
on Windows Server 2016 operating systems.
|
|
|
Select the virtual machine disks to include in
backups. The disks are identified by the disk
numbers.
|
|
|
|
|
|
You can back up all disks in the VM, back
up only disk 1, or back up all disks except
for disk 1. Disk 1 usually contains the
operating system.
6. To start the backup operation and close the window, click Backup.
|
Results
|
|
The backup operation that you started is displayed in the task list at the bottom of
the Virtual Machines view or the Schedule History view.
68
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
Restoring a virtual machine
|
|
You can restore a virtual machine (VM) from a backup that is on an IBM Spectrum
Protect server.
|
About this task
|
|
You can restore an existing VM by selecting the VM from the cluster or host view
and by using the Restore action in the Actions pane.
|
Procedure
|
1. Start the Data Protection for Microsoft Hyper-V Management Console.
|
2. In the navigation pane, click a host in the cluster or host view.
|
|
3. Select a VM from the VM table in the Virtual Machines view. For example, click
a VM whose data protection status is Normal.
|
|
|
Tip: If you need to restore a VM that was deleted but whose backup is still
available on the IBM Spectrum Protect server, select a VM with the Deleted
status.
|
4. In the Actions pane, click Restore.
|
|
5. Complete the following pages in the Restore wizard as applicable. The pages
that are provided depend on the options that you select in the wizard.
||
Wizard page
Action
|
Before you begin
Click Next to start the wizard.
|
|
|
|
|
Select restore point
The highlighted dates on the calendar
contain restore points. Restore points are VM
backups that are available for restore
operations. Some VMs have more than one
restore point per day.
|
|
|
|
|
Select a date and a restore point from the
Available restore points list. The size of the
VM is listed next to an available restore
point. The VM is restored to the state in
which it existed when it was backed up.
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
69
|
Wizard page
Action
|
|
|
Select options
Create a VM or replace the existing VM with
the data from the selected restore point. The
following options are available:
|
|
|
|
Create a new virtual machine
Create a VM with the data from the
selected restore point. This option is
the default.
|
|
|
|
Replace an existing virtual machine
Replace the existing VM with the
data from the selected restore point.
The VM identifiers are maintained.
|
|
|
|
|
|
|
|
|
|
Virtual machine name
If you are creating a VM, the
default name for the new VM is the
original VM name appended with
the date of the restore operation. If
you do not want to use the default
name, enter a VM name that is not
already used by another VM in the
Hyper-V host or cluster in the entry
field.
|
|
|
If you are replacing an existing VM,
the original VM name is shown.
You cannot update it.
|
|
|
|
Restore virtual machine to
If you are creating a VM, select a
host to which the VM can be
restored.
|
|
|
|
If you are replacing an existing VM,
the VM is restored to the host that
owns the VM. This field is not
selectable.
|
|
Select storage
|
|
|
|
The page appears only if you are creating a
VM with the data from the restore point.
Enter the location on the host where you
want to create the VM. The default location
is C:\ProgramData\Microsoft\Windows\
Hyper-V\Virtual Machines.
|
|
|
Summary
Review the options that you selected in the
wizard. Click Next to start the restore
operation.
|
|
Results
Click Finish to close the wizard.
|
Results
|
|
The restore operation that you started is displayed in the task list at the bottom of
the Virtual Machines view or Schedule History view.
|
|
After the restore operation is completed, the VM is restored in the location that
you selected.
70
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
Best practices for Data Protection for Microsoft Hyper-V
|
|
You can follow best practices to take advantage of features that can help you
manage Data Protection for Microsoft Hyper-V operations.
|
Excluding virtual machines from scheduled backup operations
|
|
|
|
|
If a virtual machine (VM) is undergoing maintenance operations or if it is a test
VM that does not need to be backed up regularly, you can exclude it from
scheduled backup operations. Instead of updating the client options file (dsm.opt)
on every data mover, consider excluding the VMs in the schedule definition on the
IBM Spectrum Protect server.
|
|
|
The IBM Spectrum Protect server administrator can accomplish this task by adding
the -vm=vmname1,vmname2 parameter to the option string on the schedule
definition on a server.
|
|
|
|
|
|
|
|
For example, the administrator defined the following schedule on the IBM
Spectrum Protect server:
|
|
|
|
|
|
|
|
To exclude a VM named testvm1 from scheduled backup operations, update the
-domain.vmfull option in the schedule definition as follows:
|
|
|
|
|
|
|
|
To exclude one or more VMs that begin with the name testvm, update the
-domain.vmfull option in the schedule definition as follows:
|
|
For more information about the -domain.vmfull option, see “Domain.vmfull” on
page 109.
|
Rebinding virtual machines to management classes
|
|
|
If you need to override the management class that is bound to virtual machines
(VMs) by the vmmc option in the client options file, you can use the include.vm
option to bind the VMs to a new management class.
|
|
In a cluster environment, you must set the include.vm option in the options file
(dsm.opt) on all the hosts.
|
|
For instance, you want to back up the VMs in your test environment, but you do
not want the same retention period for the test VM backups as specified by the
define schedule hyperv_domain_name schedule_name
description=schedule_description action=backup subaction=VM
starttime=NOW+00:10 schedstyle=Classic period=1 perunits=Weeks
durunits=minutes duration=10 options=’-vmbackuptype=fullvm
-asnodename=Hyper-V_host_hv_tgt -mode=IFIncremental
-domain.vmfull="all-vm"’
define schedule hyperv_domain_name schedule_name
description=schedule_description action=backup subaction=VM
starttime=NOW+00:10 schedstyle=Classic period=1 perunits=Weeks
durunits=minutes duration=10 options=’-vmbackuptype=fullvm
-asnodename=Hyper-V_host_hv_tgt -mode=IFIncremental
-domain.vmfull="all-vm;-vm=testvm1"’
define schedule hyperv_domain_name schedule_name
description=schedule_description action=backup subaction=VM
starttime=NOW+00:10 schedstyle=Classic period=1 perunits=Weeks
durunits=minutes duration=10 options=’-vmbackuptype=fullvm
-asnodename=Hyper-V_host_hv_tgt -mode=IFIncremental
-domain.vmfull="all-vm;-vm=testvm*"’
Chapter 4. Managing data with the Data Protection for Microsoft Hyper-V Management Console
71
|
|
STANDARD management class. In this case, you can rebind the test VMs to a
management class that has a shorter retention period for backups.
|
|
|
|
For example, to rebind all VMs with names that begin with testvm with the
management class named NONPRODMC, add the following statement to the client
options file (dsm.opt):
|
|
For more information and examples about the include.vm option, see “Vmmc” on
page 134.
include.vm vmtest* NONPRODMC
72
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
Chapter 5. Getting started with file restore operations
|
|
|
|
To restore files from a web-based interface with minimal administrator assistance,
the file restore interface is available for use. After the file restore feature is
configured, the administrator sends the file restore URL to file owners or help desk
personnel so that they can find and restore files.
|
|
|
The web-based interface does not require a file manager application to manually
copy files. When a file owners restore a file, the owners specify a restore point,
search or browse to locate the files, and start the restore operation.
|
|
|
|
|
When the configuration is complete, no administrator interaction is needed to
access or restore files. During the configuration process, the administrator gives the
file owner access to the virtual machine (VM) that contains the file owner's data.
The data can be accessed with local VM credentials so that administrators can
monitor file restore resources. File owner permissions do not have to be managed.
|
|
|
|
In the file restore interface, all users can view demonstration videos to learn about
the IBM Spectrum Protect file restore interface. The Find and Restore Files and
Monitoring Restores videos are displayed when users initially log on to the file
restore interface. Videos are available in English only.
|
“File restore tasks”
|
“Logging in to restore files” on page 76
|
|
File restore tasks
|
|
Different types of users set up and use the file restore feature. File owners, help
desk personnel, and administrators are responsible for different sets of tasks.
|
File owner
|
|
The file owner maintains business data such as text documents, spreadsheets, and
presentation files on virtual machines (VMs).
|
The file owner completes the following tasks to restore individual files and folders:
|
v “Logging in to restore files” on page 76
|
v “Restoring files from a virtual machine backup” on page 76
|
Help desk personnel
|
Personnel in the help-desk environment assists file owners in restoring their data.
|
|
The help desk personnel provides the specific file restore URL for file owners, or
restores files on behalf of the file owners.
|
The help desk personnel completes the following tasks:
|
|
|
v Obtains the file restore URL from the file restore administrator or from the Data
Protection for Microsoft Hyper-V Management Console. For more information,
see Step 5 of “Enabling the environment for file restore operations” on page 35.
|
v “Logging in to restore files” on page 76
|
v “Restoring files from a virtual machine backup” on page 76
© Copyright IBM Corp. 2011, 2017
73
|
File restore administrator
|
|
|
The administrator installs software, schedules VM backup operations to the IBM
Spectrum Protect server, and manages user accounts and permissions in the
Microsoft Hyper-V environment.
|
|
The administrator completes the following tasks to set up the environment for file
restore:
|
1. “Enabling the environment for file restore operations” on page 35
|
|
2. If you expect that file owners will run file restore operations on Linux guest
VMs, complete the following tasks:
a. “Installing the mount proxy feature on Linux systems” on page 22
|
|
b. “Configuring the Linux mount proxy for file restore operations” on page 37
|
|
3. To verify that backup operations are running as expected, wait for a scheduled
backup to be completed or run an ad hoc backup operation of a VM.
|
|
After the environment is ready for file restore operations, the administrator can
complete the following optional tasks:
|
v “Modifying options for file restore operations” on page 39
|
v “Configuring Data Protection for Microsoft Hyper-V log activity” on page 40
|
|
If you no longer have to use file restore operations, you can remove it by following
the instructions:
“Removing the file restore feature” on page 28
|
|
|
File restore prerequisites
|
|
Before you restore files with the IBM Spectrum Protect file restore interface, ensure
that your environment meets the minimum prerequisites.
|
|
|
To enable the file restore feature, IBM Spectrum Protect for Virtual Environments:
Data Protection for Microsoft Hyper-V must be installed on a Hyper-V host
system.
|
|
|
The file restore web service and the underlying Data Protection for Microsoft
Hyper-V environment must be installed, configured, and operational, including the
mount proxy data movers and ISCI services.
|
|
|
|
|
Hyper-V administrators must provide file owners with a URL to connect to the file
restore web interface. When you use the configuration wizard to configure Data
Protection for Microsoft Hyper-V and enable the file restore feature, the URL is
provided at the conclusion of the wizard. For more information, see “Configuring
Data Protection for Microsoft Hyper-V with the wizard” on page 29.
|
Hyper-V virtual machine prerequisites
|
|
|
The following prerequisites apply to the Hyper-V virtual machine (VM) that
contains the files to be restored:
v The VM must be running during the file restore operation.
|
|
v The Windows VM must belong to the same Windows domain as the Hyper-V
host where the IBM Spectrum Protect backup-archive client is installed.
74
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
|
v When a VM is deleted from a Windows domain and restored later, the VM must
rejoin the domain to ensure that the domain trust relationship is reestablished.
Do not attempt a file restore from the VM until the domain trust relationship is
restored.
|
|
|
|
|
|
v If the user does not own the file to be restored, the Microsoft Windows Restore
Files and Directories privilege must be assigned to the user for that virtual
machine.
v For Linux guest VMs, local user authentication is required for the VM.
Authentication is not available through Windows domain, Lightweight Directory
Access Protocol (LDAP), Kerberos, or other network authentication methods.
|
|
|
|
|
|
v For Linux guest VMs on a Red Hat Enterprise Linux 6 operating system, the
ChallengeResponseAuthentication option in the sshd daemon configuration file
(/etc/ssh/sshd_config) must specify YES or be commented out. You can specify
either of the following statements:
|
ChallengeResponseAuthentication yes
#ChallengeResponseAuthentication no
Restart the sshd daemon after you modify this option.
|
Data mover prerequisites
|
|
A specific data mover (backup-archive client) is installed on the Hyper-V host
system that "moves data" from one system to another.
|
|
The Hyper-V host system must belong to the same Windows domain as the VM
that contains the files to be restored.
|
Mount proxy prerequisites
|
|
|
|
The mount proxy system represents the Linux or Windows proxy system that
accesses the mounted virtual machine disks through an iSCSI connection. This
system enables the file systems on the mounted VM disks to be accessible as
restore points to the file restore interface.
|
|
|
|
|
Linux operating systems provide a daemon that activates Logical Volume Manager
(LVM) volume groups as these groups become available to the system. Set this
daemon on the Linux mount proxy system so that LVM volume groups are not
activated as they become available to the system. For instructions about how to set
this daemon, see the appropriate Linux documentation.
|
|
The Windows mount proxy system and Linux mount proxy system must be on the
same subnet.
|
Microsoft Windows domain account prerequisites
|
The following prerequisites apply to Windows domain accounts:
|
|
|
|
v A Windows domain user with local administrator authority is required to create
and access the network share. The administrator enters these credentials in the
Data Protection for Microsoft Hyper-V configuration wizard to enable the
environment for file restore operations.
|
|
|
v A file owner accesses the remote VM that contains the files to be restored with
Windows domain user credentials. These credentials are entered in the file
restore interface during login. Domain user credentials verify that the file owner
Chapter 5. Getting started with file restore operations
75
|
|
|
|
|
|
|
has permission to log in to the remote VM and restore files into the remote VM.
These credentials do not require any special permissions.
v If a file owner uses a Windows domain user account that limits access to specific
computers (instead of access to all computers within the domain), ensure that
the mount proxy system is included in the list of computers that are accessible
to this domain user account. Otherwise, the file owner is unable to log in to the
file restore interface.
|
Tape media prerequisites
|
|
File restore operations from tape media are not supported. The preferred method is
to restore files from disk storage.
|
|
Logging in to restore files
|
|
You can log in to the IBM Spectrum Protect file restore interface to restore your
files with minimal assistance from the administrator.
|
Before you begin
|
|
Ensure that you obtain the URL for the file restore interface from your
administrator.
|
About this task
|
|
When you log in to this interface, you can locate and restore your files at your
convenience.
|
|
|
Procedure
|
|
2. Enter the network name or IP address of the virtual machine (VM) that
contains your files. For example, myhost.mycompany.com.
|
3. Enter the user account that you use to access your files.
1. Access the file restore interface by opening a web browser and entering the
URL that you received from your administrator.
|
|
v For Windows guest operating systems, use the Windows_domain_name\
user_name format.
|
|
v For Linux guest operating systems, use the user name that you use to log on
to the Linux guest VM.
|
4. Enter the user account password and click Log in.
|
Related tasks:
|
“Restoring files from a virtual machine backup”
|
|
Restoring files from a virtual machine backup
|
Locate your files and restore them to a preferred location.
|
Before you begin
|
|
Ensure that you are logged in to the IBM Spectrum Protect file restore interface. A
backup must exist before you can restore your files.
76
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
About this task
|
|
Only those files and directories for which you have permission to view on the
operating system are visible.
|
Procedure
|
|
1. Select a backup by completing the following steps:
a. Click a date in the calendar.
|
b. If necessary, select a time in the Available backups field.
|
c. Click Choose backup.
|
The virtual machine disks or directories are displayed in the table.
|
|
2. Optional: If the default backup is not the one you want, select a different
backup by completing the following steps:
|
a. Click the calendar.
|
b. Click a date in the calendar.
|
c. If necessary, select a time.
|
d. Click Change backup.
|
|
|
|
|
|
Restriction: If you change the backup date or time, any file selections that
you made are lost. However, the new backup loads to the directory where
you previously explored. If that directory is unavailable, the backup loads
to the top directory.
The virtual machine disks or directories are displayed in the table.
3. To select files to restore, complete the following steps:
|
a. Click a disk or directory in the table to view the subdirectories and files.
|
|
|
b. Optional: To search for a file in the current directory and subdirectories,
type a name in the Search field and press Enter. The results are displayed
in the order they are found.
|
|
c. Select one or more files and directories to restore. If you select a directory
that has no contents, the empty directory is not restored.
|
4. Select where to restore files.
|
|
v To restore files and directories to the original location, select Restore to >
Original Location.
|
|
v To restore files and directories to a different location, select Restore to >
Alternate Location.
|
|
|
|
|
|
|
5. After you make your selections, click Restore. If you are restoring files to an
alternative directory, select an existing directory on your virtual machine or
create a directory to place restored files. Then, click Restore. If a file with the
same name exists, the restored file's original modification date and time is
added to the file name. Subsequent restores of the same file contain a number
(_N) after the original modification date and time. For example:
t2.2015-03-07-07-28-03_1.txt
|
What to do next
|
|
Click the restore icon (
) to view information about active and recent restores.
By default, information is kept for 7 days after a restore completes.
|
|
If a restore completed with an error or warning, view additional information by
clicking Details. To save the error or warning information, click Export and save
Chapter 5. Getting started with file restore operations
77
the information in .CSV format.
|
78
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
|
Chapter 6. Protecting virtual machines by using Windows
PowerShell cmdlets
|
|
You can run Data Protection for Microsoft Hyper-V operations by using Microsoft
Windows PowerShell cmdlets (Version 3.0 or later).
|
About this task
|
|
Information about preparing to use PowerShell cmdlets, the list of available
cmdlets, and common tasks that use these cmdlets are provided.
|
|
|
|
Restriction: The PowerShell cmdlets interact with the Data Protection for Microsoft
Hyper-V REST API to protect your virtual machines. You cannot interact with the
REST API directly. You must use the provided PowerShell cmdlets to run Data
Protection for Microsoft Hyper-V operations.
|
|
|
Preparing to use PowerShell cmdlets with Data Protection for
Microsoft Hyper-V
|
|
|
Data Protection for Microsoft Hyper-V includes a set of Windows PowerShell
cmdlets to help you manage Data Protection for Microsoft Hyper-V operations in
your environment.
|
Before you begin
|
|
|
|
Ensure that Microsoft Windows PowerShell 3 or later is available on the system
where Data Protection for Microsoft Hyper-V is installed. To view which version of
PowerShell is installed, enter the following command in a PowerShell session:
|
The number in the Major column is the PowerShell version.
|
About this task
|
|
|
You can run the cmdlets interactively at the PowerShell command line or include
them in scripts that can help you automate Data Protection for Microsoft Hyper-V
operations.
|
You must complete the following steps before you use the cmdlets.
|
Procedure
|
|
1. Start a Microsoft Windows PowerShell or Microsoft Windows PowerShell ISE
session with administrator authority:
PS C:\> $PSVersionTable.PSVersion
|
a. Click Start > All Programs > Accessories > Windows PowerShell.
|
b. Right-click Windows PowerShell and click Run as administrator.
|
|
|
2. Verify that the execution policy is set to RemoteSigned by issuing the following
command:
|
|
If another policy is shown, set the execution policy to RemoteSigned by issuing
the following command:
PS C:\> Get-ExecutionPolicy
© Copyright IBM Corp. 2011, 2017
79
|
PS C:\> Set-ExecutionPolicy RemoteSigned
Tip: The Set-ExecutionPolicy command must be run only once.
3. To make the cmdlets available, import the Data Protection for Microsoft
Hyper-V PowerShell module:
|
|
|
|
|
|
|
|
PS C:\> Import-Module "C:\Program Files\IBM\SpectrumProtect\DPHyperV\dphvModule.dll"
4. Authenticate to Data Protection for Microsoft Hyper-V by using the session
cmdlet:
$cred = Get-Credential -UserName user_name -message "credential"
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
|
where:
|
|
|
user_name
Specifies the account that you use to log in to the Windows system
where Data Protection for Microsoft Hyper-V is installed.
|
|
|
computer_name
Specifies the name of the server where Data Protection for Microsoft
Hyper-V is installed.
|
|
5. Review the list of available cmdlets in “PowerShell cmdlets for Data Protection
for Microsoft Hyper-V.”
|
|
6. Optional: Review the online help for each cmdlet. For more information, see
“Getting help information for PowerShell cmdlets” on page 83.
|
What to do next
|
|
|
|
|
For information about creating, running, monitoring, and troubleshooting scripts
with cmdlets, see Windows PowerShell 3.0 or later documentation. For more
information about Windows PowerShell cmdlets, consistent naming patterns,
parameters, arguments, and syntax, see Microsoft TechNet: Getting Started with
Windows PowerShell.
|
|
PowerShell cmdlets for Data Protection for Microsoft Hyper-V
|
|
Review the Data Protection for Microsoft Hyper-V cmdlets that you can use to
protect your virtual machine (VM) data.
|
|
The following table identifies the cmdlets that are available for Data Protection for
Microsoft Hyper-V.
|
Table 11. PowerShell cmdlets for Data Protection for Microsoft Hyper-V
|
Cmdlet name
Description
|
Backup-DpHvVm
Back up a Hyper-V VM.
|
|
Related command: dsmc backup vm
Get-DpHvBackup
|
Show information about a VM backup.
Related command: dsmc query vm
80
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Table 11. PowerShell cmdlets for Data Protection for Microsoft Hyper-V (continued)
|
Cmdlet name
Description
|
|
Get-DpHvBackupSchedule
Show a list of eligible backup schedules for the VMs in
the Hyper-V host or cluster.
|
|
|
An eligible schedule must be defined by the IBM
Spectrum Protect server administrator, and it must be
defined for a domain that is targeted for Hyper-V VMs.
|
|
|
|
|
|
The schedule definition must include the following
parameters and options:
v The -domain.vmfull="all-vm" option must be specified
in the option string.
v The schedule must contain the ACTION=BACKUP
and SUBACTION=VM parameters.
|
|
Get-DpHvHostConfiguration
Show the configuration information for the Hyper-V host
from the IBM Spectrum Protect server.
|
|
Get-DpHvLastSuccessfulBackup
Show information about recent VM backup operations
that ran in a host or cluster.
|
|
|
|
|
|
|
The following information is returned: the at-risk status
of the VM backup, the backup date, the duration of the
backup, the amount of data that was transmitted, the
type of backup, the host that the VM belongs to (for
clusters), and the name of the schedule that ran.
Get-DpHvPolicyDomain
|
|
Related command: dsmadmc q domain
Get-DpHvScheduleHistory
|
|
|
|
|
|
|
Show a list of policy domains on the IBM Spectrum
Protect server.
Show a list of schedules that ran.
Each schedule that is returned can contain the time that
the schedule started to run, the name of the schedule, the
status of the schedule, the number of VMs that were
backed up or failed to back up, and the duration of the
schedule run.
Get-DpHvScheduleHistoryDetail
|
|
|
Show information for each VM that was backed up in a
schedule run.
Each backup task that is returned can contain the name
of the VM, the status of the backup, the start time of the
backup, and error codes for backups that failed.
|
|
Get-DpHvTask
Show general information about completed and running
tasks.
|
|
Get-DpHvVvm
Show information about the VM inventory on the
Hyper-V host.
|
|
|
|
|
|
|
|
|
Related command: dsmc show vm
Get-DpHvVMAtRisk
Show the current at-risk policy for the VM. The at-risk
policy determines when a VM backup is shown as at-risk
if a backup operation did not occur in a specified time
interval.
The at-risk policy consists of an at-risk type. The at-risk
type is a number and can be 0 (BYPASS), 1 (CUSTOM),
or 2 (DEFAULT). Custom at-risk types have an at-risk
interval in hours.
Chapter 6. Protecting virtual machines by using Windows PowerShell cmdlets
81
|
Table 11. PowerShell cmdlets for Data Protection for Microsoft Hyper-V (continued)
|
Cmdlet name
Description
|
|
Get-DpHvVMBackupHistory
Show the backup history for a VM from the summary
extended table on the IBM Spectrum Protect server.
|
|
|
|
|
Each backup task that is returned can contain the last
run time of a backup, the status of the backup, the
duration of the backup, the amount of data that was
transmitted, the host that the VM belongs to (for
clusters), and any error codes that were returned.
|
|
Get-DpHvVmBackupTaskHistory
Show the VM backup task history that is stored locally
on Data Protection for Microsoft Hyper-V.
|
|
Get-DpHvVmRestoreTaskHistory
Show the VM restore task history that is stored locally on
Data Protection for Microsoft Hyper-V.
|
|
|
|
New-DpHvFsInfo
Creates an FsInfo object for use with the
Set-DpHvVmAtRisk cmdlet. The FsInfo object specifies the
IBM Spectrum Protect file space ID and the name of the
VM for which to set the at-risk policy.
|
|
|
|
New-DpHvNodeInfo
Creates a NodeInfo object for use with the
Set-DpHvHostConfiguration cmdlet. The NodeInfo object
specifies the node name and node type on the Hyper-V
host.
|
|
New-DpHvSession
Authenticate to Data Protection for Microsoft Hyper-V
and start a PowerShell cmdlet session.
|
Receive-DpHvTask
Monitor the backup or restore task.
|
|
Remove-DpHvSession
Close the session with Data Protection for Microsoft
Hyper-V.
|
Restore-DpHvVm
Restore a Hyper-V VM.
|
|
|
Related command: dsmc restore vm
Set-DpHvBackupSchedule
|
|
|
Associate a schedule with a data mover on a Hyper-V
host or cluster.
You can associate a node with a schedule, remove a node
from the schedule, and associate a target node with a
schedule.
|
|
Set-DpHvHostConfiguration
Configure the Hyper-V host for Data Protection for
Microsoft Hyper-V operations.
|
|
Set-DpHvHttpsPort
Sets the HTTPS port that is used for the IBM Spectrum
Protect web server.
|
|
Set-DpHvMmcLoginPreferences
Sets the preferences for the Data Protection for Microsoft
Hyper-V Management Console.
|
|
|
|
Set-DpHvVmAtRisk
Set the at-risk policy for one or more VMs. The at-risk
policy determines when a VM backup is shown as at-risk
if a backup operation did not occur in a specified time
interval.
|
|
|
|
|
|
|
The at-risk policy consists of an at-risk type. The at-risk
type is a number and can be 0 (BYPASS), 1 (CUSTOM),
or 2 (DEFAULT). Custom at-risk types have an at-risk
interval in hours.
Set-ServerConnection
82
Store IBM Spectrum Protect server connection
information on the Hyper-V host and verify the
connection to the server.
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Table 11. PowerShell cmdlets for Data Protection for Microsoft Hyper-V (continued)
|
Cmdlet name
Description
|
|
Show-DpHvHttpsPort
Shows the port information for the IBM Spectrum Protect
web server.
|
|
Show-DpHvMmcLoginPreferences
Shows the preferences for the Data Protection for
Microsoft Hyper-V Management Console.
|
Stop-DpHvTask
Cancel a backup or restore task.
|
|
Test-DomainCredentials
Verify the credentials for the Windows domain user.
|
|
For the list of common tasks for the cmdlets, see “Data Protection for Microsoft
Hyper-V cmdlet examples.”
|
Getting help information for PowerShell cmdlets
|
|
|
Online help is provided for the PowerShell cmdlets. To view the details about a
specific cmdlet, run the Get-Help cmdlet with the cmdlet name:
|
|
For example:
|
|
|
The following examples are for the Backup-DpHvVm cmdlet. To see cmdlet examples,
enter:
|
|
For detailed information, enter:
|
|
For technical information, enter:
|
|
For online product information, enter:
|
|
|
For information about a specific parameter, such as the IFINCREMENTAL parameter,
enter:
|
|
To show the help in a separate window, include the -ShowWindow parameter with
the help command.
|
|
Get-Help cmdlet_name
Get-Help Backup-DpHvVm
Get-Help Backup-DpHvVm -examples
Get-Help Backup-DpHvVm -detailed
Get-Help Backup-DpHvVm -full
Get-Help Backup-DpHvVm -online
help Backup-DpHvVm -Parameter IFINCREMENTAL
Data Protection for Microsoft Hyper-V cmdlet examples
|
|
Examples of Data Protection for Microsoft Hyper-V cmdlets are provided to help
you protect your Hyper-V virtual machines (VMs).
|
|
Before you use the cmdlets, ensure that you complete the steps in “Preparing to
use PowerShell cmdlets with Data Protection for Microsoft Hyper-V” on page 79.
|
|
Examples are provided for commonly used Data Protection for Microsoft Hyper-V
tasks.
Chapter 6. Protecting virtual machines by using Windows PowerShell cmdlets
83
|
|
|
|
|
|
Tips:
v Each cmdlet provides parameters. To view the parameters, issue the following
help command:
|
Example 1: Back up one or more VMs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Run an incremental-forever incremental backup of one or more VMs.
|
|
|
This example starts a PowerShell cmdlet session with Data Protection for Microsoft
Hyper-V, backs up the VMs, queries the VM backup, monitors the backup job, and
ends the session when the backup is completed.
|
Example 2: Query a VM backup
|
|
|
|
|
|
|
Query the IBM Spectrum Protect server file space and show general information
about all VM backups.
|
|
|
|
|
|
Example 3: Verify whether a Hyper-V host is configured for Data
Protection for Microsoft Hyper-V operations
|
|
|
|
|
|
|
Example 4: Store IBM Spectrum Protect server connection
information on the Hyper-V host and verify the connection
help cmdlet_name -ShowWindow
v Online help is available for the cmdlets. For more information, see “Getting help
information for PowerShell cmdlets” on page 83.
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
$vmList = @("vm1","vm2")
$task = Backup-DpHvVm -Session $session -VmName $vmList -mode IFINCREMENTAL
$taskInfo = Get-DpHvTask -Session $session -TaskId $task.taskId
while ("running" -eq $taskInfo.taskState) {
start-sleep -seconds 30
$taskInfo = Get-DpHvTask -Session $session -TaskId $task.taskId
if ($taskInfo.hasMoreData) {
$results = Receive-DpHvTask -Session $session -TaskId $task.taskId
write-verbose -verbose ("Started {0} Duration {1:g} Transferred
{2:N2} MB" -f $results.startTime, ((Get-Date)-$results.startTime),
($results.totalBytesTransferred/1MB))
}
}
$results = Receive-DpHvTask -Session $session -TaskId $task.taskId
$results
Remove-DpHvSession -Session $session
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
$bks = Get-DpHvBackup -Session $session
$bks
Remove-DpHvSession -Session $session
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
Get-DpHvHostConfiguration -Session $session
Remove-DpHvSession -Session $session
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
Set-ServerConnection -Session $session -SPServerName server_name -SPAdmin
admin_name -SPAdminPwd admin_password -SPServerSSLPort port
Remove-DpHvSession -Session $session
84
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
Example 5: Display the policy information on the IBM Spectrum
Protect server
|
|
|
|
|
|
Display information such as the domain name, default management class,
description, and the duration of backup and archive retention:
|
|
Example 6: Configure a Hyper-V host for Data Protection for
Microsoft Hyper-V operations
|
|
|
The following example configures a Hyper-V host by completing the following
tasks:
v Register the target node (cluster node).
|
|
v Register the data mover node and configure it for backup operations (configure
the options file, and create the client acceptor and scheduler services).
|
|
|
|
|
|
|
|
|
|
|
|
|
v Configure the file restore environment if requested (register the Windows and
Linux mount proxy nodes, and create the options file and client acceptor
services). If the file restore feature is enabled, the file restore credential must be
the domain user and password.
|
|
|
|
|
|
Example 7: Show the VM inventory on the Hyper-V host
|
Example 8: Show the backup status of VMs on a host or cluster
|
|
|
|
|
|
|
|
|
The following example returns information about the last VM backups on a host or
cluster.
|
Example 9: Set the at-risk policy for a VM
|
|
The at-risk policy determines that a VM is at risk of being unprotected if a
scheduled backup operation did not occur within a specified time interval.
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
Get-DpHvPolicyDomain -Session $session
Remove-DpHvSession -Session $session
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
Set-ServerConnection -Session $session -SPServerName server_name -SPAdmin
admin_name -SPAdminPwd admin_password -SPServerSSLPort port
$nodesList = @(New-DpHvNodeInfo -NodeName node_name -NodeType node_type)
Set-DpHvHostConfiguration -Session $session -PolicyDomain policy_domain_name
-RegisterTargetNode -TargetNode target_node -NodeList $nodesList -EnableFR
-FRDomainUser domain_name\user_name -FRDomainPwd password
Remove-DpHvSession -Session $session
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
$vms = Get-DpHvVm -Session $session
$vms
Remove-DpHvSession -Session $session
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
$lastBackups = Get-DpHvLastSuccessfulBackup -Session $session
$vmName = $lastBackups | select -first 1 -ExpandProperty name
$vmBackupHistory = Get-DpHvVMBackupHistory -Session $session -vmName $vmName
$vmBackupHistory
Remove-DpHvSession -Session $session
Chapter 6. Protecting virtual machines by using Windows PowerShell cmdlets
85
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The first half of the following example displays at-risk information for all VMs that
have been backed up. The second half of the example updates the at-risk value for
all VMs that begin with "SQL" to 12 hours.
|
Example 10: Show the history of schedule runs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The following example displays a summary of scheduled activity followed by the
details of the most current scheduled activity.
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
$lastBackups = Get-DpHvLastSuccessfulBackup -Session $session
# 1 - display the current at risk value for all vms
$i = 0
$atRiskList = @()
foreach ($backup in $lastBackups) {
$activity = "Checking at risk value for {0}" -f $backup.name
Write-Progress -activity $activity -status "Progress:" -percentcomplete
($i++/$lastBackups.count*100)
$atRisk = Get-DpHvVmAtRisk -session $session -VmName $backup.name
$atRiskList += [pscustomobject]@{VM=$backup.name;AtRiskType=
$atRisk.AtRiskType;AtRiskInterval=$atRisk.AtRiskInterval}
}
$atRiskList | Out-GridView -Title "VM Risk Status" -PassThru
# 2 - set the at-risk value for all VMS that begin with SQL to a custom interval
# of 12 hours
$sqlVms = $lastBackups | where name -like "sql*"
$fsList = @()
foreach ($vm in $sqlVms) {
$fsList += New-DpHvFsInfo -vmName $vm.Name -fsId $vm.FileSpaceId
}
Set-DpHvVmAtRisk -session $session -AtRiskType CUSTOM -AtRiskInterval 12
-FsList $fsList
Remove-DpHvSession -Session $sess
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
$schedHistory = Get-DpHvScheduleHistory -Session $session
$sh = $schedHistory | Sort-Object actualstarttime -Descending | Select-Object
-First 1
$schedHistoryDetail = Get-DpHvScheduleHistoryDetail -Session $session -ScheduleName
$sh.Name -StartTime $sh.ActualStartTime -EndTime $sh.EndTime -NodeList
$sh.NodeList
#"Schedule History Summary"
$schedHistory |
select actualstarttime,name,status,vmsucceeded,vmfailures,duration,nodelist |
sort actualstarttime -desc | ft -AutoSize
#"Details of most recent scheduled activity"
$schedHistoryDetail |
select starttime,datamover,targetnode,name,status,duration,datatransmitted,
backuptype| ft -AutoSize
Remove-DpHvSession -Session $session
86
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
|
Example 11: Associate a schedule with a data mover on a host
or cluster
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can verify a schedule association by running the QUERY ASSOCIATION
command on the IBM Spectrum Protect server.
|
Example 12: Restore one or more VMs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Restore multiple VMs by referencing the backupIDs and restore them with new
names and new restore destinations.
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
# Get a list of schedules from the IBM Spectrum Protect server
$scheduleList = Get-DpHvBackupSchedule -Session $session
$scheduleList | format-table -autosize
# Associate the schedule with the data mover node
Set-DpHvBackupSchedule -Session $sess -ScheduleName "sched0" -Operation define
-DmNodesList hyperv1_HV_DM
# Remove the schedule association
Set-DpHvBackupSchedule -Session $sess -ScheduleName "sched0" -Operation remove
-DmNodesList hyperv1_HV_DM
Remove-DpHvSession -Session $sess
$cred = Get-Credential -Message ’Enter credentials’ -UserName user_name
$session = New-DpHvSession -ComputerName computer_name -Credential $cred
# Restore a single VM with default parameters
$task = Restore-DpHvVm -Session $session -vmname "vm1"
$taskInfo = Get-DpHvTask -Session $session -TaskId $task.taskId
while ("running" -eq $taskInfo.taskState) {
start-sleep -seconds 30
$taskInfo = Get-DpHvTask -Session $session -TaskId $task.taskId
if ($taskInfo.hasMoreData) {
$results = Receive-DpHvTask -Session $session -TaskId $task.taskId
write-verbose -verbose ("Started {0} Duration {1:g} Transferred
{2:N2} MB" -f $results.startTime, ((Get-Date)-$results.startTime),
($results.totalBytesTransferred/1MB))
}
}
$results = Receive-DpHvTask -Session $session -TaskId $task.taskId
$results
# restore multiple vms
$task = Restore-DpHvVm -Session $session -vmname vm1,vm2 -backupId 111111,222222
-newVmName vm1_restored,vm2_restored -targethPath c:\restored,c:\restored
$taskInfo = Get-DpHvTask -Session $session -TaskId $task.taskId
while ("running" -eq $taskInfo.taskState) {
start-sleep -seconds 30
$taskInfo = Get-DpHvTask -Session $session -TaskId $task.taskId
if ($taskInfo.hasMoreData) {
$results = Receive-DpHvTask -Session $session -TaskId $task.taskId
write-verbose -verbose ("Started {0} Duration {1:g} Transferred
{2:N2} MB" -f $results.startTime, ((Get-Date)-$results.startTime),
($results.totalBytesTransferred/1MB))
}
}
$results = Receive-DpHvTask -Session $session -taskId $task.taskId
$results
# Get the restore history of VMs
Chapter 6. Protecting virtual machines by using Windows PowerShell cmdlets
87
|
|
|
|
|
|
$vmRestoreHistory = Get-DpHvVmRestoreTaskHistory -Session $session
$vmRestoreHistory
Remove-DpHvSession -Session $session
Related reference:
“PowerShell cmdlets for Data Protection for Microsoft Hyper-V” on page 80
88
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Chapter 7. Command reference
The following sections contain detailed information about each of the client
commands that are used for IBM Spectrum Protect for Virtual Environments: Data
Protection for Microsoft Hyper-V operations.
Issue these commands from the IBM Spectrum Protect backup-archive command
line client. Start the command line client using either of the following methods on
the Windows system:
v Go to Start > Apps by name > IBM Spectrum Protect > Backup-Archive
Command Line.
v Open an Administrator command prompt window and change to the
backup-archive client installation directory (cd "C:\Program Files\tivoli\tsm\
baclient"). Run dsmc.exe.
To complete these tasks from the IBM Spectrum Protect backup-archive GUI, start
the backup-archive GUI client using either of the following methods on the
Windows system:
v Go to Start > Apps by name > IBM Spectrum Protect > Backup-Archive GUI.
v Open an Administrator command prompt window and change to the
backup-archive client installation directory (cd "C:\Program Files\tivoli\tsm\
baclient"). Run dsm.exe.
Access related GUI task help using either of the following methods:
v Select the help icon and click Help Topics or Getting started.
v You can also press the F1 key to open the Help Topics help.
Reading syntax diagrams
To read a syntax diagram for entering a command, follow the path of the line.
Read from left to right and from top to bottom.
v The ►►─── symbol indicates the beginning of a syntax diagram.
v The ───► symbol at the end of a line indicates that the syntax diagram continues
on the next line.
v The ►─── symbol at the beginning of a line indicates that a syntax diagram
continues from the previous line.
v The ───►◄ symbol indicates the end of a syntax diagram.
Syntax items, such as a keyword or a variable, can be:
v On the line (required element)
v Above the line (default element)
v Below the line (optional element)
Symbols
Enter these symbols exactly as they appear in the syntax diagram.
v * Asterisk
v { } Braces
v : Colon
© Copyright IBM Corp. 2011, 2017
89
v , Comma
v = Equal Sign
v - Hyphen
v () Parentheses
v . Period
v
Space
v " quotation mark
v 'single quotation mark
Variables
Italicized lowercase items such as <var_name> indicate variables. In this example,
you can specify a <var_name> when you enter the cmd_name command.
►► cmd_name
<var_name>
►◄
Repetition
An arrow returning to the left means that the item can be repeated. A character
within the arrow means that you must separate repeated items with that character.
,
►► ▼ repeat
►◄
A footnote (1) by the arrow refers to a limit that tells how many times the item can
be repeated.
,
(1)
►► ▼
repeat
►◄
Notes:
1
Specify repeat up to 5 times.
Required choices
When two or more items are in a stack and one of them is on the line, you must
specify one item.
In this example, you must choose A, B, or C.
►► cmd_name
A
B
C
►◄
Optional choices
When an item is below the line, that item is optional. In the first example, you can
select A or nothing at all.
90
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
►► cmd_name
►◄
A
When two or more items are in a stack below the line, all of them are optional. In
the second example, you can choose A, B, C, or nothing at all.
►► cmd_name
►◄
A
B
C
Repeatable choices
A stack of items followed by an arrow returning to the left indicates that you can
select more than one item, or in some cases, repeat a single item.
In this example, you can select any combination of A, B, or C.
,
►► cmd_name
▼
A
B
C
►◄
Defaults
Defaults are above the line. The default is selected unless you override it, or you
can select the default explicitly. To override the default, include an option from the
stack below the line.
In this example, A is the default. Select either B or C to override A.
A
►► cmd_name
►◄
B
C
Backup VM
Use the backup vm command to back up Hyper-V virtual machines.
You can back up Hyper-V guests that exist on a local disk, a SAN-attached disk, a
Cluster Shared Volume (CSV), or guests that exist on a remote file server share.
Remote file server shares must be on a Windows Server 2012 or later system. In
addition, remote file shares must be Server Message Block (SMB) 3.0 with the File
Server VSS Agent Service installed on the server.
Syntax
Chapter 7. Command reference
91
,
▼ vmname
►► Backup VM
►
,
▼ vmname
:vhdx= disk_location
IFIncremental
► -MODE =
►
IFFull
►
►◄
-VMBACKUPUPDATEGUID
-PREview
-DETail
options
Parameters
vmname
Specifies the name of the virtual machine that you want to back up. To
specify multiple virtual machines, separate multiple virtual machine names
with commas (vm1,VM2,Vm5), or use the domain.vmfull option. The names
are case-sensitive and must match the capitalization that is shown on the
Hyper-V host in the Hyper-V Manager > Virtual Machines view.
Wildcards can be used in virtual machine names.
vmname:vhdx=disk_location
This parameter specifies the virtual machine hard disk (VHDX) to include
in Hyper-V RCT virtual machine backup operations on Windows Server
2016 or later operating systems.
The vmname variable specifies the name of the VM to back up. Wildcard
characters can be used to select VM names that match a pattern. An
asterisk (*) matches any sequence of characters. A question mark (?)
matches any single character.
The :vhdx=disk_location keyword specifies the location of the VM disk to
include in the backup operation. The disk location is specified in the
format "controller_type controller_number
disk_location_number_inside_controller". The controller type must be "SCSI" or
"IDE". For example:
dsmc backup vm "vm1:VHDX=IDE 1 0"
You can obtain the disk location information in the Hyper-V Manager. In
the Virtual Machines view, right-click a VM and click Settings. In the
Hardware section of the Settings window, locate the IDE Controller or SCI
Controller, and click Hard Drive to view the hard disk settings. The
controller number and disk location are displayed in the Controller and
Location fields. You can also obtain the disk location information by
running the Windows PowerShell cmdlet Get-VMHardDiskDrive.
You can exclude a VM disk from backup operations by specifying the
exclude operator (-) before the vhdx= keyword. For example, use -vhdx= to
exclude a VM disk from the backup operation of a VM:
dsmc backup vm "vm1:-VHDX=IDE 1 0:-VHDX=SCSI 0 1"
92
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
If you specify multiple VM disks to include or exclude, the vhdx= or -vhdx=
keyword and associated values must be separated by colons, with no
intervening space characters. For example:
dsmc backup vm "*:-VHDX=IDE 1 0:-VHDX=SCSI 0 1"
If you specify multiple VM names and VM disks, the VM name and
associated values must be separated by semicolons, with no intervening
space characters. For example:
dsmc backup vm "vm1:-VHDX=IDE 1 0:-VHDX=SCSI 0 1;vm2:-VHDX=IDE 1 0:-VHDX=SCSI 0 1"
-MODE
You must specify the backup mode to use when backing up a virtual
machine by adding the -mode parameter on the command line. The
following modes can be specified:
IFFull Incremental-forever-full mode. In this mode, a snapshot of all used
blocks on a virtual machine’s disks are backed up to the server.
The backup includes configuration information, and all of the
disks.
IFIncremental
Incremental-forever-incremental. In this mode, a snapshot is
created of the blocks that have changed since the last incremental
forever backup operation, whether full or incremental. The backup
includes configuration information, and all of the disks.
-VMBACKUPUPDATEGUID
This option updates the globally unique identifier (GUID) for the virtual
machine that you are backing up. This parameter is intended for use only
in the following scenario:
You want to restore an already backed up virtual machine named ORION.
But, before you shut down and replace the copy of ORION that is running
in your production environment, you want to verify the configuration of
the restored virtual machine before you use it to replace the existing
ORION.
1. You restore the ORION virtual machine and give it a new name: dsmc
restore vm Orion -vmname=Orion2
2. You update and verify the ORION2 virtual machine and determine that
it is ready to replace the existing virtual machine that is named
ORION.
3. You power down and delete ORION.
4. You rename ORION2 so it is now named ORION.
5. The next time that you back up ORION, by using either an
incremental-forever full, or incremental-forever-incremental backup, you
add the -VMBACKUPUPDATEGUID parameter to the backup vm command.
This option updates the GUID, on the IBM Spectrum Protect server, so
the new GUID is associated with the stored backups for the ORION
virtual machine. The chain of incremental backups is preserved; there is
no need to delete existing backups and replace them with new backups.
-PREView
This parameter displays additional information about a virtual machine,
including the labels of the virtual hard disks that are in the virtual
machine.
Chapter 7. Command reference
93
When you issue the -preview option, the backup operation does not start.
You must issue the backup command without the -preview option to start
the backup operation.
You can use both the -preview option and the -detail option on the
command to display information about subdisks that are included when
the backup is run. A subdisk is the AVHDX file that is created when a
snapshot is taken of a VHDX file.
-DETail
This parameter displays detailed information about a virtual machine. Use
this option with -preview to view more details about the disks that are
involved in the backup operation.
When you issue the -detail option, the backup operation does not start.
You must issue the backup command without the -detail option to start
the backup operation.
Example commands
The following command starts an incremental-forever incremental backup of a
Hyper-V virtual machine that is named "VM1":
dsmc backup vm VM1 -mode=ifincremental
For Windows Server 2016 or later operating systems: The following command
excludes an IDE disk (with controller number 1 and disk location 0) and a SCSI
disk (with controller number 0 and disk location 1) from an incremental-forever
incremental Hyper-V RCT backup of a virtual machine, "vm2":
dsmc backup vm "vm2:-VHDX=IDE 1 0:-VHDX=SCSI 0 1" -mode=ifincremental
For Windows Server 2016 or later operating systems: The following command
shows the preview of a Hyper-V RCT backup of a virtual machine, "VM05":
dsmc backup vm VM05 -mode=ifincremental -preview
In the command output, the -preview parameter displays the VHDX labels in the
virtual machine. When the -detail parameter is specified with the -preview
parameter, no additional information is shown for Hyper-V RCT backups.
94
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Backup VM command started.
Total number of virtual machines to process: 1
1. VM Name: VM05
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
VM05
Incremental Forever - Incremental
NODE14
NODE14
No
Disk[1]
Name: \\node14\d$\Hyper_V_Virtual_Machine\VM05\Virtual Hard Disks\VM05.vhdx
Capacity:
15.00 GB
Size:
10.91 GB
Status:
included
Disk Type:
VHDX
Number of Subdisk:
0
Controller Location: IDE 0 0
Disk[2]
Name: \\node14\d$\Hyper_V_Virtual_Machine\VM05\Virtual Hard Disks\VM05_Disk2.vhdx
Capacity:
2.00 GB
Size:
132.00 MB
Status:
included
Disk Type:
VHDX
Number of Subdisk:
0
Controller Location: SCSI 0 1
Total number of virtual machines processed: 1
For Windows Server 2012 or 2012 R2: The following command starts an
incremental forever-incremental backup of a Hyper-V virtual machine, "VM3":
dsmc backup vm VM3 -mode=ifincremental -preview
In the command output, the -preview parameter displays the VHDX labels in the
virtual machine:
VM Name: VM3
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
all-vm
Incremental Forever - Incremental
NODE1
NODE1
Yes
Disk[1]
Name: c:\ClusterStorage\Volume1\Hyper-V\VM3\VM3.VHDX
Capacity:
40.00 GB
Size:
9.09 GB
Full Backup:
included
Incremental Backup:
excluded
Disk Type:
VHDX
Number of Subdisk:
1
Disk[2]
Name: c:\ClusterStorage\Volume3\Hyper-V\VM3\VM3-DISK2.VHDX
Capacity:
127.00 GB
Size:
4.00 MB
Full Backup:
included
Incremental Backup:
excluded
Disk Type:
VHDX
Number of Subdisk:
1
When the -detail parameter is specified with the -preview parameter, the VHDX
labels and their subdisks are shown. The following example output is abbreviated
to show only information about one virtual machine and one disk:
Chapter 7. Command reference
95
VM Name: VM3
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
all-vm
Incremental Forever - Incremental
NODE1
NODE1
Yes
Disk[1]
Name: c:\ClusterStorage\Volume1\Hyper-V\VM3\VM3.VHDX
Capacity:
40.00 GB
Size:
9.09 GB
Full Backup:
included
Incremental Backup:
excluded
Disk Type:
VHDX
Number of Subdisk:
1
Subdisk[1]
Name: c:\ClusterStorage\Volume1\Hyper-V\VM3\VM3_9B26166-9C3E.avhdx
Capacity:
40.00 GB
Size:
1.25 GB
Full Backup:
included
Incremental Backup:
included
Disk Type:
AVHDX
Options file examples
In the following examples, the domain.vmfull option is used to process specific
virtual machines.
For Windows Server 2016 or later operating systems: In the following example, the
domain.vmfull option is specified as follows:
domain.vmfull VM04,VM05
The following command shows a preview of a Hyper-V RCT backup of all virtual
machines specified in the domain.vmfull option. The command displays preview
information about each virtual machine:
dsmc backup vm -mode=iffull -preview
The following output is shown:
96
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Backup VM command started.
Total number of virtual machines to process: 2
1. VM Name: VM04
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
VM04
Incremental Forever - Full
NODE14
NODE14
No
Disk[1]
Name: \\node14\d$\Hyper_V_Virtual_Machine\VM04\Virtual Hard Disks\VM04.vhdx
Capacity:
36.00 GB
Size:
9.16 GB
Status:
included
Disk Type:
VHDX
Number of Subdisk:
0
Controller Location: IDE 0 0
2. VM Name: VM05
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
VM05
Incremental Forever - Full
NODE14
NODE14
No
Disk[1]
Name: \\node14\d$\Hyper_V_Virtual_Machine\VM05\Virtual Hard Disks\VM05.vhdx
Capacity:
15.00 GB
Size:
10.91 GB
Status:
included
Disk Type:
VHDX
Number of Subdisk:
0
Controller Location: IDE 0 0
Disk[2]
Name: \\node14\d$\Hyper_V_Virtual_Machine\VM05\Virtual Hard Disks\VM05_Disk2.vhdx
Capacity:
2.00 GB
Size:
132.00 MB
Status:
included
Disk Type:
VHDX
Number of Subdisk:
0
Controller Location: SCSI 0 1
Total number of virtual machines processed: 2
For Windows Server 2012 or 2012 R2: In the following example, the domain.vmfull
option specifies these virtual machines:
domain.vmfull BigVM,myGentoox64,HPV2VM3-OLD,Local10
The following command shows a preview of an incremental-forever incremental
backup operation of all Hyper-V virtual machines specified in the domain.vmfull
option. The command displays preview information about each virtual machine:
dsmc backup vm -mode=iffull -preview
The following output is shown:
Chapter 7. Command reference
97
1. VM Name: BigVM
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
all-vm
Incremental Forever - Full
MSF
MSF
No
Disk[1]
Name: \\lingonberry\c$\Users\michael\Documents\Storage\BigVM.vhdx
Capacity:
5.85 TB
Size:
5.00 MB
Full Backup:
included
Incremental Backup:
excluded
Disk Type:
VHDX
Number of Subdisk:
0
2. VM Name: Gentoox64
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
all-vm
Incremental Forever - Full
MSF
MSF
No
3. VM Name: HPV2VM3-OLD
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
all-vm
Incremental Forever - Full
MSF
MSF
No
4. VM Name: Local10
Domain Keyword:
Mode:
Target Node Name:
Data Mover Node Name:
Cluster Resource:
all-vm
Incremental Forever - Full
MSF
MSF
No
Disk[1]
Name: \\lingonberry\c$\Users\michael\Documents\Storage\Local10.vhdx
Capacity:
127.00 GB
Size:
4.00 MB
Full Backup:
included
Incremental Backup:
excluded
Disk Type:
VHDX
Number of Subdisk:
0
Total number of virtual machines processed: 4
ANS1900I Return code is 0.
ANS1901I Highest return code was 0.
Related links for backing up Hyper-V virtual machines
v “Detail” on page 109
v “Domain.vmfull” on page 109
v “Mbobjrefreshthresh” on page 121
v “Mbpctrefreshthresh” on page 122
v “Mode” on page 120
v “Query VM” on page 100
v “Restore VM” on page 104
98
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Expire
The expire command deactivates the backup objects that you specify in the file
specification or with the filelist option. You can specify an individual file to
expire, or a file that contains a list of files to expire. If OBJTYPE=VM, this command
deactivates the current backup for a virtual machine.
When you are working in interactive mode, a prompt notifies you before files are
expired.
The expire command does not remove workstation files. If you expire a file or
directory that still exists on your workstation, the file or directory is backed up
again during the next incremental backup, unless you exclude the object from
backup processing.
If you expire a directory that contains active files, those files are not displayed in a
subsequent query from the GUI. However, these files are displayed on the
command line, if you specify the correct query with a wildcard character for the
directory.
Note: Because the expire command changes the server picture of the client file
system without changing the client file system, the expire command is not allowed
on files that are on a file system that is monitored by the IBM Spectrum Protect
journal service.
Syntax
OBJTYPE=FILE
filespec
►► EXPire
►
OBJTYPE=VM
vmname
►
►◄
options
Parameters
OBJTYPE=FILE filespec
Specifies a path and a file name that you want to expire. You can enter only
one file specification on this command. However, you can use wildcards to
select a group of files or all the files in a directory. If you specify the filelist
option, the filespec designation is ignored.
OBJTYPE=VM vmname
vmname specifies the name of a virtual machine. The active backup for the
specified virtual machine is expired. The virtual machine name cannot contain
wildcard characters.
When objtype=VM is specified, the expire command expires only full virtual
machine backups (MODE=FULL or MODE=IFFULL) for the virtual machine that is
specified on the vmname parameter.
Table 12. Expire command: Related options
Option
Where to use
dateformat “Dateformat”
on page 107
Client options file (dsm.opt) or command line.
Chapter 7. Command reference
99
Table 12. Expire command: Related options (continued)
Option
Where to use
filelist “Filelist” on
page 114
Command line only.
noprompt “Noprompt” on
page 123
Command line only.
numberformat
“Numberformat” on page
123
Client options file (dsm.opt) or command line.
pick “Pick” on page 125
Command line only.
timeformat “Timeformat”
on page 127
Client user-options file (dsm.opt) or command line.
Examples
Task
Deactivate the letter1.txt file in the home directory.
Command: dsmc expire c:\home\letter1.txt
Task
Deactivate all files in the admin\mydir directory.
Command: dsmc expire c:\admin\mydir\*
Task
Deactivate all files that are named in the c:\avi\filelist.txt file.
Command: dsmc expire -filelist=c:\avi\filelist.txt
Task
Deactivate the current backup of the virtual machine that is named
vm_test.
Command: dsmc expire –objtype=VM vm_test
Query VM
Use the query VM command to list and verify the successful backups of virtual
machines (VMs).
Query VM for Microsoft Hyper-V virtual machines
Use the query vm command to determine which Hyper-V virtual machines were
backed up.
Supported Clients
This command is valid on Windows clients that are installed on a Hyper-V host
system.
Syntax
►► Query VM
vmname
►◄
options
Parameters
vmname
Specifies the virtual machine host name that you want to query. The virtual
100
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
machine name is case-sensitive. If you specify a VM name on the command,
the name cannot contain wildcard characters.
If you omit the virtual machine name, the command displays all VM backups
on the IBM Spectrum Protect server.
Table 13. Query VM command: Related options for Hyper-V virtual machine queries.
Option
Where to use
detail
Command line. Displays the details of
each disk (label, name) and its status
(protected or excluded), and
incremental-forever backup
performance statistics.
inactive
Command line.
pitdate
Command line.
pittime
Command line.
Examples
Task
List all virtual machines that have been backed up by Data Protection for
Microsoft Hyper-V on the Hyper-V host.
dsmc query vm
Query VM examples (Hyper-V)
The following example shows a query VM command that displays summary
information about all Hyper-V virtual machines that have been backed up.
dsmc query vm
Query Virtual Machine for Full VM backup
#
--1
2
3
Backup Date
------------------03/19/2017 17:54:34
03/20/2017 01:51:34
03/20/2017 01:46:19
Mgmt Class Size
---------- ----------STANDARD
17.00 GB
STANDARD
15.00 GB
STANDARD
36.00 GB
Type
A/I Location Virtual Machine
------ --- -------- --------------IFFULL A SERVER
DeptA_VM05
IFINCR A SERVER
DeptA_VM_W2k08R2
IFFULL A SERVER
DeptA_VM04
The following query VM command with the -detail option shows detailed
information about Hyper-V VMs that have been backed up. The detailed output
includes the type of backup that was performed, the size of the virtual machine,
information about its disks, and statistics.
Chapter 7. Command reference
101
dsmc query vm -detail
Query Virtual Machine for Full VM backup
#
--1
Backup Date
Mgmt Class Size
Type
A/I Location Virtual Machine
------------------- ---------- ----------- -------- -------- --------------03/19/2017 17:54:34 STANDARD
17.00 GB IFFULL
A SERVER
DeptA_VM05
The size of this incremental backup: n/a
The number of incremental backups since last full: 0
The amount of extra data: 0
The IBM Spectrum Protect objects fragmentation: 0
Backup is represented by: 99 IBM Spectrum Protect objects
Application protection type: n/a
Backup is compressed: No
Backup is deduplicated: No
Snapshot type: Hyper-V RCT Application Consistent
Disk[1]Name:
DeptA_VM05.vhdx
Disk[1]Location: IDE 0 0
Disk[1]Status:
Protected
Disk[2]Name:
DeptA_VM05_Disk2.vhdx
Disk[2]Location: SCSI 0 1
Disk[2]Status:
Protected
Disk[3]Name:
Disk 7 2.00 GB Bus 0 Lun 4 Target 0
Disk[3]Location: SCSI 0 0
Disk[3]Status:
Skipped: Physical disk
Disk[4]Name:
Disk 8 2.50 GB Bus 0 Lun 5 Target 0
Disk[4]Location: SCSI 0 2
Disk[4]Status:
Skipped: Physical disk
2 03/20/2017 01:51:34 STANDARD
15.00 GB IFINCR
A SERVER
DeptA_VM_W2k08R2
The size of this incremental backup: 544.00 KB
The number of incremental backups since last full: 1
The amount of extra data: 0
The IBM Spectrum Protect objects fragmentation: 2
Backup is represented by: 37 IBM Spectrum Protect objects
Application protection type: n/a
Backup is compressed: No
Backup is deduplicated: No
Snapshot type: Hyper-V RCT Crash Consistent
Disk[1]Name:
DeptA_VM_W2k08R2.vhdx
Disk[1]Location: IDE 0 0
Disk[1]Status:
Protected
3 03/20/2017 01:46:19 STANDARD
36.00 GB IFFULL
A SERVER
DeptA_VM04
The size of this incremental backup: n/a
The number of incremental backups since last full: 0
The amount of extra data: 0
The IBM Spectrum Protect objects fragmentation: 0
Backup is represented by: 79 IBM Spectrum Protect objects
Application protection type: n/a
Backup is compressed: No
Backup is deduplicated: No
Snapshot type: Hyper-V RCT Application Consistent
Disk[1]Name:
DeptA_VM04.vhdx
Disk[1]Location: IDE 0 0
Disk[1]Status:
Protected
----------------------------------------------------------------------------All averages are calculated only for incremental forever backups displayed above.
The average size of incremental backup: 544.00 KB
The average number of incremental backups since last full: 0
The average overhead of extra data: 0
The average objects fragmentation: 0
The average number of objects per backup: 71
The detailed output also includes the snapshot type and disk information such as
the following information:
Snapshot type
The type of snapshot that was taken during the VM backup operation:
102
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Hyper-V RCT Application Consistent
A quiesced snapshot that was created with Hyper-V Resilient
change Tracking (RCT) on Windows Server 2016.
Hyper-V RCT Crash Consistent
A non-quiesced snapshot that was created with Hyper-V RCT on
Windows Server 2016.
Hyper-V VSS
A snapshot that was created with Volume Shadow Copy Service
(VSS) on Windows Server 2012 or Windows Server 2012 R2.
Disk[n]Location
The disk location of VM disk n, where n is a number. The disk location
consists of the disk controller type, "IDE" or "SCSI", followed by the
controller number and device location number.
Disk[n]Status
The backup status of VM disk n, where n is a number.
Protected
Indicates that the data on the VM disk is backed up.
Skipped: Excluded by user
Indicates that the VM disk is excluded during backup operations
as specified by the exclude.vmdisk option.
Skipped: Physical disk
Indicates that the VM disk is a physical disk (pass-through disk)
and its data is not backed up. Only the disk configuration
information is backed up.
The following example shows the syntax to use to list detailed output for a specific
virtual machine named DeptA_VM_W2k08R2.
dsmc query vm DeptA_VM_W2k08R2 -detail
Query Virtual Machine for Full VM backup
#
Backup Date
Mgmt Class Size
Type
A/I Location Virtual Machine
--- ------------------- ---------- ----------- ------ --- -------- --------------1 03/20/2017 01:51:34 STANDARD
15.00 GB IFINCR A SERVER
DeptA_VM_W2k08R2
The size of this incremental backup: 544.00 KB
The number of incremental backups since last full: 1
The amount of extra data: 0
The IBM Spectrum Protect objects fragmentation: 2
Backup is represented by: 37 IBM Spectrum Protect objects
Application protection type: n/a
Backup is compressed: No
Backup is deduplicated: No
Snapshot type: Hyper-V RCT Crash Consistent
Disk[1]Name:
Jimmy_VM_Windows2008R2.vhdx
Disk[1]Location: IDE 0 0
Disk[1]Status:
Protected
----------------------------------------------------------------------------All averages are calculated only for incremental forever backups displayed above.
The average size of incremental backup: 544.00 KB
The average number of incremental backups since last full: 1
The average overhead of extra data: 0
The average objects fragmentation: 2
The average number of objects per backup: 37
Related reference:
“Exclude.vmdisk” on page 112
“Vmprocessvmwithphysdisks” on page 135
Chapter 7. Command reference
103
Restore VM
The restore vm command can be used to restore a Microsoft Hyper-V virtual
machine that was previously backed up by IBM Spectrum Protect for Virtual
Environments: Data Protection for Microsoft Hyper-V.
If the virtual machine that you are restoring exists on the Hyper-V host server, it is
shut down and deleted before it is restored from the image stored on the IBM
Spectrum Protect server. The Restore VM operation then creates the virtual
machine such that its content and configuration is identical to what it was when
the backup occurred. Even though the client shuts down the virtual machine
before deleting it, manually shutting down the virtual machine before running
Restore VM is a good practice to bring any in-progress application activities to an
orderly stop.
Syntax
►► REStore VM
sourcevmspec
►
►
►◄
-targetpath=
path
-vmname=
new_vm_name
options
Parameters
The sourcevmspec parameter is required. The other parameters are optional.
Consider the following scenarios to determine the parameters to use:
v To restore the virtual machine to the original path using the original virtual
machine name, use only the sourcevmspec parameter. The virtual machine is
restored with its original VMware GUID.
v To restore the virtual machine to an alternate path using the original virtual
machine name, use the sourcevmspec and -targetpath parameters. The virtual
machine is restored to the specified path with a new VMware GUID. The virtual
machine in the original path is not deleted.
v To restore the virtual machine to an alternate path using a new virtual machine
name, use the sourcevmspec, -targetpath, and -vmname parameters. The virtual
machine is restored to the specified path with the new name and a new VMware
GUID. The virtual machine with the original name in the original path is not
deleted.
The -vmname parameter is valid only for restoring virtual machines that were
backed up by using iffull or ifincremental modes. This parameter is ignored for
virtual machines that were backed up by using the full or incremental modes that
were provided in previous product releases.
sourcevmspec
Specifies the name of the virtual machine you want to restore. The virtual
machine name is case-sensitive. You cannot use wildcards in the virtual
machine name.
-targetpath=path
Specifies the path that you want to restore the virtual machine to.
This parameter is required if the -vmname parameter is used and optional
otherwise. Use this parameter to restore the virtual machine to an alternate
path.
104
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
-vmname=new_vm_name
Specifies a new name for the virtual machine. The name can contain 1-100
characters. The following characters are not valid: \ / : ; , * ? " ’ < > |
This parameter requires the -targetpath parameter.
Table 14. Restore VM command: Related options when restoring Hyper-V virtual machines
Option
Where to use
inactive
Command line
pick
Command line
pitdate
Command line
pittime
Command line
replace
Command line, client options file, or client preferences
editor.
vmbackdir
Command line, client options file.
Examples
Task
Restore the most recent backup version of a virtual machine named
myVM.
dsmc restore vm myvm
Chapter 7. Command reference
105
106
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Chapter 8. Options reference
The following sections contain detailed information about each of the client options
that are used for IBM Spectrum Protect for Virtual Environments: Data Protection
for Microsoft Hyper-V operations.
Information for each option includes the following information:
v a description
v a syntax diagram
v detailed descriptions of the parameters
v examples of using the option in the client options file (if applicable)
v examples of using the option on the command line (if applicable)
Options with a command-line example of Does not apply cannot be used with
command line or scheduled commands.
Dateformat
The dateformat option specifies the format you want to use to display or enter
dates.
Use this option if you want to change the default date format for the language of
the message repository you are using.
By default, the backup-archive and administrative clients obtain format
information from the locale definition in effect at the time you start the client.
Consult the documentation on your local system for details about setting up your
locale definition.
You can use the dateformat option with the expire command.
When you include the dateformat option with a command, it must precede the
fromdate and pitdate options.
Options File
Place this option in the client options file (dsm.opt). You can set this option on the
Regional Settings tab, Date Format drop-down list of the Preferences editor.
Syntax
►► DATEformat
format_number
►◄
Parameters
format_number
Displays the date using one of the following formats. Select the number that
corresponds to the date format you want to use:
1 MM/DD/YYYY
This is the default for the following available translations:
© Copyright IBM Corp. 2011, 2017
107
2
v US English
v Chinese (Traditional)
v Korean
DD-MM-YYYY
3
This is the default for the following available translations:
v Brazilian Portuguese
v Italian
YYYY-MM-DD
4
This is the default for the following available translations:
v Japanese
v Chinese (Simplified)
v Polish
DD.MM.YYYY
5
This is the default for the following available translations:
v German
v French
v Spanish
v Czech
v Russian
YYYY.MM.DD
6
7
This is the default for the following available translations:
v Hungarian
YYYY/MM/DD
DD/MM/YYYY
Examples
Options file:
dateformat 3
Command line:
-date=3
This option is valid on the initial command line and in interactive mode. If you
use this option in interactive mode, it affects only the command with which it is
specified. When that command completes, the value reverts to the value at the
beginning of the interactive session. This is the value from the dsm.opt file unless
overridden by the initial command line or by an option forced by the server.
Additional considerations for specifying time and date formats
The date or time format you specify with this option must be used when using
options that take date and time as input. Examples are: totime, fromtime, todate,
fromdate, and pittime.
For example, if you specify the timeformat option as TIMEFORMAT 4, the value that
you provide on the fromtime or totime option must be specified as a time such as
12:24:00pm. Specifying 13:24:00 would not be valid because TIMEFORMAT 4 requires
an hour integer that is 12 or less. If you want to specify up to 24 hour values on an
option, and if you want to use commas as separators, you must specify TIMEFORMAT
2.
108
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Detail
Use the detail option to display management class, file space, and backup
information.
Use the detail with the query vm command to display the following statistics:
v The average number of IBM Spectrum Protect objects that are needed to describe
a single megablock, across all megablocks in a backup.
v The average number of IBM Spectrum Protect objects that are needed to describe
a single megablock, for all megablocks in a filespace.
v The number of backups that were created since the last full backup was created
from the production disks.
The values returned on query vm can help you fine tune the heuristics (see the
Mbobjrefreshthresh and Mbpctrefreshthresh options) to fine tune the values
trigger for megablock refreshes.
Syntax
►► DETail
►◄
Parameters
There are no parameters for this option.
Examples
Command line:
dsmc query vm -detail
Domain.vmfull
The domain.vmfull option specifies the virtual machines (VMs) to include in your
full virtual machine image backup operations.
Domain.vmfull for Microsoft Hyper-V virtual machines
For Hyper-V VM backups, use the domain.vmfull option to specify which Hyper-V
VMs are processed when you run a backup vm command, without specifying any
Hyper-V VM names.
You can specify which VMs to process by using any of the following techniques:
v Use the VM= option and specify the name of a virtual machine.
v Provide a comma-separated list of virtual machine names.
v Use wildcard syntax to process virtual machines that match the name pattern.
v Use the vmname:vhdx= option to specify the VM hard disk (VHDX) to include or
exclude during the Hyper-V RCT backup operation of a VM.
v Use the all-vm domain-level parameter. You can also include one or more
virtual machines by using the VM= keyword, or exclude VMs by using the -VM=
syntax.
Chapter 8. Options reference
109
The virtual machines that are specified on the domain.vmfull option are processed
only when the backup vm command is entered without specifying a virtual machine
or a list of virtual machines on the command line.
Attention: For Microsoft Hyper-V operations, the only valid domain-level
parameter for the domain.vmfull option is all-vm. You can also include one or
more virtual machines by using the VM= keyword, or exclude virtual machines by
using the -VM= syntax.
Supported Clients
This option can be used with supported Windows clients. This option can also be
defined on the server.
Options file
Set this option in the client options, by using the command line, or by using the
VM Backup tab of the Preferences editor.
Restriction: The vmname:vhdx=vhdx_location parameter cannot be set in the
Preferences Editor. Include this setting in the options file, or on the command line
when you run a backup vm command:
Syntax for Microsoft Hyper-V virtual machines
;
vmname1,vmname2
►► DOMAIN.VMFUll
▼
►◄
VM=vmname1,vmname2
-VM=vmname1,vmname2
vmname:vhdx=disk_location
-vmname:vhdx=disk_location
ALL-VM
Syntax rules: Multiple keywords must be separated by a semicolon. There cannot
be any spaces after the semicolons. Multiple machine or domain names must be
separated by commas, with no space characters. For examples, see vm=vmname.
Parameters
vmname
Defines the virtual machine name that you want to process. You can supply a
list of virtual machine host names by separating the names with commas
(vm1,VM2,Vm5). The names are case-sensitive and must match the capitalization
that is shown on the Hyper-V host in the Hyper-V Manager > Virtual
Machines view.
vm=vmname
The vm= keyword specifies that the next set of values is a list of virtual
machine names. The vm= keyword is the default and is not required.
In this example, vm= is not specified and commas are used to separate the
machine names.
domain.vmfull my_vm1,my_vm2
110
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
If you specify multiple keywords, such as vm= and -vm=, the values that the
keywords refer to must be separated by semicolons, with no intervening space
characters:
domain.vmfull vm=my_vm1;vm=my_vm2
domain.vmfull -vm=my_vm3;-vm=my_vm4
Wildcard characters can be used to select virtual machine names that match a
pattern. An asterisk (*) matches any sequence of characters. A question mark
(?) matches any single character, for example:
v Exclude all files that have “test” in the host name: -vm=*test*
v Include all virtual machines with names such as: “test20”, “test25”, “test29”,
“test2A”:
vm=test2?
You can exclude a virtual machine from a backup operation by specifying the
exclude operator (-) before the vm= keyword. For example, -vm is used to
exclude a particular machine, or machines, from a domain level backup, such
as, ALL-VM. If “vm1” is the name of a virtual machine, you can back up all of
the virtual machines in the domain, but prevent the virtual machine “vm1”
from being backed up. Set the following option:
domain.vmfull all-vm;-vm=vm1
You cannot use the exclude operator (-) to exclude a domain, such as ALL-VM.
The exclude operator works only at the virtual machine name level.
vmname:vhdx=vhdx_location
This option specifies the location of the virtual machine hard disk (VHDX) to
include in Hyper-V RCT virtual machine backup operations on the Windows
Server 2016 operating system.
The vmname variable specifies the name of the virtual machine to back up.
Wildcard characters can be used to select virtual machine names that match a
pattern. An asterisk (*) matches any sequence of characters. A question mark
(?) matches any single character.
The :vhdx=disk_location keyword specifies the location of the virtual machine
disk to include in the backup operation. The disk location specified by the
disk_location variable must begin with "SCSI" or "IDE" followed by the
controller number and device location number. For example:
domain.vmfull "vm1:VHDX=IDE 1 0"
domain.vmfull "vm*:VHDX=SCSI 0 1"
domain.vmfull "vm?:VHDX=SCSI 0 1"
You can exclude a virtual machine disk from backup operations by specifying
the exclude operator (-) before the vhdx= keyword. For example, use -vhdx= to
exclude a VM disk from the backup operation of a virtual machine. For
example:
domain.vmfull "vm1:-VHDX=IDE 1 0"
If you specify multiple virtual machine disks to include or exclude, the vhdx=
or -vhdx= keyword and associated values must be separated by colons, with no
intervening space characters. For example:
domain.vmfull "vm1:vhdx=IDE 1 0:vhdx=SCSI 0 1"
If you specify multiple virtual machine names and virtual machine disks, the
VM name and associated values must be separated by semicolons, with no
intervening space characters. For example:
domain.vmfull "vm1:VHDX=IDE 1 0:VHDX=SCSI 0 1;vm2:VHDX=IDE 1 0:VHDX=SCSI 0 1"
domain.vmfull "vm1:-VHDX=IDE 1 0:-VHDX=SCSI 0 1;vm2:-VHDX=IDE 1 0:-VHDX=SCSI 0 1"
Chapter 8. Options reference
111
all-vm
This option specifies that a backup vm operation processes all Hyper-V virtual
machines that are known to the Hyper-V host.
Examples for Microsoft Hyper-V virtual machines
Options file:
Include all virtual machines in full VM backup operations.
domain.vmfull all-vm
Include all virtual machines in full VM backup operations, except for the
ones that have a name suffix of _test.
domain.vmfull all-vm;-vm=*_test
Include all virtual machines in full VM backup operations, but exclude
virtual machines testvm1 and testmvm2.
domain.vmfull all-vm;-VM=testvm1,testvm2
Include IDE disks (with controller 1 and disk location 0) and SCSI disks
(with controller 0 and disk location 1) in Hyper-V RCT backup operations
of virtual machines vm1 and vm2.
domain.vmfull "vm1:VHDX=IDE 1 0:VHDX=SCSI 0 1;vm2:VHDX=IDE 1 0:VHDX=SCSI 0 1"
Restriction: You cannot use the all-vm option together with the
vmname:-vhdx= option in the options file or on the command line.
Exclude.vmdisk
The EXCLUDE.VMDISK option excludes a virtual machine disk from backup
operations.
The EXCLUDE.VMDISK option specifies the label of a virtual machine's disk to be
excluded from a backup vm operation. If you exclude a disk on the backup vm
command, the command-line parameters override any EXCLUDE.VMDISK statements
in the options file.
EXCLUDE.VMDISK for Microsoft Hyper-V virtual machines
Use the EXCLUDE.VMDISK option to exclude a virtual machine disk from Hyper-V
RCT backup operations on Windows Server 2016 or later operating systems.
During a VM restore operation, an informational message is displayed to indicate
that a VM disk is not restored because it was excluded during the backup
operation. The restore operation also verifies whether the original disk file still
exists in the restore destination folder. If the original disk file still exists, it is
reconnected to the restored VM. Otherwise, an empty disk file is created with the
same attributes (such as file name, disk size, and block size) and the empty disk
file is connected to the restored VM.
After a restore operation, the controller and disk order in the restored VM remains
the same as the original VM. You do not have to adjust the disk location in the
EXCLUDE.VMDISK option for future backup operations of the restored VM.
However, if you remove a SCSI controller manually, all subsequent SCSI
controllers' numbers are changed. For example, if you remove "SCSI 0", the next
SCSI controller (previously "SCSI 1") becomes "SCSI 0". In this case, you must
update the VM disk location in the EXCLUDE.VMDISK option.
112
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
The disk location information such as "SCSI 0 0" is displayed in messages for
backup, restore, and query operations.
Supported clients
This option can be used with Windows Server 2016 or later clients.
Options file
Set this option in the client options file. Command-line parameters override
statements in the options file.
Syntax
►► EXCLUDE.VMDISK
vmname
disk_location
►◄
Parameters
vmname
Specifies the name of the VM that contains a disk that you want to exclude
from a backup vm operation. The name is the virtual machine display name.
You can specify only one VM name on each EXCLUDE.VMDISK statement. Specify
additional EXCLUDE.VMDISK statements for each VM disk to exclude.
The VM name can contain an asterisk (*) to match any character string, and a
question mark (?) to match any one character. If the VM name contains space
characters, surround the name with quotation marks (“ ”).
Tip: If the VM name contains special characters, such as bracket characters ([)
or (]), the VM name might not be correctly matched. If a VM name includes
special characters, use a question mark (?) to represent the special characters.
For example, to exclude a SCSI virtual machine disk from the backup of a VM
named "Windows VM3 [2012R2]", use this syntax in the options file:
EXCLUDE.VMDISK "Windows VM3 ?2012R2?" "SCSI 0 1"
disk_location
Specify the location of the virtual machine hard disk (VHDX) to exclude from
a Hyper-V RCT backup operation. The disk location label must begin with
"SCSI" or "IDE" followed by the controller number and device location number.
Wildcard characters are not allowed.
Tip: Use the backup vm command with the -preview option to determine the
location of disks in a given VM. See the "Backup VM" topic for the syntax.
Examples
Options file
Exclude the Windows system disk from all virtual machines that begin
with WinVM in the following statement in the options file:
exclude.vmdisk WinVM* "IDE 0 0"
Virtual machine vm1 contains a virtual machine disk with IDE controller
number 1 and device location 0. To exclude this virtual machine disk from
backup vm operations, specify the following statement in the options file:
EXCLUDE.VMDISK vm1 "IDE 1 0"
Chapter 8. Options reference
113
Virtual machine vm2 contains a virtual machine disk with SCSI controller
number 0 and device location 1. Exclude this disk from backup operations
by specifying the following statement in the options file:
EXCLUDE.VMDISK vm2 "SCSI 0 1"
Command line
The command line examples show the use of the exclusion operator (-)
before the vhdx= keyword, to indicate that the disk is to be excluded.
Exclude an IDE disk (with controller number 1 and device location 0) from
the backup operation of virtual machine vm1:
dsmc backup vm "vm1:-vhdx=IDE 1 0"
Exclude a SCSI disk (with controller number 0 and device location 1) from
the backup operation of virtual machine vm2:
dsmc backup vm "vm2:-vhdx=SCSI 0 1"
Restriction: You cannot use the all-vm option together with the
vmname:-vhdx= option on the command line or in the options file.
Related reference:
“Backup VM” on page 91
“Restore VM” on page 104
“Domain.vmfull” on page 109
“Include.vmdisk” on page 117
Filelist
Use the filelist option to process a list of files.
You can use the filelist option with the expire command.
The IBM Spectrum Protect client opens the file you specify with this option and
processes the list of files within according to the specific command. When you use
the filelist option, IBM Spectrum Protect ignores all other file specifications on
the command line.
The files (entries) listed in the filelist must adhere to the following rules:
v Each entry must be a fully-qualified or a relative path to a file or directory. Note
that if you include a directory in a filelist entry, the directory is backed up, but
the contents of the directory are not.
v Each path must be specified on a single line. A line can contain only one path.
v Paths must not contain control characters, such as 0x18 (CTRL-X), 0x19 (CTRL-Y)
and 0x0A (newline).
v The filelist can be an MBCS file or a Unicode file with all Unicode entries.
v Any IBM Spectrum Protect filelist entry that does not comply with these rules is
ignored.
The following are examples of valid paths in a filelist:
c:\myfiles\directory\file1
c:\tivoli\mydir\yourfile.doc
..\notes\avi\dir1
..\fs1\dir2\file3
"d:\fs2\Ha Ha Ha\file.txt"
"d:\fs3\file.txt"
114
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
You can use the filelist option during an open file support operation. In this
case, IBM Spectrum Protect processes the entries in the filelist from the virtual
volume instead of the real volume.
If an entry in the filelist indicates a directory, only that directory is processed and
not the files within the directory.
If the file name (the filelistspec) you specify with the filelist option does not
exist, the command fails. IBM Spectrum Protect skips any entries in the filelist that
are not valid files or directories. IBM Spectrum Protect logs errors and processing
continues to the next entry.
The entries in the list are processed in the order they appear in the filelist. For
optimal processing performance, pre-sort the filelist by file space name and path.
Tip: IBM Spectrum Protect might back up a directory twice if the following
conditions exist:
v The filelist contains an entry for the directory
v The filelist contains one or more entries for files within that directory
v No backup of the directory exists
For example, your filelist includes the entries c:\dir0\myfile and c:\dir0. If the
\dir0 directory does not exist on the server, the c:\dir0 directory is sent to the
server a second time.
Syntax
►► FILEList =
filelistspec
►◄
Parameters
filelistspec
Specifies the location and name of the file that contains the list of files to
process with the command.
Note: When you specify the filelist option on the command line, the subdir
option is ignored.
Examples
Command line:
sel -filelist=c:\avi\filelist.txt
Inactive
Use the inactive option to display both active and inactive objects.
You can use the inactive option with the query vm and restore vm commands.
Important: When using the inactive option during a restore operation, also use
the pick option because all versions are restored in an indeterminate order. This
option is implicit when pitdate is used.
Chapter 8. Options reference
115
Syntax
►► INActive
►◄
Parameters
There are no parameters for this option.
Examples
Command line:
dsmc restore vm VM1 -inactive
Include.vm
This option overrides the management class that is specified on the vmmc option.
The management class specified on the vmmc option applies to all backups. You can
use the include.vm option to override that management class, for one or more
virtual machines. The include.vm option does not override or affect the
management class that is specified by the vmctlmc option. The vmctlmc option
binds backed-up virtual machine control files to a specific management class.
Options File
Set this option in the client options file.
Syntax
►► INCLUDE.VM
vmname
►◄
mgmtclassname
Parameters
vmname
Required parameter. Specifies the name of a virtual machine that you want to
bind to the specified management class. Only one virtual machine can be
specified on each include.vm statement. However, you can specify as many
include.vm statements as needed to bind each virtual machine to a specific
management class.
You can include wildcards in the virtual machine name. An asterisk (*)
matches any character string. A question mark (?) matches a single character. If
the virtual machine name contains a space character, enclose the name in
double quotation marks (").
Tip: If the virtual machine name contains special characters, type the question
mark wildcard in place of the special characters when you specify the virtual
machine name.
mgmtclassname
Optional parameter. Specifies the management class to use when the specified
virtual machine is backed up. If this parameter is not specified, the
management class defaults to the global virtual machine management class
that is specified by the vmmc option.
116
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Examples
Assume that the following management classes exist and are active on the IBM
Spectrum Protect server:
v MCFORTESTVMS
v MCFORPRODVMS
v MCUNIQUEVM
Example 1
The following include.vm statement in the client options file binds all
virtual machines that have names that begin with VMTEST to the
management class called MCFORTESTVMS:
include.vm vmtest* MCFORTESTVMS
Example 2
The following include.vm statement in the client options file binds a
virtual machine that is named WHOPPER VM1 [PRODUCTION] to the
management class called MCFORPRODVMS:
include.vm "WHOPPER VM1 ?PRODUCTION?" MCFORPRODVMS
The virtual machine name must be enclosed in quotation marks because it
contains space characters. Also, the question mark wildcard is used to
match the special characters in the virtual machine name.
Example 3
The following include.vm statement in the client options file binds a
virtual machine that is named VM1 to a management class that is named
MCUNIQUEVM:
include.vm VM1 MCUNIQUEVM
Related information
“Vmmc” on page 134
Include.vmdisk
The INCLUDE.VMDISK option includes a virtual machine (VM) disk in backup
operations. If you do not specify one or more disk labels, all disks in the VM are
backed up.
The INCLUDE.VMDISK option specifies the label of a VM disk to be included in a
backup vm operation. If you include a disk on the backup vm command, the
command-line parameters override any INCLUDE.VMDISK statements in the options
file.
INCLUDE.VMDISK for Microsoft Hyper-V virtual machines
Use the INCLUDE.VMDISK option to include a VM disk from Hyper-V RCT backup
operations on Windows Server 2016 or later operating systems.
Supported clients
This option can be used with Windows Server 2016 or later clients.
Chapter 8. Options reference
117
Options file
Set this option in the client options file. Command-line parameters override
statements in the options file.
Syntax for Microsoft Hyper-V virtual machines
►► INCLUDE.VMDISK
vmname
disk_location
►◄
Parameters
vmname
Specifies the name of the VM that contains a disk that you want to include
from a backup vm operation. The name is the virtual machine display name.
You can specify only one VM name on each INCLUDE.VMDISK statement. Specify
additional INCLUDE.VMDISK statements for each VM disk to include.
The VM name can contain an asterisk (*) to match any character string, and a
question mark (?) to match any one character. If the VM name contains space
characters, surround the VM name with quotation marks (“ ”).
Tip: If the VM name contains special characters, such as bracket characters ([)
or (]), the VM name might not be correctly matched. If a VM name includes
special characters, use a question mark (?) to represent the special characters.
For example, to include a SCSI VM disk in the backup of a virtual machine
named "Windows VM3 [2012R2]", use this syntax in the options file:
INCLUDE.VMDISK "Windows VM3 ?2012R2?" "SCSI 0 1"
disk_location
Specify the location of the VM disk to include in a Hyper-V RCT backup
operation. The disk location label must begin with "SCSI" or "IDE" followed by
the controller number and device location number. Wildcard characters are not
allowed.
Tip: Use the backup vm command with the -preview option to determine the
location of disks in a given virtual machine. See the "Backup VM" topic for the
syntax.
Examples
Options file
Virtual machine vm1 contains an IDE VM disk (VHDX) at controller
number 1 and device location 0. To include this VHDX in backup vm
operations, specify the following statement in the options file:
INCLUDE.VMDISK vm1 "IDE 1 0"
Virtual machine vm2 contains a SCSI VM disk at controller number 0 and
device location 1. Include this VHDX in backup operations by specifying
the following statement in the options file:
INCLUDE.VMDISK vm2 "SCSI 0 1"
Command line
Include a single IDE disk (at controller number 1 and device location 0)
when virtual machine vm1 is backed up:
dsmc backup vm "vm1:vhdx=IDE 1 0"
118
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Include a SCSI disk (at controller number 0 and device location 1) in the
backup operation of virtual machine vm2:
dsmc backup vm "vm2:vhdx=SCSI 0 1"
Related reference:
“Backup VM” on page 91
“Restore VM” on page 104
“Domain.vmfull” on page 109
“Exclude.vmdisk” on page 112
INCLUDE.VMSNAPSHOTATTEMPTS
Use the INCLUDE.VMSNAPSHOTATTEMPTS option to determine the total number of
snapshot attempts to try for a virtual machine (VM) backup operation that fails
due to snapshot failure.
Supported Clients
This option can be used with supported Windows clients that are configured to
back up VMs on Hyper-V hosts that run on Windows Server 2016 operating
systems.
Options File
This option is valid in the client options file (dsm.opt). It can also be included on
the server in a client options set. It is not valid on the command line.
Syntax
►► INCLUDE.VMSNAPSHOTATTEMPTS
vmname num_with_quiescing
►
► num_without_quiescing
►◄
Parameters
vmname
A required positional parameter that specifies the name of the virtual machine
to attempt the total number of snapshots for, if a backup attempt fails due to
snapshot failure. The name is the virtual machine display name.
Only one virtual machine can be specified on each
INCLUDE.VMSNAPSHOTATTEMPTS statement. However, to configure the total
snapshot attempts for other virtual machines, you can use the following
methods:
v For each virtual machine that you want this option to apply to, specify as
many INCLUDE.VMSNAPSHOTATTEMPTS statements as needed to reattempt
snapshots that failed.
v Use wildcard characters for the vmname parameter value to specify virtual
machine names that match the wildcard pattern. An asterisk (*) matches any
character string. A question mark (?) matches a single character. If the virtual
machine name contains a space character, enclose the name in double
quotation marks (").
Chapter 8. Options reference
119
Tip: If the virtual machine name contains special characters, type the question
mark wildcard (?) in place of the special characters when you specify the
virtual machine name.
num_with_quiescing
A positional parameter that specifies the following action:
For Hyper-V RCT backup operations:
The num_with_quiescing parameter specifies the number of times to
attempt snapshots with quiescing to create application-consistent
backups.
You can specify a value in the range 0 - 10. The default value is 2.
num_without_quiescing
For Hyper-V RCT backup operations:
The num_without_quiescing option specifies the number of times to
attempt snapshots without quiescing after the specified number of
attempts in the num_with_quiescing option are completed.
You can specify a value in the range 0 - 10. The default value is 0.
Important: When this parameter is applied to a VM backup, the
backup is considered crash-consistent. As a result, operating system,
file system, and application consistency are not guaranteed. An
include.vmsnapshotattempts 0 0 entry is not valid. Backup operations
require at least one snapshot.
Examples
Hyper-V examples:
Example 1
Specify the following statement in the client options file to make two total
snapshot attempts at crash-consistent backups for all Hyper-V VMs that
begin with LinuxVM:
INCLUDE.VMSNAPSHOTATTEMPTS LinuxVM* 0 2
Example 2
Specify the following statement in the client options file to try three
snapshot attempts for virtual machine VM1: two application-consistent
snapshot attempts, and if they fail, to try one crash-consistent snapshot
attempt:
INCLUDE.VMSNAPSHOTATTEMPTS VM1 2 1
Mode
Use the mode option to specify the backup mode to use when performing specific
backup operations.
You can use the mode option with the backup vm command. this parameter specifies
whether to perform a full image backup, an incremental-forever full backup, or an
incremental-forever-incremental backup of Hyper-V virtual machines.
The mode option has no effect on a when backing up a raw logical device.
120
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Syntax
IFIncremental
►► MODE =
►◄
IFFull
Parameters
IFIncremental
Specifies that you want to perform an incremental-forever-incremental backup
of a Hyper-V virtual machine. An incremental-forever-incremental backup
backs up only the disk blocks that have changed since the last backup. This is
the default backup mode.
You cannot use this backup mode to back up a virtual machine if the client is
configured to encrypt the backup data.
IFFull
Specifies that you want to perform an incremental-forever-full backup of a
Hyper-V virtual machine. An incremental-forever-full backup backs up all used
blocks on a virtual machine's disks. By default, the first backup of a Hyper-V
virtual machine is an incremental-forever-full (mode=iffull) backup, even if
you specify mode=ifincremental (or let the mode option default). Subsequent
backups default to mode=ifincremental.
You cannot use this backup mode to back up a virtual machine if the client is
configured to encrypt the backup data.
Examples
Task
Perform an incremental-forever-full VM backup of a Windows Hyper-V
VM named msvm1
dsmc backup vm msvm1 -mode=iffull
Task
Perform an incremental-forever-incremental backup of a Windows Hyper-V
VM named msvm1
dsmc backup vm msvm1 -mode=ifincremental
Related reference:
“Backup VM” on page 91
Mbobjrefreshthresh
The mbobjrefreshthresh (megablock object refresh threshold) option is a number
defining a threshold. When the number of IBM Spectrum Protect objects that are
needed to describe any 128 MB megablock exceeds this value, the entire megablock
is refreshed and the objects that were used to represent this area, in previous
backups, are expired.
When you backup a virtual machine, the data is stored on the IBM Spectrum
Protect server in 128 MB units, called megablocks. If an area on the production disk
changes and a new incremental backup is performed, a new megablock is created
to represent the changes that were made to the previously backed up data. Because
a new megablock can be created with each incremental backup, eventually the
megablocks can adversely affect the performance of the IBM Spectrum Protect
database, and therefore, adversely affect the performance of most IBM Spectrum
Protect operations.
Chapter 8. Options reference
121
Use this option when estimating IBM Spectrum Protect objects that represent
production data for each virtual machine backup. For example, when the number
of IBM Spectrum Protect objects exceed this value, the megablock is refreshed. This
action means that the entire 128-MB block is copied to the IBM Spectrum Protect
server and is represented as a single IBM Spectrum Protect object. The minimum
value is 2 and the maximum value is 8192. The default value is 50.
Options file
This option is valid in the client options file (dsm.opt). It can also be included on
the server in a client options set. It is not valid on the command line.
Syntax
50
►► MBOBJREFRESHTHRESH
►◄
integer
Parameters
The minimum value you can specify is 2 megablocks, the largest value is 8192
megablocks; the default is 50 megablocks.
Examples
Set this option to trigger a megablock refresh when the number of objects needed
to represent an updated megablock exceeds 20 objects:
MBOBJREFRESHTHRESH 20
Mbpctrefreshthresh
The mbpctrefreshthresh (megablock percentage refresh threshold) option is a
number defining a threshold. When the number of IBM Spectrum Protect
percentage of objects that are needed to describe any 128 MB megablock exceeds
this value, the entire megablock is refreshed and the objects that were used to
represent this area, in previous backups, are expired.
When you backup a virtual machine, data is stored on the IBM Spectrum Protect
server in 128 MB units, called megablocks. If an area on the production disk changes
and a new incremental backup is performed, a new megablock is created to
represent the changes that were made to the previously backed up data. Because a
new megablock can be created with each incremental backup, eventually the
megablocks can adversely affect the performance of the IBM Spectrum Protect
database, and therefore, adversely affect the performance of most IBM Spectrum
Protect operations.
Use this option when estimating the amount of additional data that is backed up
for each virtual machine. For example, when a 128-MB block of a production disk
changes more than the percentage specified, the entire 128-MB block is copied to
the IBM Spectrum Protect server. The block is represented as a single IBM
Spectrum Protect object.
122
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Options file
This option is valid in the client options file (dsm.opt). It can also be included on
the server in a client options set. It is not valid on the command line.
Syntax
50
►► MBPCTREFRESHTHRESH
►◄
integer
Parameters
The minimum value you can specify is 1 percent, the largest value is 99 percent;
the default is 50 percent.
Examples
Set this option to trigger a megablock refresh when 50 percent (or more) of the
objects in a megablock on a production disk have changed:
MBPCTREFRESHTHRESHOLD 50
Noprompt
The noprompt option suppresses the confirmation prompt that is presented by the
expire command.
Use the noprompt option with the expire command.
Syntax
►► NOPrompt
►◄
Parameters
There are no parameters for this option.
Examples
Command line:
dsmc expire -noprompt c:\home\project\*
Numberformat
The numberformat option specifies the format you want to use to display numbers.
Use this option if you want to change the default number format for the language
of the message repository you are using.
By default, format information is obtained from the locale definition in effect at the
time the client is called. Consult the documentation on your local system for
details about setting up your locale definition.
You can only use the numberformat option with the expire command.
Chapter 8. Options reference
123
Options File
Place this option in the client user-options file (dsm.opt). You can set this option on
the Regional Settings tab, Number Format field of the Preferences editor.
Syntax
►► NUMberformat
number
►◄
Parameters
number
Displays numbers using any one of the following formats. Specify the number
(0–6) that corresponds to the number format you want to use.
0
Use the locale-specified date format. This is the default (does not apply to
Mac OS X).
1
1,000.00
This is the default for the following available translations:
v US English
v Japanese
v Chinese (Traditional)
v Chinese (Simplified)
v Korean
2
1,000,00
3
1 000,00
This is the default for the following available translations:
v French
v Czech
v Hungarian
v Polish
v Russian
4
1 000.00
5
1.000,00
This is the default for the following available translations:
v Brazilian Portuguese
v German
v Italian
v Spanish
6
1'000,00
Examples
Options file:
num 4
Command line:
-numberformat=4
124
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
This option is valid on the initial command line and in interactive mode. If you
use this option in interactive mode, it affects only the command with which it is
specified. When that command completes, the value reverts to the value at the
beginning of the interactive session. This is the value from the dsm.opt file unless
overridden by the initial command line or by an option forced by the server.
Pick
The pick option creates a list of backup versions or archive copies that match the
file specification you enter.
From the list, you can select the versions to process. Include the inactive option to
view both active and inactive objects.
Use the pick option with the restore vm command.
Syntax
►► PIck
►◄
Parameters
There are no parameters for this option.
Examples
Command line:
dsmc restore vm vmfin* -pick -inactive
Pitdate
Use the pitdate option with the pittime option to establish a point in time to
display or restore the latest version of your backups.
Files that were backed up on or before the date and time you specify, and which
were not deleted before the date and time you specify, are processed. Backup
versions that you create after this date and time are ignored.
Use the pitdate option with the query vm and restore vm commands.
When pitdate is used, the inactive and latest options are implicit.
Syntax
►► PITDate =
date
►◄
Parameters
date
Specifies the appropriate date.
Examples
Command line:
dsmc restore vm vmfin3 -pitdate=02/21/2014
Chapter 8. Options reference
125
Pittime
Use the pittime option with the pitdate option to establish a point in time to
display or restore the latest version of your backups.
Files that were backed up on or before the date and time you specify, and which
were not deleted before the date and time you specify, are processed. Backup
versions that you create after this date and time are ignored. This option is ignored
if you do not specify pitdate option.
Use the pittime option with the query vm and restore vm commands.
Syntax
►► PITTime =
time
►◄
Parameters
time
Specifies a time on a specified date. If you do not specify a time, the time
defaults to 23:59:59.
Examples
Command line:
dsmc query vm vmfin1 -pitt=06:00:00 -pitd=02/03/2014
Skipsystemexclude
Use the skipsystemexclude option to specify how to process exclude statements for
certain operating system files that the IBM Spectrum Protect for Virtual
Environments client skips by default.
By default, IBM Spectrum Protect for Virtual Environments clients skip certain
Windows operating system files that are not normally required for system recovery
during virtual machine (VM) backup operations. These files can include Windows
system files, temporary internet files, and files in the Recycle Bin.
You can use this option to skip the processing of exclude statements for these
operating system files. By not processing these exclude statements, the time it takes
to back up VMs might be reduced.
Support clients
This option is valid for IBM Spectrum Protect for Virtual Environments clients on
Windows operating systems only.
Options file
This option is valid in the client options file (dsm.opt) or on the command line. The
option can be set in the client option set on the IBM Spectrum Protect server.
Syntax
126
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Yes
►► SKIPSYSTemexclude
►◄
No
Parameters
Yes
Specify this parameter to skip the processing of exclude statements for certain
Windows operating system files during VM backup operations. This parameter
is the default.
No Specify this parameter to process exclude statements of Windows operating
system files. When you select this parameter and run a file backup of the
Hyper-V host, the operating system files are excluded.
Examples
Options file
SKIPSYSTemexclude yes
Command line
dsmc backup vm -SKIPSYST=yes
dsmc incr -skipsyst=no
Timeformat
The timeformat option specifies the format in which you want to display and enter
system time.
Use this option if you want to change the default time format for the language of
the message repository you are using.
By default, format information is obtained from the locale definition in effect at the
time the client is called. Consult the documentation on your local system for
details about setting up your locale definition.
You can only use the timeformat option with the expire command.
When you include the timeformat option with a command, it must precede the
fromtime, pittime, and totime options.
Options File
Place this option in the client options file (dsm.opt). You can set this option on the
Regional Settings tab, Time Format field of the Preferences editor.
Syntax
►► TIMEformat
format_number
►◄
Parameters
format_number
Displays time in one of the formats listed here. Select the format number that
corresponds to the format you want to use. When you include the timeformat
option in a command, it must precede the pittime option.
Chapter 8. Options reference
127
1
2
3
4
5
23:00:00
23,00,00
23.00.00
12:00:00 A/P
A/P 12:00:00
Examples
Options file:
timeformat 4
Command line:
-time=3
This option is valid on the initial command line and in interactive mode. If you
use this option in interactive mode, it affects only the command with which it is
specified. When that command completes, the value reverts to the value at the
beginning of the interactive session. This is the value from the dsm.opt file unless
overridden by the initial command line or by an option forced by the server.
Additional considerations for specifying time and date formats
The date or time format you specify with this option must be used when using
options that take date and time as input. Examples are: totime, fromtime, todate,
fromdate, and pittime.
For example, if you specify the timeformat option as TIMEFORMAT 4, the value that
you provide on the fromtime or totime option must be specified as a time such as
12:24:00pm. Specifying 13:24:00 would not be valid because TIMEFORMAT 4 requires
an hour integer that is 12 or less. If you want to specify up to 24 hour values on an
option, and if you want to use commas as separators, you must specify TIMEFORMAT
2.
Vmbackdir
The vmbackdir option specifies the temporary disk location where the client saves
control files that are created during full VM backup and restore operations of
Microsoft Hyper-V virtual machines.
When a client on a data mover node starts a full VM backup of a virtual machine,
the client creates metadata in files that are associated with the backed up virtual
machine and its data. The files that contain the metadata are referred to as control
files.
During full VM backup operations, the metadata is saved on a disk in the data
mover node until the backup completes and both the virtual machine data and the
control files are saved to server storage. During a full VM restore operation, the
control files are copied from the server and are temporarily stored on the data
mover disk, where they are used to restore the virtual machine and its data. After
a backup or a restore operation completes, the control files are no longer needed
and the client deletes them from their temporary disk location.
The directory that is specified by this option must be on a drive that contains
sufficient free space to contain the control information from a full VM backup.
128
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Options File
Set this option in the client options file, or specify it on the command line as an
option for the backup vm or restore vm commands.
Syntax
►► VMBACKDir
directory
►◄
Parameters
directory
Specifies the path where the control files are stored on the backup server.
The default is c:\mnt\tsmvmbackup\fullvm\
Examples
Options file:
VMBACKD c:\mnt\tsmvmbackup\
Command line:
dsmc backup vm -VMBACKUPT=fullvm -VMBACKD=G:\virtual_machine\
control_files\
dsmc restore vm -VMBACKUPT=fullvm -VMBACKD=G:\san_temp\
Vmctlmc
This option specifies the management class to use when backing up virtual
machine control files.
By default, virtual machine control files are bound to the default management
class. The vmmc option can be used to specify a different management class to
which virtual machine data and virtual machine control files are bound. The
vmctlmc option overrides the default management class and the vmmc option for the
virtual machine control files.
Under certain conditions, it might be desirable or necessary to bind the control
files to a different management class than the data files.
The vmctlmc option is required if virtual machine data files are backed up to tape.
Virtual machine control files must be backed up to a disk-based storage pool that
does not migrate to tape. The storage pool can be composed of random access
volumes and sequential file volumes; the storage pool can also be a deduplicated
pool. Use the vmctlmc option to specify a management class that stores data in
such a storage pool.
Restriction: The management class that is specified by the vmctlmc option
determines only the destination storage pool for virtual machine control files.
Retention of the control files is determined by the vmmc option, if specified, or by
the default management class. The retention for the virtual machine control files
always matches the retention of the virtual machine data files.
Options File
Place this option in the client options file dsm.opt.
Chapter 8. Options reference
129
Syntax
►► VMCTLmc
class_name
►◄
Parameters
class_name
Specifies a management class that applies to backing up virtual machine
control files. If you do not set this option, the management class that is
specified on the vmmc option is used. If you do not set this option and the vmmc
option is not set, the default management class of the node is used.
Examples
Options file:
vmctlmc diskonlymc
Command line:
Does not apply.
Vmmaxparallel
This option is used to configure parallel backups of several virtual machines, using
a single instance of the backup-archive client. The vmmaxparallel option specifies
the maximum number of virtual machines that can be backed up to the server, at
any one time.
This option is valid only for Hyper-V backup operations on Windows Server 2012
and 2012 R2 operating systems.
Options file
This option is valid in the client options file (dsm.opt) or on the command line for
Backup VM. It can also be included on the server in a client options set. It cannot be
set in the Preferences Editor.
Syntax
4
►► VMMAXParallel
►◄
integer
Parameters
integer
Specifies the maximum number of virtual machines that can be backed up, at
any one time, during a parallel backup operation. The default is 4. The
maximum is 50.
Tip: When using client-side data deduplication, a deduplication session is
started for each VM. This deduplication session is not counted as one of the
vmmaxparallel sessions.
The MAXNUMMP server parameter specifies the maximum number of mount
points a node is allowed to use on the server when the copy destination of the
storage pool is FILE or TAPE. MAXNUMMP must be equal to or greater than the
130
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
VMMAXPARALLELsetting. When multiple instances of the client are backing up
files, or when a single client performs parallel backups, additional mount
points might be needed. If the number of mount points requested exceeds the
MAXNUMMP value, the server issues an error (ANS0266I). In response to the error,
the client reduces VMMAXPARALLEL to match the number specified by MAXNUMMP
and continues the backup with the reduced number of sessions. If additional
ANS0266I errors are detected, the client reduces VMMAXPARALLEL by 1 and
attempts to continue the backup. If VMMAXPARALLEL is decremented to 1 and the
client receives more ANS0266I errors, the client ends the backup and issues the
following error:
ANS5228E A backup VM operation failed because VMMAXPARALLEL was
reduced to 1 and the client still cannot obtain a server mount point.
Contact your server administrator if you need the value that is currently set for
MAXNUMMP increased, so your node can support additional parallel backup
sessions.
On Windows Server 2012 and 2012 R2, during Hyper-V virtual machine
backups, IBM Spectrum Protect creates VSS snapshots of all volumes that
contain virtual machine data. Backup data is read from the VSS snapshots, and
not from data that is on the live file system. In many cases, when IBM
Spectrum Protect attempts to create several snapshots concurrently, the VSS
software provider might fail to satisfy a snapshot request for several virtual
machines. The failures occur because the VSS software snapshot provider
cannot handle the load that is created by several backups that are attempted in
parallel. To avoid this issue, use a VSS hardware snapshot provider instead of
a VSS software provider.
Examples
Options file
VMMAXP 10
Command line
dsmc backup vm -vmmaxp=10
Related reference:
“Backup VM” on page 91
“Domain.vmfull” on page 109
Vmmaxpersnapshot
Use the vmmaxpersnapshot option to specify the maximum number of virtual
machines (VMs) to include in a Hyper-V snapshot. The VMs in the snapshot are
backed up to the IBM Spectrum Protect server.
By increasing the number of VMs in a snapshot, you can reduce the number of
snapshots that are taken for a backup operation. This capability reduces the
scheduling contention that can be experienced during cluster backup operations of
VMs on Clustered Shared Volumes (CSVs).
A snapshot with more VMs takes longer to complete and increases the load on the
system. A larger number of VMs means that the snapshot persists longer, which
can affect performance.
This option is valid only for Hyper-V backup operations on Windows Server 2012
and 2012 R2 operating systems.
Chapter 8. Options reference
131
Supported clients
This option is valid for all supported Windows clients. This option can also be
defined on the server.
Options file
This option is valid in the client options file (dsm.opt) or on the command line for
the Backup VM command. It can also be included on the server in a client options
set. It cannot be set in the Preferences Editor.
Syntax
►► VMMAXPERSnapshot
20
integer
►◄
Parameters
integer
Specifies the maximum number of VMs that can be included in a Hyper-V
snapshot. The default is 20. The maximum is 100. The minimum is 1.
If some VMs reside on local volumes and some VMs reside on Clustered
Shared Volumes (CSVs), the number of VMs in a snapshot might be less than
the vmmaxpersnapshot setting. A snapshot cannot contain a mixture of VMs on
local and CSV volumes.
To avoid creating a snapshot that spans volumes, the number of VMs in a
snapshot might be less than the maximum number if the VMs are on different
volumes. For example, four VMs are on Volume A and one VM is on Volume
B. A snapshot is taken with only four VMs (from Volume A) even though the
maximum setting is five. A second snapshot is taken for Volume B.
Examples
Options file
vmmaxpersnapshot 10
Command line
dsmc backup vm -vmmaxpers=10
Related concepts:
“Tuning scheduled VM backups for Windows Server 2012 and 2012 R2 clusters” on
page 52
Related reference:
“Vmmaxsnapshotretry” on page 133
132
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Vmmaxsnapshotretry
Use the vmmaxsnapshotretry option to specify the maximum number of times to
retry a snapshot operation of a virtual machine (VM) if the initial snapshot fails
with a recoverable condition.
During a VM backup, if a snapshot of a VM fails due to a temporary condition,
Data Protection for Microsoft Hyper-V automatically retries the snapshot operation
up to the number of times that is specified by the vmmaxsnapshotretry option. If
the snapshot still fails after the maximum number of retries is reached, the
snapshot operation for the VM is not retried and the backup attempt fails.
For example, a recoverable condition might be caused by two backup requests that
started at about the same time, backing up VMs that reside on the same volume.
One backup operation reports that the snapshot failed because the backup cannot
be started while another backup is running for the same VM. In this case, Data
Protection for Microsoft Hyper-V will retry the snapshot operation after the first
VM backup is completed.
If the initial error is not recoverable, a snapshot is not attempted. For example, if
an error occurs with the Volume Shadow Copy Services (VSS) writer during the
initial snapshot process, the backup processing stops and Data Protection for
Microsoft Hyper-V does not retry the snapshot operation.
This option is valid only for Hyper-V backup operations on Windows Server 2012
and 2012 R2 operating systems.
Supported clients
This option is valid for all supported Windows clients. This option can also be
defined on the server.
Options file
This option is valid in the client options file (dsm.opt) or on the command line for
the Backup VM command. It can also be included on the server in a client option
set. It cannot be set in the Preferences Editor.
Syntax
►► VMMAXSNApshotretry
20
integer
►◄
Parameters
integer
Specifies the maximum number of times to retry the snapshot operation of a
VM if the initial snapshot attempt fails with a recoverable condition. The
default is 20. The maximum is 30. The minimum is 1.
For example, if the vmmaxsnapshotretry option is set to 12, Data Protection for
Microsoft Hyper-V retries the snapshot operation up to 12 times after the
initial snapshot failed during a VM backup operation. If the snapshot still fails
after 12 retries are reached, no more retries are attempted, and the backup
attempt fails.
Chapter 8. Options reference
133
At least 10 minutes must elapse before the next snapshot retry attempt. The
time between attempts will be longer when the failed VM is part of a snapshot
with VMs that are currently being backed up. The backup operation of the
other VMs must be completed and the snapshot is removed by the backup
operation before a retry attempt can be made.
Examples
Options file
vmmaxsna 12
Command line
dsmc backup vm -vmmaxsna=12
Related concepts:
“Tuning scheduled VM backups for Windows Server 2012 and 2012 R2 clusters” on
page 52
Related reference:
“Vmmaxpersnapshot” on page 131
Vmmc
Use the vmmc option to store virtual machine backups by using a management class
other than the default management class.
Options File
Place this option in the client options file (dsm.opt), or on the command line.
Syntax
►► VMMC
management_class_name
►◄
Parameters
management_class_name
Specifies a management class that applies to the backed up virtual machine
data. If you do not set this option, the default management class of the node is
used.
Examples
Task:
Run a backup of the virtual machine that is named myVirtualMachine and
save the backup according to the management class that is named
myManagmentClass.
dsmc backup vm "myVirtualMachine" -vmmc=myManagmentClass
134
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Vmprocessvmwithphysdisks
Use the vmprocessvmwithphysdisks option to control whether Hyper-V RCT virtual
machine (VM) backups are processed if the VM has one or more physical disks
(pass-through disks) provisioned.
A VM can access the storage on a physical disk that is connected directly to the
Hyper-V server. This physical disk is called a pass-through disk.
When you set this option to yes, the data on any physical disks is excluded from
backup operations, but the configuration information for the physical disks is
saved with the VM backup. During a restore operation, you can restore the
physical disk configuration by setting the vmskipphysdisks no option. If the
original physical disks are available, they are reconnected to the restored VM.
This option is valid only for RCT backups on Windows Server 2016. This option
does not apply to Hyper-V VSS backups on Windows Server 2012 or Windows
Server 2012 R2.
Supported Clients
This option is valid for clients on Windows Server 2016 or later operating systems.
Options File
Place this option in the client options file (dsm.opt) or specify it as a command-line
parameter on the backup vm command.
Syntax
NO
►► VMPROCESSVMWITHPHYSDisks
►◄
YES
Parameters
No The backup operation of the VM fails if one or more physical disks are
detected. This value is the default.
Yes
VMs that contain one or more physical disks are backed up. This option backs
up the physical disk configuration without backing up the data on the physical
disks.
Examples
Options file:
VMPROCESSVMWITHPHYSDISKS Yes
Command line:
dsmc backup vm vmlocal -vmprocessvmwithphysd=yes
Related reference:
“Vmskipphysdisks” on page 136
Chapter 8. Options reference
135
Vmskipphysdisks
Use the vmskipphysdisks option to restore configuration information for physical
disks (pass-through disks) that are associated with a Hyper-V virtual machine
(VM), if the logical unit numbers (LUNs) that are associated with the volumes on
the physical disks are available.
Because physical disks are not included in a VM snapshot, only the configuration
information can be restored, and not the data on the volumes.
This option is valid only for restoring Hyper-V VMs on Windows Server 2016. This
option does not apply to Hyper-V hosts on Windows Server 2012 or Windows
Server 2012 R2.
Supported Clients
This option is valid for clients on Windows Server 2016 or later operating systems.
Options File
Place this option in the client options file (dsm.opt), or specify it as a
command-line parameter on the restore vm command.
Syntax
NO
►► VMSKIPPHYSDisks
►◄
YES
Parameters
NO If the original physical disks are available, specify this value to restore the
physical disk configuration information that was backed up with the
vmprocessvmwithphysdisks yes option. The original physical disks are
reconnected to the restored VM. If the original physical disks cannot be
located, the restore operation fails. This value is the default.
YES
Specify this value if you must restore a VM that you backed up with the
vmprocessvmwithphysdisks yes option, and the original physical disks cannot
be located. This setting causes the client to skip attempts to locate the physical
disks, and does not restore the physical disk configuration information.
Examples
Options file:
VMSKIPPHYSDISKS YES
Command line:
dsmc restore vm vm123 -vmskipphysd=yes
Related reference:
“Vmprocessvmwithphysdisks” on page 135
136
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Chapter 9. Mount and file restore
IBM Spectrum Protect recovery agent configurations
The IBM Spectrum Protect recovery agent provides a variety of configurations for
performing file restore and disk / block device exposure.
Off-host file restore
These configurations do not require the IBM Spectrum Protect recovery agent to be
installed in each virtual machine guest. Instead, an off-host instance is responsible
for file restore of multiple virtual machines. With this configuration, the mount
process exposes a virtual volume from a selected disk partition. For GPT disks, the
whole disk must be exposed to make the partitions available, and the disk must be
iSCSI connected. Use the recovery agent GUI to accomplish this task.
You must register a node that is associated with the recovery agent. The recovery
agent node must be granted proxy authority to access the data node (or nodes)
where the snapshots are stored. When a snapshot is mounted to the off-host server,
the virtual volume can be network-shared to make it accessible to the virtual
machine guest. Or, you can copy the files from the mounted volume to the virtual
machine guest by any file-sharing method.
v For step by step restore instructions, see “Restoring one or more files” on page
141
In-guest file restore
These configurations require IBM Spectrum Protect recovery agent to be installed
in each virtual machine guest. The mount and restore process is performed for a
single partition from the backed up disk.
The IBM Spectrum Protect recovery agent node name is typically granted access
only to the virtual machine where it is running with the IBM Spectrum Protect
backup-archive client dsmc set access command. The restore process is typically
begun by a user who logs in to the guest machine of the virtual machine.
For these configurations, be sure to compare the specific virtual machine guest
operating system requirements with the supported levels of IBM Spectrum Protect
recovery agent. If a specific operating system is not supported, determine if the
off-host disk / block device exposure configuration can also be used for file
restore. Use the IBM Spectrum Protect recovery agent GUI to accomplish this task.
v For planning information and operating system-based guidelines, see Chapter 9,
“Mount and file restore.”
v For step-by-step restore instructions, see “Restoring one or more files” on page
141.
Off-host iSCSI target
This configuration exposes an iSCSI target from the instance of the off-host IBM
Spectrum Protect recovery agent and manually uses an in-guest iSCSI initiator to
access the disk snapshot. This configuration requires an iSCSI initiator to be
installed within the virtual machine guest. This approach exposes an iSCSI LUN,
© Copyright IBM Corp. 2011, 2017
137
rather than the off-host file restore, which exposes an individual disk partition. Use
the IBM Spectrum Protect recovery agent GUI to accomplish this task.
In this configuration, the user specifies the virtual machine guest iSCSI initiator
name for the system where the iSCSI device is accessed. After a disk snapshot is
mounted, it can be discovered and logged in to by using the iSCSI initiator in the
virtual machine guest.
If you back up a virtual machine that contains GUID Partition Table (GPT) disks
and want to mount the volume in the GPT disk, follow this procedure:
1. Mount the GPT disk as an iSCSI target.
2. Use the Microsoft iSCSI Initiator to log onto the target.
3. Open the Windows Disk Management to find the disk and bring it online. You
can then view the volume in the GPT disk.
v For planning information and operating system-based guidelines, see Chapter 9,
“Mount and file restore,” on page 137.
v For step by step restore instructions, see “Restoring one or more files” on page
141.
Snapshot mount overview
You can use the IBM Spectrum Protect recovery agent to mount a snapshot and
use the snapshot to complete data recovery.
Mount snapshots with the IBM Spectrum Protect recovery agent GUI. Install and
run the recovery agent on a system that is connected to the IBM Spectrum Protect
server through a LAN. You cannot use the recovery agent component operations in
a LAN-free path.
Be aware of these situations when running mount operations:
v When the IBM Spectrum Protect recovery agent is installed on a guest machine,
you cannot start a mount operation for any file system or disk while the guest
machine is being backed up. You must either wait for the backup to complete, or
you must cancel the backup before running a mount operation. These operations
are not allowed because the locking mechanism is for a full virtual machine.
v When you browse the snapshot backup inventory, the operating system version
of the virtual machine is the version that was specified when the virtual
machine was originally created. As a result, the recovery agent might not reflect
the current operating system.
v A volume becomes unstable when a network failure interrupts a mount
operation. A message is issued to the event log. When the network connection is
reestablished, another message is issued to the event log. These messages are not
issued to the recovery agent GUI.
A maximum of 20 iSCSI sessions is supported. The same snapshot can be mounted
more than one time. If you mount a snapshot from the same tape storage pool by
using multiple instances of the recovery agent, one of the following actions occurs:
v The second recovery agent instance is blocked until the first instance is
complete.
v The second recovery agent instance might interrupt the activity of the first
instance. For example, it might interrupt a file copy process on the first instance.
v The recovery agent cannot connect to multiple servers or nodes simultaneously.
As a result, avoid concurrent recovery agent sessions on the same tape volume.
138
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Mount guidelines
Snapshots can be mounted in either read-only or read/write mode. In read/write
mode, recovery agent saves changes to data in memory. If the service is restarted,
the changes are lost.
The recovery agent operates in either of the following two modes:
No user is logged in
The recovery agent runs as a service.
User is logged in
The recovery agent continues to run as a service until you start the
recovery agent and use the GUI. When you close the recovery agent and
GUI, the service restarts. You can use only the recovery agent application
and GUI when running with administrator login credentials. Only one
copy of the recovery agent application can be active at any time.
When mounted volumes exist and you start Mount from the Start menu, this
message is displayed:
Some snapshots are currently mounted. If you choose to continue, these snapshots will be
dismounted. Note that if a mounted volume is currently being used by an application, the
application may become unstable. Continue?
When Yes is clicked, the mounted volumes are unmounted, even when they are in
use.
Restriction: When exposing snapshots as iSCSI targets, and a snapshot of a
dynamic disk is displayed to its original system, the UUIDs become duplicated.
Likewise when a snapshot of a GPT disk is displayed to its original system, the
GUIDs become duplicated. To avoid this duplication, expose dynamic disks and
GPT disks to a system other than the original system. For example, expose these
disk types to a proxy system, unless the original disks no longer exist.
File restore overview
Use the IBM Spectrum Protect recovery agent for efficient file restore operations
and to minimize downtime by mounting snapshots to virtual volumes.
The IBM Spectrum Protect recovery agent can be used for the following tasks:
v Recovering lost or damaged files from a backup
v Mounting a virtual machine guest volume and creating an archive of the virtual
machine guest files
v Mounting database applications for batch reports
The virtual volume can be viewed by using any file manager, for example
Windows Explorer. The directories and files in the snapshot can be viewed and
managed like any other file. If you edit the files and save your changes, after you
unmount the volume, your changes are lost because the changed data is held in
memory and never saved to disk. Because the changes are written to memory, the
IBM Spectrum Protect recovery agent can use a large amount of RAM when it is
working in read/write mode.
You can copy the changed files to another volume before you unmount the
volume.
Chapter 9. Mount and file restore
139
The default read only mount option is the preferred method, unless a mounted
volume must be writeable. For example, an archive application might require write
access to the archived volume.
The IBM Spectrum Protect recovery agent mounts snapshots from the IBM
Spectrum Protect server. In the IBM Spectrum Protect recovery agent GUI, click
Remove to close an existing connection to the IBM Spectrum Protect server. You
must remove any existing connection before you can establish a new connection to
a different server or different node. Dismount all volumes before you click
Remove. The remove operation fails if there are active mount and restore sessions
in the mount machines. You cannot remove the connection to a server when you
are running a file restore from that server. You must first dismount all virtual
devices and stop all restore sessions before you disconnect from a server. If you do
not do so, the connection is not removed.
You must unmount all virtual volumes before you uninstall the IBM Spectrum
Protect recovery agent. Otherwise, these mounted virtual volumes cannot be
unmounted after the IBM Spectrum Protect recovery agent is reinstalled.
Restoring file information for a block-level snapshot is a random-access process. As
a result, processing might be slow when a sequential-access device (such as a tape)
is used. To run a file restore of data that is stored on tape, consider moving the
data to disk or file storage first. From the IBM Spectrum Protect server
administrative command-line client (dsmadmc), issue the QUERY OCCUPANCY command
to see where the data is stored. Then, issue the MOVE NODEDATA command to move
the data back to disk or file storage.
Mounting a snapshot from the same tape storage pool by two instances of Mount
can cause one of these results:
v The second Mount instance is blocked until the first instance is complete.
v Both mounts succeed, but the performance is poor.
When restoring data from a mirrored volume, mount only one of the disks that
contains the mirrored volume. Mounting both disks causes Windows to attempt a
resynchronization of the disks. However, both disks contain a different time stamp
if mounted. As a result, all data is copied from one disk to the other disk. This
amount of data cannot be accommodated by the virtual volume. When you must
recover data from a volume that spans two disks, and those disks contain a
mirrored volume, complete these steps:
1. Mount the two disks.
2. Use the iSCSI initiator to connect to the first disk.
3. Use Windows Disk Manager to import this disk. Ignore any message regarding
synchronization.
4. Delete the mirrored partition from the first (or imported) disk.
5. Use the iSCSI initiator to connect to the second disk.
6. Use Windows Disk Manager to import the second disk.
Both volumes are now available.
Restriction: Do not change the IBM Spectrum Protect node password while
running a file restore from snapshots stored in that node.
140
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
File restore guidelines
You can use the IBM Spectrum Protect recovery agent for efficient file restore and
to minimize downtime by mounting snapshots to virtual volumes. File restore is
supported from snapshots of NTFS, FAT, or FAT32 volumes.
The mount function cannot be used to mount a snapshot of partitions from a
dynamic or GPT-based disk as a virtual volume. Only partitions from an
MBR-based, basic disk can be mounted as virtual volumes. File restore from GPT,
dynamic, or any other non-MBR or non-basic disk is possible by creating a virtual
iSCSI target and using an iSCSI initiator to connect it to your system.
If you are running a file restore of data on dynamic disks, the snapshot must be
mounted to a server that has the same version of Windows, or a newer version of
Windows, as the node that created the snapshot. Files on the dynamic disk can be
accessed indirectly by nodes that have older versions of Windows, by mapping a
drive on the older nodes to a CIFS share where the snapshot is mounted.
Important: The ACL values associated with the folders and files that are restored
in a file restore operation are not transferred to the restored files. To maintain ACL
values, use the XCOPY command when copying files from the target.
Restoring one or more files
You can restore one (or more) files from a virtual machine that was backed up to
IBM Spectrum Protect server storage.
Before you begin
If your restore operation accesses the virtual machine disk snapshot with an
in-guest iSCSI initiator, make sure the following conditions exist before proceeding:
v The iSCSI device is configured and the iSCSI Initiator program is running.
v Port 3260 is open in the LAN firewall between the system where the IBM
Spectrum Protect recovery agent GUI is installed and the initiator system.
About this task
To mount a backed up virtual machine disk and export the mounted volume for a
file restore operation, complete the following steps:
Procedure
1. Start the IBM Spectrum Protect recovery agent GUI.
On the Windows system, go to Start > Apps by name > IBM Spectrum
Protect > IBM Spectrum Protect Recovery Agent.
The IBM Spectrum Protect recovery agent GUI can either be installed on the
virtual machine guest or installed on a separate host.
2. Connect to the IBM Spectrum Protect server by clicking Select IBM Spectrum
Protect server. The target node is where the backups are located. You can
manage the level of access to the target node data by specifying a different
node name in the Node access method section.
3. Select a virtual machine from the list.
Chapter 9. Mount and file restore
141
Tip: You can find your virtual machine quickly by typing the first few letters
of the machine name in the edit portion of the list box. The list shows only
those machines that match the letters you entered. Machine names are
case-sensitive.
A virtual machine might display in the list, but if you select it, the snapshots
list might be empty. This situation occurs because of one of the following
reasons:
v No snapshots completed successfully for that virtual machine.
v The Fromnode option was used and the specified node is not authorized to
restore the selected virtual machine.
4. Mount the snapshot through an iSCSI connection:
a. Click Mount in the IBM Spectrum Protect recovery agent GUI.
b. In the Select mount destination dialog, click Mount as an iSCSI target.
c. Enter the name of the target. This name must be unique for each mount.
d. Enter the iSCSI initiator name.
The iSCSI initiator name is shown in the Configuration tab in the iSCSI
Initiator Properties dialog. For example:
iqn.1991-05.com.microsoft:hostname
5. Complete these steps on the target system where the iSCSI initiator is
installed:
a. Click the Targets tab.
b. In the Quick Connect section, enter the IP address or host name of the
system where the IBM Spectrum Protect recovery agent GUI is installed.
c. Click Quick Connect.
d. In the Quick Connect dialog, select the IP address or host name in the
Discovered targets field and click Connect.
e. After Status - Connected is shown, click Done.
f. Go to Control Panel > Administrative Tools > Computer Management >
Storage > Disk Management.
1) If the mounted iSCSI target is listed as Type=Foreign, right-click
Foreign Disk and select Import Foreign Disks. The Foreign Disk
Group is selected. Click OK.
2) The next screen shows the type, condition, and size of the Foreign Disk.
Click OK and wait for the disk to be imported.
3) When the disk import completes, press F5 (refresh). The mounted iSCSI
snapshot is visible and contains an assigned drive letter. If drive letters
are not automatically assigned, right-click the required partition and
select Change Drive Letters or Paths. Click Add and select a drive
letter.
6. Select the preferred snapshot date. A list of virtual machine disks that are
backed up in the selected snapshot displays. Select a disk and click Mount.
7. In the Select Mount Destination dialog, check Create virtual volume from
selected partition. A list of partitions available on the selected disk is shown.
For each partition, its size, label, and file system type are displayed.
v If the disk is not MBR-based, an error message is displayed.
v By default, only partitions that can be used for file restore are displayed.
v To display all partitions that existed on the original disk, clear the Show
only mountable partitions check box.
8. Select the required partition. Partitions formatted using unsupported file
systems cannot be selected.
142
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
9. Specify a drive letter or an empty folder as a mount point for the virtual
volume.
10. Click OK to create a Virtual Volume that can be used to recover the files.
11. When the Virtual Volume is created, use Windows Explorer to copy the files to
your preferred location.
Tip: The ACL values associated with the folders and files that are restored in
a file restore operation are not transferred to the restored files. To maintain
ACL values, use the XCOPY command when copying files from the target.
Related tasks:
“Configuring the IBM Spectrum Protect recovery agent GUI” on page 42
“Manually configuring an iSCSI device” on page 49
Chapter 9. Mount and file restore
143
144
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Chapter 10. IBM Spectrum Protect recovery agent commands
The recovery agent CLI can be viewed as a command-line API to the IBM
Spectrum Protect recovery agent. Changes completed with the recovery agent CLI
to the IBM Spectrum Protect recovery agent take effect immediately.
You can use the recovery agent CLI to manage only one system running the IBM
Spectrum Protect recovery agent.
On a Windows system, click Start > Apps by name > IBM Spectrum Protect >
Recovery Agent CLI.
Mount
Use the mount command to complete various IBM Spectrum Protect recovery agent
tasks.
The recovery agent CLI can be used to mount (mount add) and unmount (mount
del) volumes and disks, and to view a list of mounted volumes (mount view).To
use the mount command, the IBM Spectrum Protect recovery agent must be
running. Use the set_connection command to connect a RecoveryAgentShell.exe to
the mount application.
Snapshots are mounted or unmounted on the system where the IBM Spectrum
Protect recovery agent is running.
Syntax for mounting a disk
►► RecoveryAgentShell.exe -c mount add -rep
► port
= portNumber node
"tsm: ip =
IP
host_name
= nodeName
►
►
-as_node = nodeName
► pass
= NodePassword"
► date
date_format
► -target
"ISCSI: target
-vmname vmname -type
disk -disk
disk_number
►
►
= target_name
initiator = initiator_name"
►◄
Syntax for mounting partition
►► RecoveryAgentShell.exe -c mount add -rep "tsm: ip =
IP
host_name
► port = portNumber node = nodeName
►
►
-as_node = nodeName
► pass = NodePassword" -vmname vmname -disk
disk_number
vmdk
►
► date date_format -type partition -PartitionNumber partNum
►
© Copyright IBM Corp. 2011, 2017
145
► -target
volume_letter
"ISCSI: target = target_name initiator = initiator_name"
►◄
Command types
add
Use this command type to mount a disk or volume of a snapshot to the
system where IBM Spectrum Protect recovery agent is running.
The following list identifies the tags and parameters for the add command
type:
-target
This tag is required. Use this tag to specify the following targets:
v Virtual volume - only for a partition mount
v Reparse point - only for a partition mount
v iSCSI target
-rep
This tag is required. Use it to specify the IBM Spectrum Protect
server that is storing the snapshots, and the IBM Spectrum Protect
node that has access to the backups. For example:
tsm: ip=<ip/host_name> port=<port_number>
node=<node_name> pass=<node_password>
You can also specify the as_node and from_node options. If the
password field is empty, the IBM Spectrum Protect recovery agent
attempts to use the password for the stored node.
-type
This tag is required. Use it to specify that you want to mount a
disk or a partition. The options are:
-type disk
-type partition
-VMname
This tag is required. Use it to specify the machine name that is
source of the snapshot. The specified value is case-sensitive.
-disk
This tag is required. Use it to specify the disk number of the source
backed up machine to be mounted.
-date
This tag is required. Use it to specify the date of the snapshot that
you want to mount. The date format is yyyy-Mmm-dd hh:mm:ss. For
example:
-date "2013-Apr-12 22:42:52 AM"
To view the active (or latest) snapshot, specify last snapshot.
-PartitionNumber
This tag is optional. If the -type is partition, enter the partition
number to mount.
-ro|-fw
Use this tag to specify whether the mounted volume is read-only
(-ro) or fake-write (-fw).
-disk
This tag is required. Use it to specify the disk number of the source
backed up machine to be mounted.
-ExpireProtect
This tag is optional. During a mount operation, the snapshot on
the IBM Spectrum Protect server is locked to prevent it from
146
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
expiring during the operation. Expiration might occur because
another snapshot is added to the mounted snapshot sequence. This
value specifies whether to disable expiration protection during the
mount operation. You can specify one of the following values:
Yes
Specify Yes to protect the snapshot from expiration. This
value is the default. The snapshot on the IBM Spectrum
Protect server is locked and the snapshot is protected from
expiration during the mount operation.
No
Specify No to disable expiration protection. The snapshot on
the IBM Spectrum Protect server is not locked and the
snapshot is not protected from expiration during the
mount operation. As a result, the snapshot might expire
during the mount operation. This expiration can produce
unexpected results and negatively impact the mount point.
For example, the mount point can become unusable or
contain errors. However, expiration does not affect the
current active copy. The active copy cannot expire during
an operation.
When the snapshot is on a target replication server, the
snapshot cannot be locked because it is in read-only mode.
A lock attempt by the server causes the mount operation to
fail. To avoid the lock attempt and prevent such a failure,
disable expiration protection by specifying No.
dump Use this command type to get a list of all the available backups to mount.
The following list identifies the tags and parameters for the dump command
type:
-rep
This tag is required. Use this tag to specify the IBM Spectrum
Protect server storing the snapshots, and to specify the IBM
Spectrum Protect node that has access to the backups. For example:
tsm: ip=<IP/host name> port=<PortNumber>
node=<NodeName> pass=<NodePassword>
-file
This tag is optional. Use this tag to identify a file name to store the
dump text. If this tag is not specified, the dump text is printed
only to stdout.
remove
Use this type to remove the connection to the IBM Spectrum Protect server.
A connection cannot be removed when it is in use, such as when mounted
volumes exist.
The following list identifies the tag for the remove command type:
-rep - This tag is required. Use this tag to specify the IBM Spectrum
Protect server connection to be removed.
view
Use this type to view a list of all mounted snapshots. This type has no
tags.
Example commands
The following examples use the -target tag:
v In the following example V: is the virtual volume mount target:
-target "V:"
v In the following example a reparse point volume mount target is specified:
Chapter 10. IBM Spectrum Protect recovery agent commands
147
-target "C:\SNOWBIRD@FASTBACK\SnowbirtK\Snowbird\K\\"
v In the following example an iSCSI target is specified:
-target "ISCSI: target=<target_name> initiator=<initiator_name>"
In this example, a snapshot of virtual machine named VM-03ent is located on the
IBM Spectrum Protect server with IP 10.10.10.01. Disk number 1 of this snapshot is
mounted to the system where the IBM Spectrum Protect recovery agent is running.
The following command shows how to specify the add type to mount a disk:
mount add -rep "tsm: ip=10.10.10.01 port=1500 node=tsm-ba pass=password"
-target "iscsi: target=test1 initiator=initiator_name" -type disk
-vmname VM-03ENT -disk 1 -date "2014-Jan-21 10:46:57 AM -ExpireProtect=Yes"
The following examples show how to specify the dump type:
v List all the available backed up VMs.
mount dump –type TSM –for TSMVE -rep P -request
ListVM [–file <FileNameAndPath>]
v List all the available disk snapshots of a virtual machine.
mount dump –type TSM –for TSMVE -rep P -request
ListSnapshots -VMName P [-file <FileNameAndPath>]
v List all the available partitions of a disk snapshot.
mount dump –type TSM –for TSMVE -rep P -request
ListPartitions -VMName P -disk P -date P [-file <FileNameAndPath>]
In the following example, remove the connection to the IBM Spectrum Protect
server (10.10.10.01) using node NodeName:
mount remove -rep "tsm: NodeName@ip"
The following example uses the view type:
mount view
Related links for mounting a Hyper-V snapshot
v “Set_connection”
v “Help” on page 149
Set_connection
The set_connection command sets the Recovery Agent CLI to work with a
specified IBM Spectrum Protect recovery agent.
Syntax
►► RecoveryAgentShell.exe -c
► mount_computer
set_connection
IP address or host_name
►
►◄
Command type
mount_computer
Use this command type to set the connection from the recovery agent CLI
to the system where the IBM Spectrum Protect recovery agent is installed.
The following list identifies the parameters for the mount_computer
command type:
148
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
IP address or host_name
This variable is required. Specify the IP address or hostname of the
system where the IBM Spectrum Protect recovery agent is installed.
Example commands
In the following example, the recovery agent CLI is set to work with the IBM
Spectrum Protect recovery agent on the ComputerName host.
set_connection mount_computer ComputerName
Related links for setting a connection
v “Mount” on page 145
v “Help”
Help
The help command displays the help for all of the supported recovery agent CLI
commands.
Syntax
►► RecoveryAgentShell.exe -c
-h command
►◄
Command tag
-h
Use this command tag to show help information.
The following list identifies the parameter for the mount_computer
command type:
command
This variable is required. Specify the Recovery Agent command for
which you want help information.
Example commands
In the following example, the recovery agent CLI is set to work with the IBM
Spectrum Protect recovery agent on the ComputerName host.
set_connection mount_computer ComputerName
Related links for setting a connection
v “Mount” on page 145
v “Set_connection” on page 148
Chapter 10. IBM Spectrum Protect recovery agent commands
149
Recovery agent command-line interface return codes
Return codes help identify the results of the recovery agent CLI operations.
Use these return codes to check the status of your recovery agent CLI operations.
Table 15. Recovery Agent CLI return codes
Return
Code
150
Value
Description
0
FBC_MSG_MOUNT_SUCCESS
Command submitted successfully to
Data Protection for Microsoft
Hyper-V mount.
0
FBC_MSG_DISMOUNT_SUCCESS
Successfully dismounted a snapshot.
0
FBC_MSG_VIEW_SUCCESS
View operation successful.
0
FBC_MSG_DUMP_SUCCESS
Dump operation successful.
0
FBC_MSG_REMOVE_SUCCESS
Remove operation successful.
1
FBC_MSG_MOUNT_FAIL
Mount failed (See the mount logs for
details).
2
FBC_MSG_MOUNT_DRIVER_ERROR
Mount driver error.
3
FBC_MSG_VOLUME_LETTER_BUSY
Volume letter or reparse point is in
use.
4
FBC_MSG_MOUNT_WRONG_
PARAMETERS
Incorrect parameters assigned to the
mount command (See the mount logs
for details).
5
FBC_MSG_MOUNT_ALREADY_
MOUNTED
Job is already mounted on the
requested target.
6
FBC_MSG_MOUNT_WRONG_
PERMISSIONS
Insufficient permissions.
7
FBC_MSG_MOUNT_NETWORK_
DRIVE
Cannot mount on network mapped
volume.
8
FBC_MSG_MOUNT_LOCKED_BY_
SERVER
Snapshot locked by the server.
9
FBC_MSG_CAN_NOT_CHANGE_
REPOSITORY
Cannot change repository.
11
FBC_MSG_DISMOUNT_FAIL
Failed to dismount a mounted
snapshot.
13
FBC_MSG_VIEW_FAIL
Retrieving list of virtual volumes
failed.
15
FBC_MSG_DUMP_FAIL
Dump command list creation failed.
16
FBC_MSG_CONNECTION_FAILED
Disconnected from Data Protection
for Microsoft Hyper-V mount.
17
FBC_MSG_CONNECTION_TIMEOUT
Operation timed out.
18
FBC_MSG_MOUNT_FAILED_TO_
FIND_REPOSITORY
Failed to find a valid repository with
snapshots.
19
FBC_MSG_MOUNT_JOB_NOT_
FOUND
Failed to find the requested snapshot.
20
FBC_MSG_MOUNT_JOB_FOLDER_
NOT_FOUND
Failed to find the requested snapshot
data.
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Table 15. Recovery Agent CLI return codes (continued)
Return
Code
Value
Description
22
FBC_MSG_CAN_NOT_REMOVE_
REPOSITORY
Cannot remove selected repository.
23
FBC_MSG_REPOSITORY_GOT_
MOUNTS
Repository has mounted snapshots.
38
FBC_MSG_MOUNT_NOT_WRITABLE_
VOLUME
The mount volume is not writable
39
FBC_MSG_NO_TSM_REPOSITORY
No IBM Spectrum Protect repository
was located.
40
FBC_MSG_MOUNT_NOT_ALLOWED_ Mounting the iSCSI target as read
AS_READONLY
only is not allowed.
41
FBC_MSG_RESOURCE_BUSY_IN_
TAPE_MODE
Data Protection for Microsoft
Hyper-V is running in tape mode media is busy.
42
FBC_MSG_DISK_TYPE_NOT_
SUPPORTED
Partition operation not supported for
this type of disk.
43
FBC_MSG_MOUNT_INITIALIZING
The operation failed, Data Protection
for Microsoft Hyper-V mount is
currently initializing. Try again later.
44
FBC_MSG_CANNOT_LOCK_
SNAPSHOT
The snapshot cannot be protected
against expiration during this
operation. Refer to documentation for
more details.
Chapter 10. IBM Spectrum Protect recovery agent commands
151
152
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Appendix A. Troubleshooting
Solutions to Data Protection for Microsoft Hyper-V issues are provided.
The following topics are available:
v “Locating log files”
v “Troubleshooting with PowerShell cmdlets”
v “Virtual machine backup fails with the 0x800705B4 error in the Hyper-V event
log”
v “Unsupported characters in virtual machine and Hyper-V host or cluster names”
on page 154
v “The file restore interface shows the wrong drive letter assignments and the
system reserved disk” on page 154
v “An SSL connection cannot be made” on page 154
v “The SSL certificate for the agent is not valid” on page 155
v “A VM backup or restore operation cannot start when another VM operation is
in progress” on page 155
|
Locating log files
|
|
For information about Data Protection for Microsoft Hyper-V log files, see the
following topics:
|
v “Data Protection for Microsoft Hyper-V log activity options” on page 41
|
v “Trace options for Data Protection for Microsoft Hyper-V” on page 157
|
Troubleshooting with PowerShell cmdlets
|
|
|
You can troubleshoot Data Protection for Microsoft Hyper-V operations with
PowerShell cmdlets. For more information, see “Troubleshooting Data Protection
for Microsoft Hyper-V operations” on page 156.
Virtual machine backup fails with the 0x800705B4 error in the
Hyper-V event log
During VM backup operations on Windows Server 2016, this error can occur if you
run a resilient change tracking (RCT) full backup of a virtual machine (VM) with
many VM disks. The snapshot operation either times out or runs out of space on
the file space on the server.
If the VM backup operation fails, search the Hyper-V event log for the 0x800705B4
error. If this error is present, complete the following steps to help improve the
performance of the snapshot operation:
1. Ensure that the Hyper-V VM is a generation 2 VM.
2. Ensure that only SCSI disks are attached to the generation 2 VM (instead of a
mix of SCSI and IDE disks).
3. Move the Hyper-V snapshot folder from the default location
(C:\ProgramData\Microsoft\Windows\Hyper-V\Snapshots) to a faster drive that
is not the Windows system drive (for example, the D: drive).
© Copyright IBM Corp. 2011, 2017
153
|
|
Unsupported characters in virtual machine and Hyper-V host or
cluster names
|
|
|
Data Protection for Microsoft Hyper-V does not support backing up virtual
machines and Hyper-V hosts or clusters that contain any of the following
characters in their name:
|
"
Double quotation mark
|
'
Single quotation mark
|
:
Colon
|
;
Semicolon
|
*
Asterisk
|
?
Question mark
|
,
Comma
|
<
Less than sign
|
>
Greater than sign
|
/
Forward slash
|
\
Backward slash
|
|
Vertical bar
|
|
The file restore interface shows the wrong drive letter
assignments and the system reserved disk
|
Ensure that the automount feature on Windows is not enabled.
|
|
|
|
By default, the Data Protection for Microsoft Hyper-V installer automatically
disables the automount feature with the diskpart command. This action is
required to show correct drive letter assignments and to hide the system reserved
disk in the IBM Spectrum Protect file restore interface.
|
|
|
The automount feature was most likely enabled after the installation of Data
Protection for Microsoft Hyper-V. Use the diskpart command to disable the
automount feature.
|
An SSL connection cannot be made
|
|
|
|
The following message might appear in the Data Protection for Microsoft Hyper-V
Management Console if the SSL certificate is invalid in any way, such as if you
reinstalled Data Protection for Microsoft Hyper-V and the old SSL certificate was
not deleted.
|
|
|
GVM6065E The SSL Connection could not be made. The IBM Spectrum Protect SSL
certificate is missing. Check for valid IBM Spectrum Protect certficate in
the TSM-ve-trustore.jks RC=215
|
|
|
|
Delete all the files in the C:\IBM\SpectrumProtect\webserver\usr\servers\
veProfile\tsmVmGUI\truststores folder. Then, and restart the Data Protection for
Microsoft Hyper-V Management Console and run the configuration wizard. Accept
the security certificate when prompted.
154
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
The SSL certificate for the agent is not valid
|
|
You might receive an SSL connection error if the security certificate for the remote
client agent is not valid or not up-to-date.
|
|
|
|
|
For example, if the certificate files (dsmcert.sth, dsmcert.idx, and dsmcert.kdb) in
the C:\Program Files\Tivoli\TSM\baclient directory were deleted or are
corrupted, the following message appears in the data mover error log
(dsmerror.hostname_HV_DM.log):
|
|
The method that you use to resolve this problem depends on the level of the IBM
Spectrum Protect server that you are connecting to:
|
|
v If you are connecting to an IBM Spectrum Protect Version 8.1.2 or later server, or
a V7.1.8 or later V7 server, complete one of the following steps:
|
|
|
|
– Stop the client acceptor service on the data mover node and mount proxy
node (if file restore is enabled) and re-run the Data Protection for Microsoft
Hyper-V configuration wizard on the stand-alone host or on any host in a
cluster.
|
|
|
|
|
|
|
ANS1592E Failed to initialize SSL protocol.
For more information, see “Configuring Data Protection for Microsoft
Hyper-V with the wizard” on page 29.
– Update the node definition on the IBM Spectrum Protect server by specifying
the SESSIONSECURITY=TRANSITIONAL parameter. The security certificate
is re-created when you sign on to the IBM Spectrum Protect server from the
Data Protection for Microsoft Hyper-V Management Console.
For more information, see UPDATE NODE.
|
|
|
v If you are connecting to an IBM Spectrum Protect V8.1.1 or earlier V8 server, or
a V7.1.7 or earlier server, see Dsmcutil commands: Required options and
examples.
|
|
A VM backup or restore operation cannot start when another VM
operation is in progress
|
|
The following message is displayed if a backup or restore operation is started
while another VM operation is in progress:
|
|
|
ANS5176W The requested virtual machine operation cannot be performed
because a virtual machine backup or restore operation is already in
progress. Please retry the operation after the first operation completes.
|
This message appears in the following situations:
|
|
v You started a backup or restore operation of a VM and another backup or
restore operation is already in progress on the same host.
|
|
|
v You started a backup or restore operation of a VM and another scheduled
backup of any VM on the same host is running, or if someone else interactively
started the operation from another location.
|
|
If you encounter this message, wait for the running operation to finish, then restart
your backup or restore operation.
Appendix A. Troubleshooting
155
|
Troubleshooting Data Protection for Microsoft Hyper-V operations
|
|
You can retrieve diagnostic information to resolve Data Protection for Microsoft
Hyper-V issues by running Microsoft Windows PowerShell cmdlet commands.
|
Before you begin
|
|
|
Ensure that you prepare your environment to use PowerShell cmdlets. For more
information, see “Preparing to use PowerShell cmdlets with Data Protection for
Microsoft Hyper-V” on page 79.
|
Procedure
|
|
|
|
|
Complete the following steps on the system where Data Protection for VMware is
installed.
1. Display log file information in a PowerShell Viewer by issuing the following
command:
PS C:\> Show-DpHvApiLogEntries
|
|
You can investigate and share log information in the PowerShell Viewer with
any of the following actions:
|
v Enter a term to filter the results.
|
v Click Add criteria to filter the information by more detailed specifications.
v Click one or more rows to save or copy their content for sharing.
2. Display the trace information from a trace file by issuing the following
command:
|
|
|
|
|
|
|
|
PS C:\> Show-DpHvApiTraceEntries
3. To gather logs to review detailed diagnostic information parameter or to send
to IBM Support, save the logs in a compressed file by issuing the following
command:
PS C:\> Get-DpHvProblemDeterminationInfo -review
|
|
By default, this command saves the DpHvProblemDetermination.zip file on the
desktop.
|
|
|
Tip: If this command returns an error in the default "PowerShell" interface,
start the "PowerShell ISE" interface as an administrator. Then, run the
command again.
|
|
|
|
4. Optional: Each Data Protection for Microsoft Hyper-V cmdlet provides
parameters. To view parameters, issue the following help command:
|
|
“Data Protection for Microsoft Hyper-V log activity options” on page 41
“Trace options for Data Protection for Microsoft Hyper-V” on page 157
help cmdlet name -ShowWindow
Related reference:
156
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
|
Trace options for Data Protection for Microsoft Hyper-V
|
|
|
By setting tracing options in the FRLog.config file, you can troubleshoot problems
that you might encounter during Data Protection for Microsoft Hyper-V and file
restore operations.
|
|
|
Modify the options in the FRLog.config file with a text editor in administrator
mode. The FRLog.config file is in the following directory:
|
|
FR.API.TRACE=ON | OFF
Specify whether to trace API activity at the recommended level of detail.
|
|
Note: The following values are also supported and indicate the least,
recommended, and highest level of detail: DEBUG, TRACE, ALL.
C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\frGUI
|
|
|
API_MAX_TRACE_FILES=number
Specify the maximum number of trace files to be created or used. The default
value is 8.
|
|
|
API_MAX_TRACE_FILE_SIZE=number
Specify the maximum size of each trace file in KB. The default value is 8192
KB.
|
|
API_TRACE_FILE_NAME=API_trace_file_name
Specify the name of the API trace file. The default value is fr_api.trace.
|
|
|
|
API_TRACE_FILE_LOCATION=API_trace_file_location
Specify the location of the API trace file. Specify the location by using a
forward slash (/). The default location is install_directory/IBM/
SpectrumProtect/webserver/usr/servers/veProfile/logs.
Appendix A. Troubleshooting
157
158
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Appendix B. Data Protection for Microsoft Hyper-V messages
Explanations and suggested actions are provided for messages that are issued by
Data Protection for Microsoft Hyper-V.
Messages that begin with the GVM prefix are provided in ascending numerical
order. In some messages, the explanation and user action are provided in the
message itself.
Some messages that begin with the GVM prefix are also shared with IBM
Spectrum Protect for Virtual Environments: Data Protection for VMware.
For messages that begin with the ANS prefix, see ANS 0000-9999 messages.
GVM5900E
The operation failed with return code
return code
GVM5901E
An internal error occurred: type of error
GVM5906W The VM VM name is running, make sure
the system is powered down, then hit
OK to continue.
GVM5907I
GVM5902E
A connection with the IBM Spectrum
Protect server could not be established.
Explanation: The server might not be running.
User response: Check the network connection with
the server machine. Verify that the server is running
and try to log in again.
GVM5903W Are you certain that you want to delete
this data?
Explanation: You cannot recover the data after it is
deleted. Ensure that the data is not needed before you
delete it.
User response: Click OK to delete the data or click
Cancel to cancel this action.
GVM5908W There is no IBM Spectrum Protect server
definition found.
Explanation: A connection for a IBM Spectrum Protect
server must be defined before any server operations or
queries are performed.
User response: To define a server:
1. Click the Configuration tab.
2. Click the Edit Configuration Settings action link.
3. Click the IBM Spectrum Protect Server Credentials
tab.
GVM5909I
The VM VM name is spanned into
multiple datastores. It can only be
restored to its original location.
GVM5910E
An error occurred while writing to the
server's database file, tsmserver.props
GVM5904W The connection with the IBM Spectrum
Protect server has timed out.
Explanation: Possible causes include a long-running
operation, a problem on the server, or a
communications problem.
User response: If the operation is long-running, the
operation might be complete or it might soon be
complete. Before trying the operation again, determine
if the expected result occurred. Check the activity log of
the IBM Spectrum Protect server for errors related to
the operation. Using a SSL port without selecting SSL
can cause this error.
GVM5905W The VM VM name exists, are you going
to over-write it?
A server connection with the name
server name has been successfully
created. Click OK to continue.
Explanation: The server definition could not be
written to the tsmserver.props file.
User response: The file must reside in the install
directory of the Data Protection for Virtual
Environments. Before you try the action again, verify
that the file exists and that the file is not write
protected.
GVM5911E
A connection with the vCenter server
could not be established.
Explanation: The server might not be running.
© Copyright IBM Corp. 2011, 2017
159
GVM5912I • GVM5924E
User response: This might indicate a network
problem. Ensure that the server is running and the
machine is accessible. Try the action again.
GVM5912I
A connection with the vCenter server
has been established.
GVM5913E
The VMCLI inquire configuration
command failed, the following messages
describe the error.
Explanation: The Derby database might not be
running.
User response: Correct the problem. Try the action
again.
GVM5914I
The VMCLI inquire configuration
command completed successfully.
problem, it may be due to an install issue or manual
editing of the file.
User response: Make sure the file is located in the
correct directory, has correct access permissions, and
has valid syntax for its content. Retry accessing the
GUI.
GVM5920E
Explanation: The xml tag mode in file
vmcliConfiguration.xml is required for the GUI to
operate, but is missing or has an incorrect value. This
may be due to an install issue or manual editing of the
file.
User response: Make sure the tag is specified with a
valid value. Retry accessing the GUI.
GVM5921E
GVM5915E
Failed to determine which product or
products are installed.
Invalid mode tag in file
vmcliConfiguration.xml.
Invalid enable_direct_start tag in file
vmcliConfiguration.xml.
User response: Correct the problem. Try the action
again.
Explanation: The xml tag enable_direct_start in file
vmcliConfiguration.xml is required for the GUI to
operate, but is missing or has an incorrect value. This
may be due to an install issue or manual editing of the
file.
GVM5916I
Successfully determined which product
or products are installed.
User response: Make sure the tag is specified with a
valid value. Retry accessing the GUI.
GVM5917E
Multiple restore points have been
selected, but they are not located in the
same datacenter.
Explanation: See message.
GVM5922E
Explanation: Selecting restore points from different
datacenters is not permitted. The restore points must all
be located in the same datacenter.
User response: Select the restore points from the same
datacenter or select just a single restore point.
GVM5918E
Multiple restore points have been
selected, but they are not from the same
backup.
Explanation: Selecting restore points from different
backups is not permitted. The restore points must all be
located in the same backup.
User response: For restores from IBM Spectrum
Snapshot, all restore points must come from the same
backup. You cannot restore multiple VMs that come
from of different backups.
GVM5919E
A key configuration file is missing:
vmcliConfiguration.xml.
Explanation: The file vmcliConfiguration.xml is
required for the GUI to operate, but has not been found
during GUI session startup. This is an unusual
160
Invalid URL tag for the specified mode
tag in file vmcliConfiguration.xml.
Explanation: In file vmcliConfiguration.xml, the URL
tag corresponding to the specified mode tag is required
for the GUI to operate, but is missing or has an
incorrect value. This may be due to an install issue or
manual editing of the file.
User response: Make sure the correct URL tag is
specified with a valid value for the specified mode.
Retry accessing the GUI.
GVM5923E
Invalid VMCLIPath tag in file
vmcliConfiguration.xml.
Explanation: The xml tag VMCLIPath in file
vmcliConfiguration.xml is required for the GUI to
operate, but is missing or has an incorrect value. This
may be due to an install issue or manual editing of the
file.
User response: Make sure the tag is specified with a
valid value. Retry accessing the GUI.
GVM5924E
Invalid interruptDelay tag in file
vmcliConfiguration.xml.
Explanation: The xml tag interruptDelay in file
vmcliConfiguration.xml is required for the GUI to
operate, but is missing or has an incorrect value. This
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM5925E • GVM5943I
may be due to an install issue or manual editing of the
file.
User response: Make sure the tag is specified with a
valid value. Retry accessing the GUI.
GVM5925E
GVM5926E
GVM5927E
GVM5928E
The VM name entered VM name
conflicts with an existing VM. Please
enter a different name.
An error occurred while processing the
request to the Web server. If this error
persists, check the network connection
with the Web server and verify that the
Web server is running.
Detail: exception
exception message
A request to the server took too long to
complete. If this error persists, check the
network connection with the Web server
and verify that the Web server is
running.
An error occurred while processing the
response from the Web server.
Detail: error
GVM5935E
Get managed domain failed.
Error: message
GVM5936E
Multiple restore points have been
selected, but they are not the same
backup type.
Explanation: Selecting restore points of different types
is not allowed. The restore points must all be located
on either a IBM Spectrum Protect server or in the IBM
Spectrum Snapshot repository.
User response: Select the same type of restore points
or select just a single restore point.
GVM5937E
Explanation: An internal error occurred.
User response: Refresh the table and perform the
action again.
GVM5938E
Task ID is null.
Explanation: An internal error occurred.
User response: Refresh the table and perform the
action again.
GVM5939E
GVM5929E
Backup ID is null.
Could not open a pop-up window.
An error occurred while making the
Web server request. If this error persists,
check the network connection with the
Web server and verify that the Web
server is running.
Error: message
Explanation: An internal error occurred.
GVM5930E
No matching device class found. Please
return to source page and reselect.
User response: Refresh the table and perform the
action again.
GVM5931E
No matching proxy node found. Please
return to source page and reselect.
GVM5941E
User response: Try the action again.
GVM5940E
Virtual machine name is null.
Explanation: An internal error occurred.
Datastore does not exist.
Explanation: An internal error occurred.
GVM5932E
No proxy ESX hosts available.
User response: Refresh the table and perform the
action again.
GVM5933I
Password set successfully.
GVM5942I
GVM5934E
Set password failed.
Error: message
Explanation: No selection was made.
Explanation: The password may be incorrect or the
server is not running.
User response: Verify the password is correct then try
the action again. Or check the network connection with
the server machine and verify that the server is
running then try the action again.
No selection was made, the whole
virtual machine will be attached.
User response: Continue with the action or cancel the
action.
GVM5943I
Domain set successfully.
Appendix B. Data Protection for Microsoft Hyper-V messages
161
GVM5944E • GVM5954E
GVM5944E
Schedule Summary: summary
Set domain failed.
Error: message
Explanation: The server might not be running.
GVM5949E
The schedule requires use of the
following virtual machines that are not
known to the system.
Virtual Machines: list
Action: This schedule may not be
updated, instead create a new schedule
without dependence on these virtual
machines.
Detail: The schedule definition is as
follows:
Schedule Summary: summary
GVM5950I
Password set successfully.
Warning: message
The permissions on the file directory may be incorrect.
User response: Check the network connection with
the server machine. Verify that the server is running
and try the action again.
Check the permissions of the directory indicated in
SystemErr.log if error indicates incorrect permissions.
GVM5945E
GVM5946E
GVM5947E
GVM5948E
162
The schedule requires use of the
following datacenters that are not in the
active domain.
Datacenters: list
Action: This schedule may not be
updated, instead either update the
domain construct to include the
datacenters, or create a new schedule
without dependence on these
datacenters.
Detail: The schedule definition is as
follows:
Schedule Summary summary
The schedule requires use of the
following datacenters that are not
known to the system.
Datacenters: list
Action: This schedule may not be
updated, instead create a new schedule
without dependence on these
datacenters.
Detail: The schedule definition is as
follows:
Schedule Summary: summary
The schedule requires use of the
following hosts that are not known to
the system.
Hosts: list
Action: This schedule may not be
updated, instead create a new schedule
without dependence on these hosts.
Detail: The schedule definition is as
follows:
Schedule Summary: summary
The schedule requires use of the
following datastores that are not known
to the system.
Datastores: list
Action: This schedule may not be
updated, instead create a new schedule
without dependence on these datastores.
Detail: The schedule definition is as
follows:
Explanation: The password was set successfully with
a warning.
User response: Follow the action described in the
warning message.
GVM5951E
An error occurred while making the
Web server request. If this error persists,
check the network connection with the
Web server and verify that the Web
server is running.
Error: error
GVM5952E
The following command requires
confirmation from the server:
“”Command“”
Explanation: A command was issued, and a reply was
expected. Some commands require a confirmation,
which you cannot issue through the Data Protection for
Virtual Environments GUI.
User response: Issue the command from the command
line.
GVM5953E
The following command is unknown to
the server: “”Command“”
Explanation: An unknown command was issued to
the server. The command might not be valid on the
server version and platform or the command syntax
might be incorrect.
User response: Verify that the command is valid for
the server version and platform, and verify that the
command syntax is correct.
GVM5954E
The syntax of the following command is
incorrect: “”Command“”.
Explanation: See message.
User response: Correct the syntax and issue the
command from the command line. The activity log of
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM5955E • GVM5970E
the IBM Spectrum Protect Server shows all the
commands issued before and after this command.
GVM5955E
GVM5963E
The object that you are attempting to
remove is referenced by another object
defined to the server. Remove the other
object before removing this one.
GVM5964E
The object that you are attempting to
access or remove is not available.
An internal server error occurred.
Explanation: See message.
User response: Try the command again. If this does
not work, contact customer support. You might be
asked to provide tracing information and information
about the actions performed before the failure occurred.
GVM5956E
The server ran out of memory while
processing the request. Close any
unnecessary processes on the IBM
Spectrum Protect server and try the
operation again.
Explanation: See message.
User response: Before trying the action again, contact
the administrator of the IBM Spectrum Protect server.
GVM5965E
The server encountered an I/O error
while processing the request. For more
information, see the operating system
event or error log.
GVM5966E
The action failed because the transaction
could not be committed.
Explanation: See message.
User response: Before trying the action again, contact
the administrator of the IBM Spectrum Protect server.
Explanation: See message.
GVM5957E
The database recovery log is full.
Explanation: See message.
User response: Before trying the action again, extend
the recovery log or back up the IBM Spectrum Protect
server database. Contact the administrator of the IBM
Spectrum Protect server.
User response: Retry the action at a later time. Before
trying the action again, contact the administrator of the
IBM Spectrum Protect server.
GVM5967E
The action failed because of a resource
lock conflict.
Explanation: See message.
GVM5958E
The server database is full.
Explanation: See message.
User response: Before trying the action again, extend
the server database. Contact the administrator of the
IBM Spectrum Protect server.
GVM5959E
The server is out of storage space.
Explanation: See message.
User response: Before trying the action again, contact
the administrator of the IBM Spectrum Protect server.
GVM5960E
GVM5961E
GVM5962E
You are not authorized to perform this
action. An administrator with system
authority can change your authority
level to allow you to perform this
action.
The object that you are attempting to
access does not exist on the server.
The object that you are attempting to
access is currently in use by another
session or process. Retry the action at a
later time.
User response: Retry the action at a later time. Before
trying the action again, contact the administrator of the
IBM Spectrum Protect server.
GVM5968E
The action failed because of a mode
conflict.
Explanation: See message.
User response: Retry the action at a later time. Before
trying the action again, contact the administrator of the
IBM Spectrum Protect server.
GVM5969E
The action failed because the server
could not start a new thread.
Explanation: See message.
User response: Retry the action at a later time. Before
trying the action again, contact the administrator of the
IBM Spectrum Protect server.
GVM5970E
The server is not licensed to perform
this action. If a license was purchased,
use the command line to register the
license.
Appendix B. Data Protection for Microsoft Hyper-V messages
163
GVM5971E • GVM5987E
GVM5971E
The specified destination is not valid.
GVM5979E
Explanation: See message.
User response: Enter a different destination or update
the configuration with a valid destination, and try the
action again.
GVM5972E
The specified input file cannot be
opened. Verify the file name and
directory permissions, then try the
action again.
The specified file space name is not
compatible with the filespace type.
Explanation: Unicode file space names are
incompatible with non-unicode names.
User response: Enter a file space name of the correct
type and try the action again.
GVM5980E
The specified TCP/IP address is not
valid. Verify the TCP/IP address and try
the action again.
GVM5981E
No objects were found that match the
search conditions.
GVM5982E
Your administrative ID on this server is
locked. An administrator with system
authority can unlock your ID.
Explanation: See message.
GVM5983E
User response: Check the file system to ensure that
there is enough space. Check the operating system
event or error log for more information.
The connection to the server was lost
while performing the action.
Explanation: See message.
GVM5973E
GVM5974E
GVM5975E
The specified output file cannot be
opened. Verify the file name and
directory permissions, then try the
action again.
An error occurred while writing to the
specified output file.
The specified administrator is not
defined to this server.
Explanation: See message.
User response: Ensure that the administrator name
was entered correctly. Before trying the action again,
contact the administrator of the IBM Spectrum Protect
server.
GVM5976E
The SQL statement could not be
processed.
Explanation: An exception occurred while processing
the SQL statement. Possible exceptions include
divide-by-zero, math overflow, temporary table storage
space unavailable, and data-type errors.
User response: Correct the SQL query and try again.
GVM5977E
This operation is not allowed with this
object.
User response: This might indicate a network
problem. Ensure that the server is running and the
machine is accessible. Retry the action.
GVM5984E
Explanation: See message.
User response: Enter a valid ID or password for your
IBM Spectrum Protect Server.
GVM5985E
GVM5978E
The table was not found in the server
database.
Your password expired on this server.
Explanation: Your IBM Spectrum Protect password
has expired.
User response: Reset your password on the IBM
Spectrum Protect Server or contact your IBM Spectrum
Protect Server administrator to reset it.
GVM5986E
The server cannot accept new sessions.
If sessions are disabled for this server,
issue the ENABLE SESSIONS command
from the command line.
GVM5987E
A communications failure occurred
while processing the request. Retry the
action at a later time.
Explanation: See message.
User response: Before trying the action again, contact
the administrator of the IBM Spectrum Protect server.
Your ID or password is not valid for
this server.
Explanation: See message.
User response: Before trying the action again, contact
the administrator of the IBM Spectrum Protect server.
164
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM5988E • GVM6004I
GVM5988E
The administrative API encountered an
internal error while processing the
request.
GVM5994E
The version of the server is not
supported by the Data Protection for
Virtual Environments GUI.
GVM5989E
The administrative API cannot process
the command document sent from the
server.
GVM5995E
An internal error has occurred.
Explanation: The XML command document could not
be parsed. Either the file could not be read, or the file
is corrupted.
User response: Before trying the action again, contact
the administrator of the IBM Spectrum Protect server.
GVM5990E
User response: Retry the operation. If this does not
work, contact customer support. You might be asked to
provide tracing information and information about the
actions performed before the failure occurred.
GVM5996E
The operation failed, please go to the
log for more details.
GVM5997E
Wrong format of the end date and time.
Please enter the end date and time
format as yyyyMMddHHmmss.
GVM5998E
Sorry, the description of the backup task
was not created in a file. Please try
again.
The following command contains one or
more invalid parameters: “”command“”.
Explanation: The Data Protection for Virtual
Environments GUI tried to run a command, but the call
to the API contained one or more invalid parameters.
User response: Check the parameters in the
command. If you entered text in a field, you might find
the error in the parameters and correct it. Viewing the
activity log might help to determine the cause of the
problem. Before trying the action again, contact the
administrator of the IBM Spectrum Protect server.
GVM5991E
Explanation: The operation failed after encountering
an internal error.
The administrative API encountered
invalid parameters while processing the
request.
Explanation: A command was run through the
administrative API, but one of the parameters to an
API method was invalid.
User response: This is typically an internal error, but
it can be caused by unusual parameters. For example,
characters such as: < > & can cause the problem. Check
the parameters in the command. If you entered text in
a field, you might find the error in the parameters and
correct it.
Explanation: On the general page of the backup
wizard, you can describe your backup task in general.
GVM5999E
The ESXHOST name you entered is too
long. Please change to a shorter one.
GVM6000E
Wrong Backup ID. Please try again.
GVM6001E
An error occurred when processing the
backup object file. Please try again later.
Explanation: When you click submit in the backup
wizard, the object list will be stored in a file. When
processing this file, an error occurred.
GVM6002E
GVM5992E
The administrator's authority level on
this server cannot be determined.
Explanation: See message.
User response: Use a different administrator ID.
Before trying the action again, contact the administrator
of the IBM Spectrum Protect server.
GVM5993E
An object with the name that you
specified already exists on the server.
Enter a different name.
No backup object is selected. You must
choose a source node to backup.
Explanation: To initiated a backup task, you have to
choose an object on the source page of the backup
wizard.
GVM6003E
Wrong format of the start date and time.
Please enter the start date and time
format as yyyyMMddHHmmss.
GVM6004I
Backup task Task Name started, would
you like to monitor this task now?
Appendix B. Data Protection for Microsoft Hyper-V messages
165
GVM6005I • GVM6028E
GVM6005I
Delete backup task completed
successfully.
GVM6006E
Delete backup task failed, please check
log for more detail.
GVM6007I
GVM6008E
GVM6009I
GVM6010I
GVM6011I
GVM6019E
The target virtual machine VM name is
running. Close the virtual machine
before restoring virtual disks to it.
GVM6020E
Some of selected virtual disks exist in
target virtual machine. Remove those
virtual disks from target virtual machine
before restoring to it.
GVM6021E
A VMCLI command failed.
Error: Error Messages
Restore Task Task ID is started
successfully, would you like to monitor
this task now?
Error Or Warning
Mounted backup Item could not be
restored.
Result of attach is status ( Task ID: Task
ID ), refer to events list to get the
details.
Result of detach is status ( Task ID: Task
ID ), refer to events list to get the
details.
GVM6012I
Command successfully submitted to the
IBM Spectrum Protect server.
Detail: Server Messages
GVM6013E
The command submitted to the IBM
Spectrum Protect server failed.
Error: Error Code
Error Messages
Explanation: The cause of the problem is identified in
the message text.
User response: Correct the problem based on the
information that is provided in the message text. Then,
try the action again.
GVM6023E
Explanation: The cause of the problem is identified in
the message text.
User response: Correct the problem based on the
information that is provided in the message text. Then,
try the action again.
GVM6024E
Cannot find the file with format
'summary.date.log' in the path: path
GVM6025E
Cannot find the IBM Spectrum
Snapshot installation path using the
VMCLI inquire_config command.
GVM6026E
A VMCLI command to get version
failed.
GVM6027I
Backup task Task ID started, would you
like to monitor this task now?
GVM6028E
The Data Protection for Virtual
Environments Web Server could not be
contacted.
Explanation: The cause of the problem is identified in
the message text.
User response: Correct the problem based on the
information that is provided in the message text. Then,
try the action again.
GVM6014E
No IBM Spectrum Protect server
connection, please configure the IBM
Spectrum Protect server in the
configuration panel.
GVM6015E
The selected items can only be under
ONE datacenter.
GVM6018E
The virtual machine VM name exists.
Delete the virtual machine first before
restoring it.
A command submitted to the IBM
Spectrum Protect server failed.
Error: Error Messages
Explanation: The Data Protection for Virtual
Environments GUI has attempted to contact its Web
Server. The operation was not successful.
User response: Perform one or more of the following
steps to try and determine the problem:
v Verify that the Data Protection for Virtual
Environments Web Server is running.
v Verify that the Web Server machine is running.
v Verify that the Web Server machine is accessible over
the network.
166
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM6029I • GVM6042E
Close the Data Protection for Virtual Environments
GUI. Start the GUI again when the problem is resolved.
GVM6029I
Command successfully submitted to the
server.
GVM6030E
No host is found in datacenter datacenter
name. Select another datacenter to
restore.
GVM6031W The schedule does not contain all the
required parameters. It cannot be
displayed in the properties notebook.
Explanation: This schedule may have been created or
modified outside of the Data Protection for Virtual
Environments GUI.
User response: This schedule must be modified
outside the the Data Protection for Virtual
Environments GUI.
GVM6032W One or more VMs exist. Do you want to
continue the restore operation and
overwrite the existing VMs?
GVM6033E
The Administrator Id provided does not
have sufficient privileges.
GVM6036E
Explanation: The new passwords entered do not
match.
User response: Clear the fields and enter the same
password in both password fields.
GVM6037W Please select one or more Datacenters to
be managed.
Explanation: At least one Datacenter must be selected.
User response: Add one or more Datacenter(s) into
the Managed Datacenters list.
GVM6038W One or more nodes do not have their
password set. Make sure all nodes have
their password set.
Explanation: If a node has 'Register Node' checkbox
set, then that node's password must be set.
User response: Assign a password for nodes that are
to be registered.
GVM6039I
No datacenter node was found mapped
to datacenter name. Select a datacenter
node from the list to associate with
datacenter name. Leave the selection
empty to have the Configuration Wizard
create a new datacenter node for it.
GVM6040I
Are you sure you want to proceed
without entering a IBM Spectrum
Protect Administrative ID?
Without IBM Spectrum Protect
Administrative access, the Wizard will
not validate node names or register
nodes. Instead, a macro file will be
generated at the end of this Wizard for
you to give to your IBM Spectrum
Protect Administrator to execute.
GVM6041I
This task was skipped because it was
not necessary or a pre-requisite task
failed.
GVM6042E
There was an error writing to script file:
file path.
Explanation: The operation you are attempting
requires a IBM Spectrum Protect Server Administrator
Id to have at least Unrestricted Policy privilege.
User response: Contact your IBM Spectrum Protect
Server Administrator to grant you Unrestricted Policy
privilege for your Administrative Id. Or, use an
alternate Id with such privilege and try again.
GVM6034E
The nodename node name is already in
use. Please choose another nodename.
Explanation: The node name chosen already exists on
the server. Choose another name.
User response: Pick another node name to use. If you
want to re-use this node, then unselect the 'Register
Node' checkbox.
GVM6035E
The node name node name is not defined
on server. Make sure the node name you
entered exists on the server.
Explanation: The node name entered does not exist on
the server. Since you did not select 'Register Node'
checkbox, the node name you enter must have been
previously defined and exist on the server.
The passwords in the entry field and
the verify field do not match. Please try
again.
Explanation: An error was encountered when trying
to write to file at the path indicated.
User response: Try the operation again.
User response: Check the node name you are
supposed to use and enter it again. If you want to
register this node, then select the 'Register Node'
checkbox.
Appendix B. Data Protection for Microsoft Hyper-V messages
167
GVM6043I • GVM6054I
GVM6043I
GVM6044I
GVM6045E
Managed datacenters have changed.
Please go to the data mover page to
verify or change your current mappings.
No datacenter nodes were found for the
vCenter node vCenter node and VMCLI
node VMCLI node configuration. The
Wizard will generate a default set of
datacenter nodes for you.
The password entered is not acceptable.
Choose another password.
Explanation: IBM Spectrum Protect Server could not
accept the password chosen. It could be because the
password did not meet certain password rule(s).
User response: Try using another node name.
GVM6049E
Explanation: IBM Spectrum Protect Server could not
accept the password chosen because of invalid
characters in the password.
User response: Try with another password that only
contain valid characters.
GVM6050E
User response: Try with another password.
GVM6046W Unchecking this checkbox means you
are supplying a node name that is
already defined on the IBM Spectrum
Protect Server AND that it is meant to
be used for your configuration. Since
this Wizard is proceeding without
Administrative access, it cannot verify if
the node exists or not. You should only
proceed if you understand what you are
doing.
Explanation: Since you are using the Configuration
Wizard without a IBM Spectrum Protect Administrative
ID, you should be very careful. The macro script file
generated at the end of running the Configuration
Wizard could contain errors because values are not
validated.
User response: We strongly recommend you use the
Configuration Wizard with a proper IBM Spectrum
Protect Administrative ID.
GVM6047W The IBM Spectrum Protect node node
has already been identified. If you want
a different name other than the default
name, edit this field again. If you want
to use the same data mover for multiple
Datacenters, please use Configuration
Settings to do this.
Explanation: The node is already being used in this
configuration.
User response: Try using another node name.
GVM6048W The IBM Spectrum Protect node node
has invalid characters or exceeds 64
characters. Choose a different name and
edit this field again.
Explanation: The node name is invalid or longer than
64 characters.
168
The password entered is not acceptable
on this Server because it contains
invalid characters. The valid characters
are: validCharsString
The password entered is not acceptable
on this Server because of the reason
below. Choose another password.
Error: message
Explanation: IBM Spectrum Protect Server could not
accept the password chosen. The reason why this
password is not valid is given in the message.
User response: Try with another password that meets
the rule(s).
GVM6051E
Filter has changed, select Apply filter
before continuing.
Explanation: Filter pattern must be applied after it is
changed.
User response: Click the Apply filter button.
GVM6052E
Select at least one item from a
datacenter to continue.
Explanation: A host, host cluster, or VM must be
selected to do a backup.
User response: Select an item under a datacenter.
GVM6053E
Your selections exceed the 512 character
limit allowed for backups, change your
selection.
Explanation: The number of characters required to list
the selected items exceeds the limit of 512 characters.
Also, if hosts have been partially selected, characters
are needed to list the VMs that are excluded from the
backup.
User response: Create multiple backup tasks, with less
selected items per task.
GVM6054I
Changing the newly added virtual
machines checkbox clears all selections
of host clusters, hosts, and virtual
machines. Press OK to proceed, or
Cancel to leave unchanged.
Explanation: The state of the newly added virtual
machines checkbox significantly impacts what is
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM6055E • GVM6065E
allowed to be selected on the source panel, so selections
are cleared when the state changes.
items, and make new selections under the other
datacenter or create a new backup task for these items.
User response: Select OK to proceed, or select Cancel
to retain all selections.
GVM6062E
GVM6055E
Datacenter node datacenter node name
does not have a IBM Spectrum Protect
node mapped in the vmcli configuration
file.
The password entered is not acceptable
on this Server because it is too short.
Passwords must have a least
minPasswordLength characters.
Explanation: IBM Spectrum Protect Server could not
accept the password chosen because it is too short.
Explanation: The datacenter node must have a
corresponding IBM Spectrum Protect node listed in the
configuration file named vmcliprofile.
User response: Try with another password that is
longer than the required minimum length.
User response: Correct the problem by going to the
Configuration tab in the GUI and selecting Edit
Configuration to update the mapping for the
datacenter. Also resolve any other configuration errors
that are reported on the Configuration tab.
GVM6063E
Component is downlevel, so its use is
disabled in the GUI. You will only be
able to use the GUI for component.
GVM6064E
Mismatching IBM Spectrum Protect
Server entries in the current settings is
detected.
IBM Spectrum Protect Server definition
used by the GUI:
server1
IBM Spectrum Protect Server where
backups are stored:
server2
Click “”Reset Server definition“” to
clear the IBM Spectrum Protect
definition and enter new credentials. Or
click on “”Reconfigure Environment“”
to launch the Configuration Wizard to
reconfigure your Data Protection for
Virtual Environments environment.
GVM6056E
IBM Spectrum Protect datacenter node
datacenter node name maps to vCenter
datacenter name datacenter name in the
vmcli configuration file, but datacenter
name does not exist in the vCenter.
Explanation: The vCenter datacenter name maps to a
datacenter node in the vmcli configuration file named
vmcliprofile, but the data enter name does not exist in
the vCenter.
User response: Correct the problem by going to the
Configuration tab in the GUI and selecting Edit
Configuration to update the mapping for the
datacenter. Also resolve any other configuration errors
that are reported on the Configuration tab.
GVM6057E
You have selected items from multiple
datacenters: datacenter list. This is not
allowed, all selections must be from one
datacenter.
Explanation: A backup task only supports items from
one datacenter. If this is an existing task, changes in the
vCenter configuration after task creation may have
caused this problem.
User response: Check and correct the selections to
make sure all selections are under the same datacenter.
GVM6058E
The selected items item list are not found
under datacenter datacenter name in the
vCenter, please review and de-select
them.
Explanation: Items originally selected are no longer
found under the datacenter associated with the backup
task. This may be caused by changes in the vCenter
configuration.
Explanation: IBM Spectrum Protect detected
mismatching IBM Spectrum Protect Server entries
between the vmcliprofile and the current GUI's IBM
Spectrum Protect Server connection.
User response: Pick one of the two actions available.
You may either reset the IBM Spectrum Protect Server
definition/credentials OR use the Conifiguration
Wizard to set up a new environment.
GVM6065E
The SSL Connection could not be made.
The IBM Spectrum Protect SSL
certificate is missing. Check for valid
IBM Spectrum Protect certificate in the
TSM-ve-truststore.jks
Explanation: IBM Spectrum Protect Server did not
accept the SSL connection. SSL keystore is not in the
default location or does not contain a IBM Spectrum
Protect certificate.
User response: Check the TSM-ve-truststore.jks for a
valid certificate, ensure TSM-ve-truststore.jks is in the
correct default location.
User response: Review if the items are now located
under a different datacenter. De-select the not found
Appendix B. Data Protection for Microsoft Hyper-V messages
169
GVM6066E • GVM6075E
GVM6066E
The password entered is not acceptable
on this Server because it is too long.
Passwords cannot have more than
maxPasswordLength characters.
GVM6070E
Explanation: IBM Spectrum Protect Server could not
accept the password chosen because it is too long.
User response: Try with another password that is
shorter than the allowed maximum length.
GVM6067E
The SSL Connection could not be made.
The IBM Spectrum Protect SSL
certificate is invalid.
Explanation: IBM Spectrum Protect Server did not
accept the SSL connection. The TSM-ve-truststore.jks
has an invalid IBM Spectrum Protect SSL certificate.
User response: Obtain a new valid IBM Spectrum
Protect SSL certificate from the IBM Spectrum Protect
server and place it in the TSM-ve-truststore.jks.
GVM6068E
User response: Use SSL with this Admin ID. Ensure
that the TSM-ve-truststore.jks with a valid IBM
Spectrum Protect server SSL certificate is installed in
the default location.
GVM6069E
Explanation: The backup task definition has a 512
character limit, and the total number of characters for
the selected items exceeds this limit.
User response: Create multiple backup tasks with less
selected virtual machines per task, or select the newly
added virtual machines checkbox and then select hosts
instead of individual virtual machines (you can
de-select a small number of virtual machines per host if
desired.)
GVM6071E
There is no data mover node proxy
relationship for datacenter node
datacenter node name. Review the data
mover relationships on the
Configuration tab or the IBM Spectrum
Protect server.
GVM6072E
There is no datacenter node defined for
datacenter datacenter name. Review the
node configuration on the Configuration
tab.
GVM6073I
Node name name is currently locked. The
Configuration Wizard will attempt to
unlock this node if you choose to
continue.
GVM6074E
A connection with the IBM Spectrum
Protect server (Address:Port) could not be
established. Please verify the server
address and admin port Server or Admin
port are correct.
The non-SSL connection could not be
made. This IBM Spectrum Protect
Admin ID requires a IBM Spectrum
Protect SSL connection.
Explanation: IBM Spectrum Protect Server did not
accept the non-SSL connection. The IBM Spectrum
Protect Server requires SSL be used with this Admin
ID.
Your selections have caused the backup
task definition to require count
characters, which exceeds the 512
character limit. This can be caused by a
long virtual machine exclude list, which
is the list of all VMs under host(s) that
were not selected. Either select more
VMs under selected hosts or de-select
the newly added virtual machines
checkbox.
Explanation: When the newly added virtual machines
checkbox is selected, the resulting backup task must list
all unselected VMs for hosts that are partially selected.
The backup task definition has a 512 character limit,
and the combination of selected items and excluded
VMs exceeds this limit.
User response: De-select the newly added virtual
machines checkbox or create multiple backup tasks
with less selected items per task.
Your selection of virtual machines has
caused the backup task definition to
require count characters, which exceeds
the 512 character limit. Either create
multiple backup tasks with less virtual
machines per task, or select the newly
added virtual machines checkbox and
choose entire hosts with no more than a
few unselected VMs.
Explanation: The server might not be running or
specified admin port or server admin port may be
incorrect.
User response: Check the network connection with
the IBM Spectrum Protect server machine. Verify that
the server is running and try to log in again. Also
verify server address and admin port information is
correct.
GVM6075E
The vCenter user name or password is
not valid. Please try again.
Explanation: The vCenter user name or password is
not valid.
170
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM6076E • GVM6086W
User response: Enter the user name or password
again.
GVM6076E
GVM6081I
Your current UI role does not allow you
to unlock or reset the VMCLI node. In
order to make changes, go to the Server
Credentials page and enter a IBM
Spectrum Protect Admin ID and
password that has the necessary
priviliges for making VMCLI node
updates. Select OK to save these
credentials, then re-open the
Configuration Settings notebook and
you can make VMCLI node updates.
GVM6082I
Your current UI role does not allow you
visit other panels. Select OK to save
these credentials, then re-open the
Configuration Settings notebook and
you can make other updates.
GVM6083I
There are non-English characters
contained in one or more datacenters.
The domain will be adjusted
accordingly.
GVM6084E
Datacenter DataCenter Name cannot be
added to the domain because it contains
non-English characters.
Permission to perform this operation
was denied. Please try with other user
name.
Explanation: The vCenter user name is not valid.
User response: Enter another user name.
GVM6077I
A IBM Spectrum Protect Administrative
ID and password is currently not set.
The absence of this information limits
the actions that you can take in the GUI.
Click OK to be taken to the
configuration settings panel and enter
an ID and password. Click Cancel to
continue without using an ID and
password.
GVM6078W You have chosen an Administrative ID
that has less authority than the current
ID. Are you sure you want change this
ID?
Current IBM Spectrum Protect Authority
Level: Current Level
New IBM Spectrum Protect Authority
Level: New Level
Current Role: Current Role
New Role: New Role
Click OK to accept these changes, or
Cancel to exit without change.
GVM6079I
GVM6080I
Here are the current and new roles for
IBM Spectrum Protect Admin IDs.
Review and confirm these changes.
Current IBM Spectrum Protect Authority
Level: Current Level
New IBM Spectrum Protect Authority
Level: New Level
Current Role: Current Role
New Role: New Role
Click OK to accept these changes, or
Cancel to exit without change.
ID has been changed without save.
Previous ID will be loaded.
Explanation: Datacenters that contain non-English
characters are not currently supported. Therefore, they
cannot be added to the domain.
User response: Datacenter will not be added to the
domain.
GVM6085W Node Node Name already exists on the
server. Attempt to rename node to New
Node Name?
Explanation: Node name is already registered on the
IBM Spectrum Protect server.
User response: Click Yes to attempt to rename node.
Click No to make other changes. Example: unclick
register node, rename node manually.
GVM6086W The following virtual machines for host
Host Name have unsupported characters
in their name: Invalid Virtual Machine
Names. Therefore, these virtual machines
are not backed up, regardless of your
selections. You must rename these
virtual machines to back them up.
Explanation: The following characters are not
supported in virtual machine names: “” ' : ; * ? , < > /
|
User response: Rename the identified virtual machines
to remove unsupported characters from their name.
Appendix B. Data Protection for Microsoft Hyper-V messages
171
GVM6087E • GVM6095E
GVM6087E
The following host clusters have
unsupported characters in their name:
Invalid Host Clusters. These host clusters
cannot be selected for backup because
they contain unsupported characters.
Rename these host clusters or remove
them from selection.
Explanation: The following characters are not
supported in host cluster names: “” ' : ; * ? , < > / |
User response: Rename the identified host clusters to
remove unsupported characters from their name. Or,
remove them from your backup selection.
GVM6088E
Your selections created an empty virtual
machine list for backup. This issue
might occur because all the selected
virtual machines contain unsupported
characters in their names. Make sure
that you selected virtual machines that
do not contain unsupported characters
in their names.
Explanation: The following characters are not
supported in virtual machine names: “” ' : ; * ? , < > /
| . Virtual machine names that contain these characters
are automatically removed from the backup task
definition. This removal can cause an empty task
definition.
User response: Rename the identified virtual machines
to remove unsupported characters from their name. Or,
select different virtual machines to back up.
GVM6089E
The filter pattern cannot be applied
because it contains unsupported
characters. Change the pattern to remove
the unsupported characters, then apply
the filter again.
Explanation: The following characters are not
supported in filter patern: “” ' : ; < > / |
User response: Change the filter pattern to remove
unsupported characters, then apply the filter again.
GVM6090E
A temporary datastore is not available to
perform this operation. This temporary
datastore is required in addition to the
restore destination datastore.
Explanation: A datastore is required for use as a
temporary restore destination for this operation. This
temporary datastore must be from the same ESX host
as the datastore that is used for the actual restore
destination. However, the temporary datastore cannot
be the same datastore that is used for the actual restore
destination.
GVM6091E
There was an error creating opt file: file
name.
Explanation: An error was encountered when trying
to write to file.
User response: Try the operation again.
GVM6092E
Creating service has failed. No services
were created for data mover node node
name.
Explanation: An error was encountered when trying
to create IBM Spectrum Protect service for data mover
node specified.
User response: Check environment and ensure user
has proper rights before trying operation again.
GVM6093E
Creating firewall for service has failed.
Please manually add firewall rules for
services installed.
Explanation: An error has occured when attempting
to add firewall rule for specified executable.
User response: Check environment and ensure user
has proper rights before trying operation again or
manually add rule to firewall for IBM Spectrum Protect
client acceptor , IBM Spectrum Protect Agent and IBM
Spectrum Protect Scheduler.
GVM6094W Local services were setup successfully
but were unable to verify firewall access
for these executable files:
agentExe
cadExe
schedExe
If any problems are experienced related
to local services, verify that firewall
access is available for these executable
files.
Explanation: Microsoft firewall may be disabled or
another firewall may be in place.
User response: Check environment and add rules
manually if needed for the IBM Spectrum Protect client
acceptor, IBM Spectrum Protect Agent, and IBM
Spectrum Protect Scheduler.
GVM6095E
Data mover node node name was
successfully registered on the server,
however no services were created.
Explanation: An error has occured when trying to
create services for specified node.
User response: Check environment and ensure user
has proper rights before trying operation again.
User response: Add a datastore to the destination ESX
host. Then, select this datastore as the temporary
restore destination.
172
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM6096E • GVM6101W
GVM6096E
Reason Code reason
This error was reported by the IBM
Spectrum Protect data mover. No further
description is available. For more
information, review the error log
errorLog on the data mover host machine
hostname at address 'address'.
Explanation: The data mover encountered an error
with the reported reason code.
User response: Log into the host machine specified
and view the error log for more information.
GVM6097W Scan schedule schedule name was
successfully defined on the server and
associated with node node name, however
no services were created to run the
schedule.
Detail: error
Explanation: An error was encountered in one of the
steps below when trying to create IBM Spectrum
Protect services for the VMCLI node.
1. Create the option file for the VMCLI node.
2. Set the password for the VMCLI node to a
temporary password for the next step.
3. Run the IBM Spectrum Protect Client Service
Configuration Utility to create the services.
4. Run the IBM Spectrum Protect Client Service
Configuration Utility to start the client acceptor
service.
5. Reset the VMCLI node password.
User response: Delete the schedule and create the
schedule again to automatically configure the services
or manually configure the services. Check environment
and ensure user has proper rights before trying
operation again.
GVM6098W Scan schedule schedule name was
successfully defined on the server and
associated with node node name. IBM
Spectrum Protect services were created
to run the schedule. However, reseting
the VMCLI node password failed.
Detail: error
Explanation: An error was encountered while trying
to reset the VMCLI node password.
User response: Use the Configuration Settings to reset
the VMCLI node password.
GVM6099W Warning: If this task is canceled, all
created data on the virtual machines that
are not completely restored is lost and
the virtual machines are removed from
the ESX host.
Are you sure that you want to cancel
this task?
Explanation: A cancel task command is submitted.
Refresh to see the cancel progress.
User response: Cancel the selected task or allow the
task to continue processing.
GVM6100W A dismount operation removes the
iSCSI disks but does not remove the
VM or its data. Before proceeding with
dismount, make sure the following
conditions exist:
-The mounted iSCSI disk is recovered.
-Storage vMotion completed migrating
the VM to a local datastore.
If the recovery operation failed and you
want to delete the VM, its data, and
dismount any iSCSI targets, click
Dismount and Delete. Dismount and
Delete is a destructive action and
deletes the VM and its data, regardless
of the success or failure of the instant
restore operation.
Based on this information, do you want
dismount the VMs that are selected for
instant restore?
Explanation: A dismount operation removes the iSCSI
disks but does not remove the VM or its data. Before
proceeding with dismount, make sure the following
conditions exist: The mounted iSCSI disk is
recovered,Storage vMotion completed migrating the
VM to a local datastore.If the recovery operation failed
and you want to delete the VM, its data, and dismount
any iSCSI targets, click Dismount and Delete. Dismount
and Delete is a destructive action and deletes the VM
and its data, regardless of the success or failure of the
instant restore operation.
User response: Click 'Dismount' to dismount the
virtual machines that are selected for the instant restore
operation. Click 'Dismount and Delete' to dismount the
virtual machines that are selected for the instant restore
operation, remove them from the ESX host, and verify
that Storage vMotion is not running.
GVM6101W During a dismount operation, all created
data on the virtual machines is lost and
the virtual machines are removed from
the ESX host.
Dismount the selected Instant Access
virtual machines?
Explanation: All created data on the virtual machines
is lost and the virtual machines are removed from the
ESX host.
User response: Click 'Dismount' to dismount
(cleanup) the instant access virtual machines.
Appendix B. Data Protection for Microsoft Hyper-V messages
173
GVM6102E • GVM6115W
GVM6102E
Selecting multiple virtual machines with
different restore types is not allowed.
GVM6109E
You do not have the privileges required
to access the GUI.
Explanation: Restoring multiple virtual machines with
different restore types is not supported.
Explanation: In order to access GUI content, the user
must have the necessary vSphere privileges.
User response: Select virtual machines that have the
same restore type.
User response: Add the required privileges for the
user.
GVM6103I
Cleanup Task Task ID is started
successfully, would you like to monitor
this task now?
GVM6104W Are you sure that you want to cancel
this task?
Explanation: A cancel task command is submitted.
Refresh to see the cancel progress.
GVM6110E
Explanation: In order to access GUI content, the user
must have the necessary vSphere permissions.
User response: Add the required permissions for the
user.
GVM6111I
User response: Cancel the selected task or allow the
task to continue processing.
GVM6105I
Your current UI role does not allow you
to view backup property notebook.
GVM6106I
Your current UI role does not allow you
to edit nodes. In order to make changes,
open the Configuration Settings
notebook and go to the Server
Credentials page and enter a IBM
Spectrum Protect Admin ID and
password that has the necessary
priviliges for making node updates.
GVM6107E
Reason Code reason
This error was reported by the IBM
Spectrum Protect data mover. No further
description is available. For more
information, review the error log
'dsmerror.log' on the data mover host
machine.
Explanation: The data mover encountered an error
with the reported reason code.
User response: Log into the host machine where data
mover resides and view the error log for more
information.
GVM6108W Login information for vCenter needed.
Explanation: In order to install new local dm services,
vCenter credentials are needed.
User response: Enter vCenter credentials in order to
continue.
174
You do not have the permissions
required to access the GUI.
A new data center (name) was detected.
Go to the Data Mover Nodes page to
add a data center node for it.
GVM6112W The following shares and mounts will
be removed and that data in there will
be no longer accessible to the end user.
Dismount the selected shares and
mounts?
mounts
Explanation: The selected shares and mounts will be
removed.
User response: Click 'Dismount' to dismount
(cleanup) the mounts and shares.
GVM6113I
Dismount Task Task ID is started
successfully, would you like to monitor
this task now?
GVM6114W An error was encountered during the
delete operation for option file: file name.
Explanation: An error was encountered during the
delete operation. For example, this error might be
caused by insufficient user permissions or the file no
longer exists.
User response: Make sure the option file was deleted.
If it still exists, delete this file manually.
GVM6115W The remove operation for IBM Spectrum
Protect service: service failed.
Explanation: An error prevented the IBM Spectrum
Protect service from being removed.
User response: Check the environment and ensure
that the user has sufficient rights to run this operation.
Then, try the operation again.
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM6116E • GVM6128E
GVM6116E
Fail to start iSCSI for mount proxy node
node name.
GVM6122E
Explanation: An error was encountered when trying
to start iSCSI service for mount proxy node specified.
User response: Start the iSCSI service manually.
GVM6117E
The connection to the IBM Spectrum
Protect server was not successful
because either the server credentials are
invalid or an SSL certificate is required
but could not be obtained.
Explanation: A correct server user ID and password
and an SSL certificate for the IBM Spectrum Protect
server are required to connect to the server.
User response: Go to the 'Configuration > Tasks >
Edit IBM Spectrum Protect Configuration > Server
Credentials' notebook page. Confirm that the login
credentials are correct, that the correct port number is
entered for the IBM Spectrum Protect admin port, and
that the 'Use SSL...' checkbox is selected. The server's
certificate must be retrieved and a truststore created
using the procedure that is documented in the 'Learn
more...' link.
GVM6118E
GVM6119E
You have selected organization VDCs
from more than one provider VDC. For
backup tasks, all selected organization
VDCs must belong to the same provider
VDC. Change your selections and retry
the operation.
The following vcloud resources(vApp,
organization, organization vDC) are
invalid for selection because they have
unsupported characters in their name:
reslist
Explanation: In order to create backup tasks, vcloud
resources names must not contain any of the following
characters: “” ' : ; * ? , < > / | .
User response: Rename the identified resources to
remove unsupported characters from their name. Or,
remove them from your backup selection.
GVM6120E
GVM6121E
You have selected the vApp from a
different organization VDC. For restore
tasks, all selected vApps must belong to
the same organization VDC. Change
your selections and retry the operation.
The vApp vApp name exists. Choose a
different vApp name to be the target of
the restore.
Your selection of items to back up has
caused the backup task definition to
require count characters, which exceeds
the 512 character limit. Please create
multiple backup tasks with less items
per task.
Explanation: The backup task definition has a 512
character limit, and the total number of characters for
the selected items exceeds this limit.
User response: Create multiple backup tasks with less
items per task
GVM6123E
The Organization VDC node can not be
included because its Provider VDC node
is not included. Please select the include
checkbox for the Provider VDC node
first, and try again.
GVM6124E
The nodename node name is already in
use. Please uncheck the register node
checkbox or choose another nodename.
Explanation: The node name chosen already exists on
the server. Either choose to not register it or use
another name.
User response: Pick another node name to use. If you
want to re-use this existing node, then unselect the
'Register Node' checkbox.
GVM6125W Are you certain that you want to remove
the data mover node node name?
GVM6126W The IBM Spectrum Protect node node
has already been used. If you want a
different name other than the default
name, edit this field again.
Explanation: The node is already being used in this
configuration.
User response: Try using another node name.
GVM6127E
The Organization VDC node can not be
registered because its provider VDC is
not valid.
GVM6128E
The Organization VDC name OVDC
name is invalid. For information about
supported characters, refer to the IBM
Spectrum Protect Administrator's
Reference publication section about
naming IBM Spectrum Protect objects.
Appendix B. Data Protection for Microsoft Hyper-V messages
175
GVM6129I • GVM6148E
GVM6129I
This task was skipped because it was
not necessary. No further action is
required.
GVM6130W Internet explorer version version is not
supported, please use a supported
version or another browser. You may see
visual and functional issues if you
continue to use this unsupported
browser.
Explanation: Due to differences in Internet Explorer
implementation by version number, only specific
versions are supported. The use of a
standards-compliant browser such as Mozilla Firefox is
recommended. However, if you are accessing the GUI
as a plug-in from the vSphere Client, you are limited to
using the Internet Explorer browser installed on the
system where the vSphere client is installed.
User response: Use a supported version of Internet
Explorer or another browser. Supported browser
versions are documented in the online help.
GVM6131W The browser version is not supported,
please use a supported browser. You
may see visual and functional issues if
you continue to use this unsupported
browser.
Explanation: Due to differences in browser
implementations, only specific versions are supported.
GVM6134E
The user User Name is not authorized to
any managed datacenters. Contact your
system administrator.
GVM6135E
You do not have required permissions to
view virtual machines for this Event.
GVM6136E
You do not have required permissions to
view restore points for this virtual
machine.
GVM6137E
You do not have required permissions to
view some attached points.
GVM6138E
You do not have required permissions to
view restore points for this datastore.
GVM6139E
You do not have required permissions to
detach for the restore point.
GVM6140E
An error occurred processing user
permissions. Contact your system
administrator.
GVM6141I
Some datacenters are not shown due to
permissions requirements.
GVM6142E
You do not have permissions to cancel
this task.
GVM6143I
The task is still in the starting state,
please refresh the task and try the
cancel again.
GVM6147I
Some datacenters are not available
because they have the same name for
one or more datacenters. Datacenters
with the same name are not supported.
GVM6148E
Windows domain credentials are
incorrect. Open the Configuration
wizard, go to File Restore page, and try
entering the credentials again.
User response: Use a supported browser. Supported
browser versions are documented in the online help.
GVM6132E
At least one virtual machine that you
have selected for restore to alternate
location already exists in the Datacenter,
so restore is not allowed. To restore to
an alternate location when the
destination virtual machine already
exists, select only one virtual machine
for the restore operation and choose a
new name for the destination virtual
machine. Duplicated VM: VM name
Explanation: When restoring to an alternate location,
the destination virtual machine must not already exist.
User response: Use the single virtual machine restore
wizard so that you can rename the destination virtual
machine.
GVM6133W Target datastore not found, select a
different destination datastore.
176
Explanation: The Windows domain credentials that
was entered on the File Restore page in the
Configuration wizard is incorrect.
System action: Processing stops.
User response: Run the Configuration wizard again
and re-enter the correct Windows domain credentials.
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
GVM6149E • GVM6162E
GVM6149E
GVM6150E
GVM6151E
GVM6152E
GVM6153E
This action cannot be peformed because
there is not a VMCLI node defined. To
resolve, use the configuration wizard to
define the VMCLI node and complete
the other steps in the wizard.
This action cannot be peformed because
there is not a vCloud Director node
defined. To resolve, use the
configuration wizard to define the
vCloud Director node and complete the
other steps in the wizard.
This action cannot be peformed because
the connection to the IBM Spectrum
Protect Server is not operational. Correct
the connection problem, and retry this
action.
This task requires use of the provider
VDC node provider VDC node name from
IBM Spectrum Protect, but this node is
not mapped to a known provider VDC
in the vCloud Director.
This task may not be updated, instead
create a new task without dependence
on this provider VDC.
The Organization VDCs listed below
were selected but are not configured to
the IBM Spectrum Protect server. You
must remove these selections in order to
execute this action.
org VDC name
GVM6154I
Your current UI role does not allow you
to view node details.
GVM6155E
An error occurred when connecting to
the IBM Spectrum Protect server server
name. Either your admin ID or password
is not valid, or the TCPPORT number
was entered in the admin port field
instead of the TCPADMINPORT or
SSLTCPADMINPORT number.
Explanation: See message.
User response: Launch the Configuration Editor from
the Configuration Tab and enter a valid ID or password
for your IBM Spectrum Protect Server.
User response: Contact your IBM Spectrum Protect
Server administrator to reset the password for the
administrative user ID.
GVM6157E
Explanation: The value entered in the IBM Spectrum
Protect server port field must match the TCPPORT
option on the IBM Spectrum Protect server.
User response: Use the configuration wizard to
change the IBM Spectrum Protect server port field to
the correct value.
GVM6159E
An error occurred while processing a
VMCLI command, and the GUI session
will be closed. Log in and try the
operation again. If the problem persists,
contact your administrator.
GVM6160E
An error occurred while writing to the
frConfig.props configuration file.
Explanation: The frConfig.props file contains
configuration options for file level restore processing.
Possible reasons for this error include the following
situations:
v The frConfig.props file is not in the Data Protection
for Virtual Environments installation directory.
v The frConfig.props file is write-protected.
System action: Processing stops.
User response: Verify that the file exists in the Data
Protection for Virtual Environments installation
directory and that the file is not write-protected.
GVM6161E
The password for the administrative
user ID admin id expired on the IBM
Spectrum Protect server server name.
Explanation: Your IBM Spectrum Protect
administrative password has expired.
The local mount proxy node pair cannot
be removed while the file level restore
feature is enabled.
Explanation: File level restore processing requires a
local mount proxy node.
User response: Disable the file level restore feature.
Then, choose whether you want to remove the mount
proxy node pair.
GVM6162E
GVM6156E
The IBM Spectrum Protect server port
number tcp port is incorrect. The
expected value for this port is tcp port
from query, which is the value of the
TCPPORT option. Please enter the
expected value using the configuration
wizard.
An error occurred while reading the
frConfig.props configuration file.
Explanation: The frConfig.props file contains
configuration options for file level restore processing.
The file cannot be read. A common reason for this error
is that the file is read-protected.
Appendix B. Data Protection for Microsoft Hyper-V messages
177
GVM6164W • GVM6173E
System action: Processing stops.
User response: Verify that the file is not
read-protected.
GVM6164W The connection to the IBM Spectrum
Protect server was not successful
because a security certificate is required.
and creating the services for backup and restore,
registering the mount proxy nodes and creating the
services for file level restore. One of these tasks
encountered an error.
User response: Fix the error and retry the operation.
GVM6169E
Unexpected error while configuring to
the IBM Spectrum Protect server.
Explanation: Secure connections to the IBM Spectrum
Protect server require an SSL certificate to create the
connection. No certificate was found for the selected
IBM Spectrum Protect server.
Explanation: Possible reasons for this error include the
following situations:
User response: If this message was not presented as
part of using the configuration wizard, it must be
retrieved and a truststore created using the procedure
that is documented in the help.
v Unknown error while trying to write to the server's
database file, tsmserver.props.
GVM6165E
The specified target node 'node-name'
does not match the node 'node-name'
stored in the user session.
Explanation: The input target node to the
configuration host operation does not match the target
node stored in the connected session.
User response: Retry the operation with the correct
target node name.
GVM6166E
A user session is invalid or no SSL
certificate to accept.
Explanation: The initial IBM Spectrum Protect server
connection detects that it requires an SSL certificate and
the operation must be called again with the same
connection. In this case, the connection is null or
invalid.
User response: Make sure the operation call the
second time to accept the certificate is using the same
iniital connection.
GVM6167E
A Windows mount proxy node and a
Linux mount proxy node are required to
enable File Restore.
Explanation: Either one mounnt proxy node or no
proxy node were specified for the configure host
operation.
User response: Retry the operation with a node list
that have a Windows mount proxy node and a Linux
mount proxy node.
GVM6168E
Configure host failed. Check the tasks
list for more information.
v Unknown error while trying to connecting to the
IBM Spectrum Protect server.
User response: Check the network connection with
the IBM Spectrum Protect server machine. Verify that
the server is running and try to log in again. Also
verify server port information is correct.
GVM6170E
Unexpected error, can not get policy
domain for node 'node-name'.
Explanation: The target node does not exist on the
IBM Spectrum Protect server or an internal error
occurred during the node query.
User response: Run the configuration wizard to
register the target node or update the node to another
policy domain.
GVM6171E
Unexpected error, schedule
'schedule-name' does not exist on the IBM
Spectrum Protect server.
Explanation: The schedule may have been deleted
accidently during the operation.
User response: Select a different schedule.
GVM6172E
'domain-name' is not a valid Windows
domain.
Explanation: LOCALHOST or the computer name are
not valid domains.
User response: Enter a valid domain.
GVM6173E
The domain is missing from the user
name.
Explanation: The user name you entered is not part of
a domain.
User response: Ensure that the user name is in the
DOMAIN\UserName format.
Explanation: Configuring the host consists of
registering the target node, registering the data mover
178
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Appendix C. Accessibility features for the IBM Spectrum
Protect product family
Accessibility features assist users who have a disability, such as restricted mobility
or limited vision, to use information technology content successfully.
Overview
The IBM Spectrum Protect family of products includes the following major
accessibility features:
v Keyboard-only operation
v Operations that use a screen reader
The IBM Spectrum Protect family of products uses the latest W3C Standard,
WAI-ARIA 1.0 (www.w3.org/TR/wai-aria/), to ensure compliance with US Section
508 (www.access-board.gov/guidelines-and-standards/communications-and-it/
about-the-section-508-standards/section-508-standards) and Web Content
Accessibility Guidelines (WCAG) 2.0 (www.w3.org/TR/WCAG20/). To take
advantage of accessibility features, use the latest release of your screen reader and
the latest web browser that is supported by the product.
The product documentation in IBM Knowledge Center is enabled for accessibility.
The accessibility features of IBM Knowledge Center are described in the
Accessibility section of the IBM Knowledge Center help (www.ibm.com/support/
knowledgecenter/about/releasenotes.html?view=kc#accessibility).
Keyboard navigation
This product uses standard navigation keys.
Interface information
User interfaces do not have content that flashes 2 - 55 times per second.
Web user interfaces rely on cascading style sheets to render content properly and
to provide a usable experience. The application provides an equivalent way for
low-vision users to use system display settings, including high-contrast mode. You
can control font size by using the device or web browser settings.
Web user interfaces include WAI-ARIA navigational landmarks that you can use to
quickly navigate to functional areas in the application.
Vendor software
The IBM Spectrum Protect product family includes certain vendor software that is
not covered under the IBM license agreement. IBM makes no representation about
the accessibility features of these products. Contact the vendor for accessibility
information about its products.
© Copyright IBM Corp. 2011, 2017
179
Related accessibility information
In addition to standard IBM help desk and support websites, IBM has a TTY
telephone service for use by deaf or hard of hearing customers to access sales and
support services:
TTY service
800-IBM-3383 (800-426-3383)
(within North America)
For more information about the commitment that IBM has to accessibility, see IBM
Accessibility (www.ibm.com/able).
180
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Notices
This information was developed for products and services offered in the US. This
material might be available from IBM in other languages. However, you may be
required to own a copy of the product or product version in that language in order
to access it.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US
For license inquiries regarding double-byte character set (DBCS) information,
contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of
express or implied warranties in certain transactions, therefore, this statement may
not apply to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM websites are provided for
convenience only and do not in any manner serve as an endorsement of those
© Copyright IBM Corp. 2011, 2017
181
websites. The materials at those websites are not part of the materials for this IBM
product and use of those websites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Director of Licensing
IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US
Such information may be available, subject to appropriate terms and conditions,
including in some cases, payment of a fee.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
The performance data discussed herein is presented as derived under specific
operating conditions. Actual results may vary.
Information concerning non-IBM products was obtained from the suppliers of
those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which
illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.
182
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Each copy or any portion of these sample programs or any derivative work must
include a copyright notice as follows: © (your company name) (year). Portions of
this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp.
_enter the year or years_.
Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at "Copyright and
trademark information" at www.ibm.com/legal/copytrade.shtml.
Adobe is a registered trademark of Adobe Systems Incorporated in the United
States, and/or other countries.
Linear Tape-Open, LTO, and Ultrium are trademarks of HP, IBM Corp. and
Quantum in the U.S. and other countries.
Intel and Itanium are trademarks or registered trademarks of Intel Corporation or
its subsidiaries in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other
countries, or both.
Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in
the United States, other countries, or both.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
SoftLayer® is a registered trademark of SoftLayer, Inc., an IBM Company.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
VMware, VMware vCenter Server, and VMware vSphere are registered trademarks
or trademarks of VMware, Inc. or its subsidiaries in the United States and/or other
jurisdictions.
Terms and conditions for product documentation
Permissions for the use of these publications are granted subject to the following
terms and conditions.
Applicability
These terms and conditions are in addition to any terms of use for the IBM
website.
Personal use
You may reproduce these publications for your personal, noncommercial
use provided that all proprietary notices are preserved. You may not
distribute, display or make derivative work of these publications, or any
portion thereof, without the express consent of IBM.
Commercial use
You may reproduce, distribute and display these publications solely within
Notices
183
your enterprise provided that all proprietary notices are preserved. You
may not make derivative works of these publications, or reproduce,
distribute or display these publications or any portion thereof outside your
enterprise, without the express consent of IBM.
Rights Except as expressly granted in this permission, no other permissions,
licenses or rights are granted, either express or implied, to the publications
or any information, data, software or other intellectual property contained
therein.
IBM reserves the right to withdraw the permissions granted herein
whenever, in its discretion, the use of the publications is detrimental to its
interest or, as determined by IBM, the above instructions are not being
properly followed.
You may not download, export or re-export this information except in full
compliance with all applicable laws and regulations, including all United
States export laws and regulations.
IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE
PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES
OF MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A
PARTICULAR PURPOSE.
Privacy policy considerations
IBM Software products, including software as a service solutions, (“Software
Offerings”) may use cookies or other technologies to collect product usage
information, to help improve the end user experience, to tailor interactions with
the end user, or for other purposes. In many cases no personally identifiable
information is collected by the Software Offerings. Some of our Software Offerings
can help enable you to collect personally identifiable information. If this Software
Offering uses cookies to collect personally identifiable information, specific
information about this offering’s use of cookies is set forth below.
This Software Offering does not use cookies or other technologies to collect
personally identifiable information.
If the configurations deployed for this Software Offering provide you as customer
the ability to collect personally identifiable information from end users via cookies
and other technologies, you should seek your own legal advice about any laws
applicable to such data collection, including any requirements for notice and
consent.
For more information about the use of various technologies, including cookies, for
these purposes, see IBM’s Privacy Policy at http://www.ibm.com/privacy and
IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details in the
section entitled “Cookies, Web Beacons and Other Technologies,” and the “IBM
Software Products and Software-as-a-Service Privacy Statement” at
http://www.ibm.com/software/info/product-privacy.
184
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Glossary
A glossary is available with terms and definitions for the IBM Spectrum Protect family of products.
See the IBM Spectrum Protect glossary.
To view glossaries for other IBM products, see IBM Terminology.
© Copyright IBM Corp. 2011, 2017
185
186
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
Index
A
accessibility features 179
actions pane
Data Protection for Microsoft Hyper-V Management
Console 62
ad hoc backups
Data Protection for Microsoft Hyper-V Management
Console 67
archive
list of files 114
B
back up
parallel 130
back up Hyper-V VMs 1
back up VMs now
Data Protection for Microsoft Hyper-V Management
Console 67
backup
incremental forever
description 9
limitations 10
policy management 9
RCT backup
description 2
user interfaces
description 5
VSS backup
description 2
backup history
Data Protection for Microsoft Hyper-V Management
Console 66
backup status
Data Protection for Microsoft Hyper-V Management
Console 66
backup vm command 91
best practices
excluding VMs 71
C
cluster backups on Windows Server 2012
reducing schedule contention 52
commands
backup vm 91
expire 99
mount 145
query VM 100
restore vm 104
set_connection 148
configuration
advanced tasks 51
configuration wizard 29
clusters 29
file restore 29
stand-alone host 29
configure
default port numbers 51
file restore options 39
© Copyright IBM Corp. 2011, 2017
configure (continued)
Linux mount proxy for file restore 37
configuring
clusters 29
file restore 29, 35
IBM Spectrum Protect recovery agent GUI 42
initial configuration 29
iSCSI mount 49
overview 29
security settings 29, 33
stand-alone host 29
configuring TLS
enable secure communication with the server 46, 48
control files 128
D
data move node
overview 7
Data Protection for Microsoft Hyper-V
configuring tracing 157
installing on Server Core 25
troubleshooting
diagnostic procedure 156
upgrading 16
Data Protection for Microsoft Hyper-V features
installable 16
Data Protection for Microsoft Hyper-V Management Console
actions pane 62
as a snap-in 55
configuring logging 40
description 56
logging in 55
logging options 41
navigation pane 56
overview 55
restoring a VM 69
results pane 56
running an ad hoc backup 67
Schedule History view 59
set backup policy 63
setting schedules 63
setting the at-risk policy 65
starting 55
Tasks pane 61
view backup history 66
view backup status 66
viewing schedule history 66
Virtual Machines view 57
Data Protection for Microsoft Hyper-V Management Console
reconnecting 55
Data Protection for Microsoft Hyper-V overview 1
date format
specifying 107
dateformat option 107
description
Data Protection for Microsoft Hyper-V Management
Console 56
detail option 109
disability 179
187
disk space requirements
Windows client 15
documentation 12
domain
include for full vm backups
domain.vmfull option 109
109
E
enable secure communication with the server
configuring TLS 46, 48
errors 153
exclude
EXCLUDE.VMDISK 112
EXCLUDE.VMDISK 112
excluding VMs
best practice 71
expire command 99
F
file restore
common tasks 73
configure Linux mount proxy 37
configuring 35
configuring logging 40
configuring options 39
configuring tracing 157
description 73
installing Linux mount proxy 22
logging in 76
logging options 41
options 39
prerequisites 74
procedure 76
removing 28
roles 73
file space 109
filelist option 114
files
archive a list of 114
restore overview 139
restore task (Windows) 141
K
keyboard 179
Knowledge Center
LAN environment 138
limitations on Hyper-V backup operations 10
logging
Data Protection for Microsoft Hyper-V Management
Console 40
file restore 40
logging in Data Protection for Microsoft Hyper-V Management
Console 55
M
115
H
hardware requirements
Windows client 15
Hyper-V cmdlets 10
Hyper-V snapshots
deleting 10
rolling back 10
I
IBM Knowledge Center v
IBM Spectrum Protect recovery agent GUI
configuring 42
options 42
188
v
L
G
group backup
display active and inactive objects
import security certificate
for servers earlier than V8.1.2 or V7.1.8 34
for servers later than V8.1.2 or V7.1.8 29
inactive option 115
include
INCLUDE.VMDISK 117
include.vm option 116
INCLUDE.VMDISK 117
include.vmsnapshotattempts option 119
incremental backup
process a list of files 114
incremental forever
description 9
installable features
Data Protection for Microsoft Hyper-V 16
installation package
download 19
installation procedure
download package 19
recovery agent 23
silent 24
typical 20
installing
Linux mount proxy for file restore 22
on Server Core systems 25
overview 15
iSCSI mount
configuring 49
management class 9
managing snapshots 10
Mbobjrefreshthresh 121
Mbpctrefreshthresh 122
memory requirements
Windows client 15
messages
ANS prefix 159
Data Protection for Microsoft Hyper-V 159
GVM prefix 159
migrating
nodes 16
mode option 120
mount command 145
mount proxy node
overview 7
mounting snapshots 138
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
N
navigation pane
Data Protection for Microsoft Hyper-V Management
Console 56
new features in Data Protection for Microsoft Hyper-V
V8.1.4 vii
noprompt option 123
numberformat
specifying 123
numberformat option 123
O
online help
PowerShell cmdlets 80
options
dateformat 107
detail 109
domain.vmfull 109
EXCLUDE.VMDISK 112
file restore 39
filelist 114
inactive 115
include.vm 116
INCLUDE.VMDISK 117
include.vmsnapshotattempts
mbobjrefreshthresh 121
mbpctrefreshthresh 122
mode 120
noprompt 123
numberformat 123
pick 125
pitdate 125
pittime 126
skipsystemexclude 126
timeformat 127
vmbackdir 128
vmbackupupdateguid 93
vmmaxparallel 130
vmmaxpersnapshot 131
vmmaxsnapshotretry 133
vmmc 134
vmprocessvmwithphysdisks
vmskipphysdisks 136
options reference 107
overview
back up Hyper-V VMs 1
Data Protection for Microsoft
Data Protection for Microsoft
Console 55
Hyper-V environment 5
nodes 7
policy management 9
restore Hyper-V VMs 4
user interfaces 5
VM backups with RCT 2
VM backups with VSS 2
P
parallel backups 130
pick option 125
pitdate 125
pittime option 126
port numbers
configure 51
PowerShell cmdlets
getting help 80
list 80
prerequisite steps 79
protect VMs 80, 83
tasks 83
using 79
prerequisite steps
PowerShell cmdlets 79
problem determination 153
protect VMs
PowerShell cmdlets 80, 83
publications v
Q
query
backups, establish point-in-time 125, 126
display active and inactive objects 115
query VM command 100
R
119
135
Hyper-V 1
Hyper-V Management
RCT backups
description 2
features 2
migrating to 2
upgrade considerations 18
reconnect to
Data Protection for Microsoft Hyper-V Management
Console 55
recovery agent
installation procedure 23
removing file restore 28
resilient change tracking (RCT) backups 2
restore
backups, establish point-in-time 125, 126
configuring logging 40
configuring options 39
create list of backup versions to 125
display active and inactive objects 115
file 39, 40, 41, 74, 76
file restore description 73
file restore roles 73
file restore tasks 73
Hyper-V VMs
description 4
list of files 114
logging in 76
options 39, 41
prerequisites 74
procedure 76
user interfaces
description 5
restore a VM
Data Protection for Microsoft Hyper-V Management
Console 69
restore vm command 104
results pane
Data Protection for Microsoft Hyper-V Management
Console 56
retrieve
list of files 114
Index
189
S
V
Schedule History view
Data Protection for Microsoft Hyper-V Management
Console 59
scheduled cluster backups on Windows Server 2012
tuning 52
security settings
configuring 33
to connect to servers earlier than V8.1.2 or V7.1.8 34
to connect to servers later than V8.1.2 or V7.1.8 29
set backup policy
Data Protection for Microsoft Hyper-V Management
Console 63
set_connection command 148
setting schedules
Data Protection for Microsoft Hyper-V Management
Console 63
setting the at-risk policy
Data Protection for Microsoft Hyper-V Management
Console 65
silent install 24
skipsystemexclude 126
snap-in
Data Protection for Microsoft Hyper-V Management
Console 55
snapshot management 10
snapshots
mounting 138
SSL
configuring 46, 48
starting
Data Protection for Microsoft Hyper-V Management
Console 55
syntax diagram
reading 89
repeating values 89
required choices 89
system state
display active and inactive objects 115
view schedule history
Data Protection for Microsoft Hyper-V Management
Console 66
Virtual Machines view
Data Protection for Microsoft Hyper-V Management
Console 57
vmbackdir option 128
vmbackupupdateguid option 93
vmctlmc option 9
options
vmctlmc 129
vmmaxparallel option 130
vmmaxpersnapshot option 131
vmmaxsnapshotretry 133
vmmc option 9, 134
vmprocessvmwithphysdisks option 135
vmskipphysdisks option 136
Volume Shadow Copy Service (VSS) backups
description 2
volumes
restore overview 139
restore task (Windows) 141
VSS backups
description 2
W
Windows client
disk space requirements 15
hardware requirements 15
memory requirements 15
T
target node
overview 7
Tasks pane
Data Protection for Microsoft Hyper-V Management
Console 61
time format
specifying 127
timeformat option 127
tracing
configuring 157
options 157
troubleshooting 153
U
uninstalling 27
updating
nodes 16
upgrade tasks 16
upgrading
RCT backups 18
use PowerShell cmdlets
using the GUI 55
190
79
IBM Spectrum Protect for Virtual Environments: Data Protection for Microsoft Hyper-V Installation and User's Guide
IBM®
Product Number: 5725-X00
Printed in USA