NetBackup105_AdminGuide_Hyper-V
NetBackup105_AdminGuide_Hyper-V
Administrator's Guide
Release 10.5
NetBackup™ for Hyper-V Administrator's Guide
Last updated: 2024-09-20
Legal Notice
Copyright © 2024 Veritas Technologies LLC. All rights reserved.
Veritas, the Veritas Logo, Veritas Alta, and NetBackup are trademarks or registered trademarks
of Veritas Technologies LLC or its affiliates in the U.S. and other countries. Other names may
be trademarks of their respective owners.
This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-party Programs”). Some of the Third-party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the Third-party Legal Notices document accompanying this
Veritas product or available at:
https://www.veritas.com/about/legal/license-agreements
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.
http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:
https://www.veritas.com/support
You can manage your Veritas account information at the following URL:
https://my.veritas.com
If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:
Japan [email protected]
Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:
https://sort.veritas.com/documents
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents
About Hyper-V online and offline backups for VSS ............................. 153
Conditions that determine online vs. offline backup for VSS ................. 154
Additional notes on offline backups with VSS .................................... 155
Hyper-V 2012 R2 virtual machines may be in the Off state when
restored .............................................................................. 155
■ About Hyper-V
About Hyper-V
NetBackup for Hyper-V provides snapshot-based backup of the virtual machines
that run on Hyper-V servers. For a list of supported Hyper-V servers, see the
NetBackup Software Compatibility List available from the following location:
NetBackup Compatibility List for all Versions
The principal features of NetBackup for Hyper-V are the following:
■ NetBackup for Hyper-V uses snapshot technology to keep virtual machines
100% available to users. NetBackup for Hyper-V creates quiesced Windows
snapshots using Volume Shadow Copy Service (VSS) and Windows
Management Instrumentation (WMI).
■ NetBackup for Hyper-V performs full backups and file-level incremental backups
of the virtual machine. With the WMI backup method, it also performs block-level
incremental backups and Accelerator backups.
■ Can restore the full virtual machine from the following:
■ Full backups of the VM.
Introduction 10
NetBackup for Hyper-V environment
■ Can restore individual files of the virtual machine from the following:
■ Full backups of the VM.
■ File-level incremental backups of the VM.
■ Block-level incremental backups of the VM.
■ Accelerator backups of the VM.
■ Can restore to the original virtual machine, to other locations on the Hyper-V
server, or to a different Hyper-V server.
NetBackup primary Runs the backup policies and starts backups and restores.
server
NetBackup media server Reads and writes backup data and manages NetBackup storage media. The NetBackup
media server can be installed on the Hyper-V host or on a different host.
For a more efficient backup, install the NetBackup media server on the Hyper-V host.
If the Server type on the policy Clients tab is System Center Virtual Machine Manager,
a NetBackup client must also be installed on the SCVMM server.
Note: In most cases, the client does not need to be installed on any virtual machine. For
exceptions, refer to the following topics.
See “Requirements for a NetBackup client inside the virtual machine” on page 48.
See “Prerequisites for alternate client backup of a virtual machine (VSS)” on page 46.
Hyper-V server A Windows hypervisor virtualization system, for creating the virtual machine guests that
run in a Windows Server host computer.
Hyper-V integration Provides the integration between the Hyper-V server and the virtual machines.
services (integration
Note: The Hyper-V backup integration service must be enabled.
components)
NetBackup
primary server
LAN / WAN
Term Description
avhd, avhdx file A snapshot file that Windows Hyper-V creates, for point-in-time recovery of the virtual machine.
See “Basic phases in a NetBackup backup of a Hyper-V virtual machine” on page 12.
Common vhd, vhdx Refers to a virtual disk (vhd or vhdx file) that contains the files that multiple virtual machines
files require. Instead of copies of the same file existing at multiple places, the virtual machines
share a single vhd or vhdx file (the parent).
Term Description
CSV A cluster-shared volume in a failover cluster. Refer to your Microsoft documentation for more
details regarding CSV.
Differencing disk A differencing disk is in a child relationship to the parent disk (see common vhd, vhdx files).
The parent and child virtual disks may be on the same physical drive or on different physical
drives. This mechanism enables common files to be shared across virtual machines.
HA (high availability) Describes a virtual machine that is configured in a cluster. If the virtual machine's Hyper-V
host goes down, the virtual machine automatically moves to another Hyper-V host in the
cluster. Users perceive little or no downtime on the virtual machine. Refer to your Microsoft
documentation for more details.
Pass-through disk Any disk that the Hyper-V server can access. It can be locally attached to the Hyper-V server,
or on a SAN. The pass-through disk is attached to a virtual machine, but the disk is not in
vhd or vhdx format.
vhd, vhdx file A file in a Windows Hyper-V installation that contains the virtualized contents of a hard disk.
The vhd or vhdx files can contain an entire virtual operating system and its programs. Hyper-V
supports several kinds of these files, such as fixed, dynamic, and differencing.
Virtual machine NetBackup backs up these files as part of a full virtual machine backup.
configuration files:
The bin and the vsv files are visible only when the virtual machine is running.
xml, bin, vsv, vmcx,
The vmcx files and vmrs files are for VM configuration versions later than 5 (Hyper-V 2016).
vmrs
Table 1-3 VSS backup method: Phases of NetBackup for Hyper-V backup
Phase Description
Phase 3 On Windows 2012 hosts: The VSS Hyper-V writer quiesces the Windows virtual machine (places the
data in a consistent state) and creates the snapshot on the host volume. If the Hyper-V writer cannot
quiesce the virtual machine, the virtual machine is placed in the Saved state before creation of the
snapshot.
On Windows hosts: The Hyper-V writer quiesces the Windows virtual machine and creates a .avhd or
.avhdx snapshot on the host volume.
Phase 4 On Windows 2012 hosts: If the virtual machine was placed in the Saved state, Hyper-V returns the virtual
machine to its original state.
Phase 5 The NetBackup client on the Hyper-V host reads the data from the snapshot of the virtual machine and
transfers the data to the media server. The media server writes the data to the NetBackup storage unit.
Phase 6 The NetBackup client on the Hyper-V host deletes the host volume snapshot.
Table 1-4 WMI backup method: Phases of NetBackup for Hyper-V backup
Phase Description
Phase 2 The NetBackup client on the Hyper-V host initiates a virtual machine snapshot (checkpoint).
Phase 3 On Windows 2016 or later hosts, the NetBackup client on the Hyper-V host creates a virtual machine
snapshot (checkpoint).
■ If the Hyper-V policy Consistency level option is set to Application consistent or Application
consistent then crash consistent: The VSS integration services component inside the guest OS
attempts to quiesce the virtual machine.
■ If the Hyper-V policy Consistency level option is set to Crash consistent: The virtual machine is not
quiesced.
If the backup uses block-level incremental backup (BLIB), the snapshot is converted to a reference point.
Resilient change tracking (RCT) is used to perform faster backup of the virtual machines by moving only
the blocks that have changed between backups.
As a result of the virtual machine snapshot (checkpoint), the .avhd or .avhdx files are created for the
virtual machine. All subsequent writes from the virtual machine go to these files.
Note: The Consistency level option is set on the policy's Hyper-V tab, under Advanced.
Introduction 14
NetBackup administrator tasks for Hyper-V
Table 1-4 WMI backup method: Phases of NetBackup for Hyper-V backup
(continued)
Phase Description
Phase 4 The NetBackup client reads the data directly from the virtual machine files on the Hyper-V host and
transfers the data to the media server. The media server writes the data to the storage unit.
Phase 5 The NetBackup client on the Hyper-V host deletes the virtual machine snapshot (checkpoint). As a result,
the.avhd or .avhdx files that were created during the backup are merged back into the original virtual
machine disks.
■ NetBackup character restrictions for vhd or vhdx names and the VM path when
the Enable file recovery from VM backup option is used
Note: The SAN Client feature for Hyper-V is only supported for the VSS backup
method (not for WMI).
■ The following is due to a Microsoft limitation: If the VM's virtual disk files reside
in a volume or folder that is compressed, NetBackup cannot use the WMI backup
method to create a snapshot of the VM. The snapshot job fails with status 156,
“snapshot error encountered.”
As a workaround, remove compression from the volume or folder where the
virtual disk resides and rerun the backup.
■ NetBackup for Hyper-V supports Windows NTFS file encryption and compression,
for backup and restore. However, it does not support NetBackup’s compression
or encryption options (in the NetBackup policy attributes).
For UNIX or Linux guest operating systems: NetBackup for Hyper-V does not
support any type of compression or encryption, whether they are set in
NetBackup or in the guest OS.
Note: The compressed Windows NTFS files are backed up and restored as
compressed files.
■ If a policy is changed from manual selection to Intelligent policy (or vice versa),
note: The next backup of the VM is a regular full backup, even if a backup already
exists for that VM.
Notes and prerequisites 18
NetBackup for Hyper-V notes and restrictions
For example:
■ In a new Hyper-V policy, the Select manually option on the Clients tab is
used to select a VM. The first backup from the policy runs.
■ If the primary VM identifier is a host name, ensure that you configure Microsoft
failover cluster with FQDN of VM getting protected.
■ In the policy, an Intelligent Policy query is used to select the same VM, and
the VM is backed up a second time. Because of the switch from manual
selection to query-based selection, this second backup is a regular full
backup. Note that for a policy that uses Enable block-level incremental
backup (BLIB) or BLIB plus Accelerator, the backup processing is not limited
to changed blocks only.
For the second backup, the Detailed status log includes a message similar
to the following:
■ For the WMI backup method with the Enable block-level incremental backup
option (with or without Accelerator): If the VM has multiple virtual disks that have
the same disk UUID, NetBackup performs a full backup of those disks. It does
not perform an incremental backup of them. The disks that have unique IDs
undergo an incremental backup, as expected. In the Activity Monitor, the job
details include messages such as the following:
For the policies that select virtual machines automatically: A space in a display
name is converted to "%20" in the test query results if the virtual machine is listed
as included.
Additional character restrictions for VM names can be found in the NetBackup Cloud
Administrator's Guide, available from this location:
Notes and prerequisites 21
NetBackup character restrictions for vhd or vhdx names and the VM path when the Enable file recovery from
VM backup option is used
http://www.veritas.com/docs/000003214
Note: Because VMs can automatically migrate from one cluster node to another,
it is important to allow the policy to search the entire cluster. The node where the
VM currently resides may have changed since the VM was last backed up.
To verify the privileges that are needed to discover the failover cluster
◆ Run the Failover Cluster Manager as the Failover Cluster Manager user.
Configure NetBackup communication with Hyper-V 24
Changing the NetBackup Legacy Network Service logon (vnetd.exe) to the domain user account
Note: The resource limits only apply to policies that use automatic selection of
virtual machines (Query Builder). If virtual machines are selected manually, the
Resource limit settings have no effect.
Note: To limit the number of simultaneous jobs per policy, use the Limit jobs per
policy setting on the policy Attributes tab. The effect of this option depends on
how the policy selects virtual machines.
See “Limit jobs per policy on the Attributes tab (for Hyper-V)” on page 34.
To set limits on the use of Hyper-V resources
1 Open the NetBackup web UI.
2 Click Hosts > Host properties. Select the primary server. If necessary click
Connect. Then click Edit primary server.
3 Expand Resource limits. Then click Hyper-V.
4 Click in the Resource limit column to change the limit for a resource. The
settings apply to all policies for the primary server.
For each resource type, the default is 0, No limit.
Table 3-1 describes the limits.
Configure NetBackup communication with Hyper-V 26
Setting global limits on the use of Hyper-V resources
Active VSS Controls the maximum number of active backup jobs per Hyper-V server. Applies to a
Snapshots Per standalone Hyper-V server as well as to every Hyper-V server in a cluster.
Server
The typical setting for this resource type is 2.
The NetBackup Activity Monitor shows 32 snapshot jobs. 12 snapshot jobs and their
backup jobs are active. 20 snapshot jobs are queued. As active backup jobs are
completed, queued snapshot jobs become active.
Example 2:
■ A cluster has two nodes (Node1 and Node2), each node with 32 VMs.
■ A Hyper-V Intelligent Policy discovers 64 VMs in the cluster.
■ Active Snapshots Per Server: 12.
The NetBackup Activity Monitor shows 64 snapshot jobs. 12 snapshot jobs for VMs on
Node1 are active and another 12 snapshot jobs for VMs on Node2 are active. 40 snapshot
jobs are queued. As active backup jobs are completed, queued snapshot jobs become
active.
Configure NetBackup communication with Hyper-V 27
Setting global limits on the use of Hyper-V resources
Active VSS Controls the maximum number of active backup jobs per Hyper-V cluster.
Snapshots Per
The typical setting for this resource type is 4.
Cluster
Example 1:
■ A cluster has two nodes (Node1 and Node2), each node with 32 VMs.
■ A Hyper-V Intelligent Policy discovers 60 VMs in the cluster.
■ Active Snapshots Per Cluster: 20.
■ Active Snapshots Per Server: No Limit.
The NetBackup Activity Monitor shows 60 snapshot jobs. For the VMs in the cluster, 20
snapshot jobs are active. 40 snapshot jobs are queued. As active backup jobs are
completed, queued jobs become active.
Example 2:
■ A cluster has two nodes (Node1 and Node2), each node with 32 VMs.
■ A Hyper-V Intelligent Policy discovers 60 VMs in the cluster.
■ Active Snapshots Per Cluster: 20.
■ Active Snapshots Per Server: 5.
The NetBackup Activity Monitor shows 60 snapshot jobs. 10 snapshot jobs for the VMs
in Node1 and Node2 are active. 50 snapshot jobs are queued. Even though the Active
Snapshots Per Cluster setting is higher, the Active Snapshots Per Server setting
controls the number of active jobs.
Configure NetBackup communication with Hyper-V 28
Setting global limits on the use of Hyper-V resources
Snapshot VSS Controls the maximum number of simultaneous VSS operations such as create snapshot
Operations Per and delete snapshot on a Hyper-V server or a Hyper-V server in a cluster. Applies only
Server during the snapshot creation and snapshot deletion phase of a backup. Does not control
the number of simultaneous backup jobs.
Each VM backup consists of a snapshot job and a subsequent backup job. Note:
Snapshot Operations Per Server controls VSS snapshot creation and deletion, which
are part of the snapshot job. When snapshot creation is completed, the backup job starts.
When the backup job is active, the snapshot job is still shown as active even though the
snapshot creation is completed. Therefore, this resource does not control the number of
active backup jobs. See the following examples.
Example 1:
The NetBackup Activity Monitor shows 32 snapshot jobs. 2 snapshot jobs are active and
30 snapshot jobs are queued. When the first snapshot job completes the snapshot
creation, its backup job starts and the third snapshot job becomes active. When the
second snapshot job completes snapshot creation, its backup job starts and the fourth
snapshot job becomes active. When all the snapshots are created, there are 32 active
backup jobs.
Example 2:
The NetBackup Activity Monitor shows 32 snapshot jobs. 2 snapshot jobs are active and
30 snapshot jobs are queued. When the first snapshot job completes snapshot creation,
its backup job starts and the third snapshot job becomes active. When the second
snapshot job completes snapshot creation, its backup job starts and the fourth snapshot
job becomes active. This process continues until there are 10 active snapshot jobs and
their backup jobs. When the first backup job completes, the eleventh snapshot job
becomes active, and so forth.
Configure NetBackup communication with Hyper-V 29
Setting global limits on the use of Hyper-V resources
Snapshot VSS Controls the maximum number of simultaneous VSS operations such as create snapshot
Operations Per and delete snapshot within a cluster. Applies only during the snapshot creation and
Cluster snapshot deletion phase of a backup. Does not control the number of simultaneous
backup jobs.
For example:
■ A cluster has two nodes (Node1 and Node2), each node with 32 VMs.
■ A Hyper-V Intelligent Policy discovers 60 VMs in the cluster.
■ Snapshot Operations Per Cluster: 5.
■ Active Snapshots Per Cluster: 12.
The NetBackup Activity Monitor shows 60 snapshot jobs. 5 snapshot jobs are active and
55 snapshot jobs are queued. When the first snapshot job completes snapshot creation,
the corresponding backup job starts and the sixth snapshot job becomes active. When
the second snapshot job completes snapshot creation, its backup job starts and the
seventh snapshot job becomes active, and so forth. When 12 backup jobs are active,
the thirteenth and following backup jobs are queued because Active Snapshots Per
Cluster is set to 12.
Active Backups WMI Controls the maximum number of active backup jobs per Hyper-V server. Applies to a
Per Hyper-V standalone Hyper-V server as well as to every Hyper-V server in a cluster.
Server
The typical setting for this resource type is 2.
Example 1:
The NetBackup Activity Monitor shows 32 snapshot jobs. 12 snapshot jobs and their
backup jobs are active. 20 snapshot jobs are queued. As active backup jobs are
completed, queued snapshot jobs become active.
Example 2:
■ A cluster has two nodes (Node1 and Node2), each node with 32 VMs.
■ A Hyper-V Intelligent Policy discovers 40 VMs in the cluster (10 on Node1 and 30 on
Node2).
■ Active Backups Per Hyper-V Server: 12.
The NetBackup Activity Monitor shows 40 snapshot jobs. 10 snapshot jobs for VMs on
Node1 are active and 12 snapshot jobs for VMs on Node2 are active. 18 snapshot jobs
are queued for the VMs on Node2.
Configure NetBackup communication with Hyper-V 30
Setting global limits on the use of Hyper-V resources
Active Backups WMI Controls the maximum number of active backup jobs per Hyper-V cluster.
Per Hyper-V
The typical setting for this resource type is 6.
Cluster
Example 1:
■ A cluster has two nodes (Node1 and Node2), each node with 32 VMs.
■ A Hyper-V Intelligent Policy discovers 60 VMs in the cluster.
■ Active Backups Per Hyper-V Cluster: 20.
■ Active Backups Per Hyper-V Server: No Limit.
The NetBackup Activity Monitor shows 60 snapshot jobs. 20 snapshot jobs for VMs on
the cluster are active. 40 snapshot jobs are queued. As active backup jobs are completed,
queued snapshot jobs become active.
Example 2:
■ A cluster has two nodes (Node1 and Node2), each node with 32 VMs.
■ A Hyper-V Intelligent Policy discovers 60 VMs in the cluster.
■ Active Backups Per Hyper-V Cluster: 20.
■ Active Backups Per Hyper-V Server: 5.
The NetBackup Activity Monitor shows 60 snapshot jobs. 10 snapshot jobs for VMs on
Node1 and Node2 are active. 50 snapshot jobs are queued. Even though the Active
Backups Per Hyper-V Cluster setting is higher, the Active Backups Per Hyper-V
Server setting controls the number of active jobs.
Chapter 4
Configure NetBackup
policies for Hyper-V
This chapter includes the following topics:
■ Virtual machine host names and display names should be unique if VMs are
selected manually in the policy
Note: For the VSS backup method on the Hyper-V tab, incremental backups
require that you select the Enable file recovery from VM backup option.
System Center Virtual Machine Manager An SCVMM server that manages Hyper-V
servers or clusters.
■ Click Add.
■ Under Enter the VM display name, type the name of the
virtual machine to back up. Then click Add.
Or, click Browse virtual machines, and click the
appropriate checkboxes to select the virtual machines to
back up. Then click Select.
System automatically This option sets up the rules that select virtual machines
through Hyper-V automatically. This option is required for VMs that an SCVMM
intelligent policy query server manages.
■ The Primary VM identifier option on the Hyper-V tab identifies VMs by their
host names or display names.
These policies may back up a different but identically named VM, instead of the
VM that you selected. In that case, the VM that you selected is not backed up. For
these policies to work, the virtual machines' display names or host names must be
unique.
Consider the following options:
■ For manual policies that identify VMs by display name or host name, change
the VM names so that each VM has a unique host name or display name.
■ As an alternative, configure the policies' Primary VM identifier option to identify
the VMs by their VM GUIDs instead of by host name or display name.
See “Primary VM identifier option (Hyper-V)” on page 37.
■ Instead of policies with manual-selection, use a Hyper-V Intelligent policy to
select the VMs through a query. Even if the Primary VM identifier option is set
to host name or display name, NetBackup identifies each VM by its GUID.
Backup method
Volume Shadow Copy Select this method for older Hyper-V hosts that run Windows
Service (VSS) Server versions earlier than Windows 2016. This method does
not support block-level incremental backups or Accelerator.
Configure NetBackup policies for Hyper-V 36
Backup options on the Hyper-V tab
Backup method
Windows Management This method is recommended for Hyper-V hosts that run Windows
Instrumentation (WMI) 2016 or later. It enables the faster Hyper-V backup features and
is required for block-level incremental backups or Accelerator. The
virtual machines must be at a VM configuration version later than
5.
Enable file VSS, WMI This option allows the restore of individual guest OS files from the backup, such as
recovery from VM text files and other documents. This option supports full and incremental schedules.
backup
Note: With or without this option, you can restore the entire virtual machine.
See “NetBackup character restrictions for vhd or vhdx names and the VM path when
the Enable file recovery from VM backup option is used” on page 21.
Enable WMI For block-level backups of the virtual machine. Uses Microsoft's resilient change
block-level tracking (RCT) to perform faster backup of virtual machines.
incremental
This option also reduces the size of the backup image.
backup
Note: When you select this option, Perform block-level incremental backups (on
the Attributes tab) is automatically selected by default and grayed out.
Use Accelerator
Exclude deleted WMI Reduces the size of the backup image by excluding any unused or deleted blocks
blocks within the file system on the virtual machine. This option uses proprietary mapping
technology to identify vacant sectors (allocated but empty) within the file system.
This option supports the following file systems: Windows NTFS, and Linux ext2, ext3,
and ext4. It also supports the Windows Logical Disk Manager (LDM) and the Linux
Logical Volume Manager (LVM2).
Configure NetBackup policies for Hyper-V 37
Backup options on the Hyper-V tab
Exclude swap WMI Reduces the size of the backup image by excluding the data in the guest OS system
and paging files paging file (Windows) or the swap file (Linux).
Note: This option does not exclude the swapping and paging files from the backup:
it only excludes the data in those files. If the files are restored, they are restored as
empty files.
Note: For a Linux virtual machine, this option disables the swap file when you restore
the virtual machine. You must reconfigure the swap file after the virtual machine is
restored. To allow the virtual machine to be restored with its swap file enabled, do
not select Exclude swap and paging files.
Option Description
VM hostname Specifies the network host name for the virtual machine.
Note: For VMs in a Hyper-V server or cluster, the host name is available only when the virtual
machine is running. If you select VM hostname but the virtual machine is not running at the time
of the backup, the backup may fail.
Note: On the policy Clients tab, if the Server type is System Center Virtual Machine Manager,
NetBackup can back up VMs by their host name even if they are powered off.
VM display name Specifies the name of the virtual machine as it appears in the Hyper-V Manager console.
Note: NetBackup for Hyper-V does not currently support the virtual machine display names that
contain non-US-ASCII characters. If the display name contains such characters, select VM
hostname or VM GUID.
Note: When virtual machines are included in a NetBackup policy, restrictions apply to the
characters that are allowed in the virtual machine display name.
See “NetBackup character restrictions for Hyper-V virtual machine display names” on page 20.
VM GUID Specifies the unique ID assigned to the virtual machine when the virtual machine was created.
Note: If you create a policy and then change the Primary VM identifier, you may
have to delete the virtual machine selections on the Clients tab. Otherwise,
NetBackup may no longer be able to identify the virtual machines to back up.
For example: if you change the Primary VM identifier from VM hostname to VM
display name, and the display names of the virtual machines are different from
the host names, note: The host names in the Clients tab cannot be used and the
virtual machines are not backed up. You must delete the host name entries on the
Clients tab and browse the network to select the virtual machines by their display
names.
Note: When creating virtual machines, consider using the same name for both the
host name and the display name. If the Primary VM identifier is changed, the
existing entries on the Clients tab still work.
Note: Online vs. offline backup are Microsoft backup types and are not configured
in NetBackup.
Virtual disk selection WMI See “Virtual disk selection parameter (WMI)”
on page 41.
System Uses the Microsoft system provider, for a block-level copy on write
snapshot.
Unlike the Hardware type, the System provider does not require
any specific hardware.
Hardware Uses the hardware provider for a disk array. A hardware provider
manages the VSS snapshot at the hardware level by working with
a hardware storage adapter or controller.
Note: A virtual machine that is restored from this backup cannot start. Data files
are available in the restored data disks.
Note: When the virtual machine is restored from the backup, the virtual machine
data for the data disk may be missing or incomplete.
Configure NetBackup policies for Hyper-V 42
Hyper-V - Advanced attributes
■ Application consistent
This setting is the default. I/O on the virtual machine is quiesced before
NetBackup creates the snapshot. Without quiescing file activity, data consistency
in the snapshot cannot be guaranteed. If not consistent, the backed-up data
may be of little or no value.
In the great majority of cases, you should accept the default.
Note: If the virtual machine is in the saved state or the paused state, it cannot
be quiesced and the backup job fails. You must use one of the other Consistency
level options.
■ Crash consistent
The snapshot is created without quiescing I/O on the virtual machine. In this
case, you must perform your own analysis for data consistency in the backed-up
data.
Note: When the virtual machine is restored from the backup, the virtual machine
data for the boot disk may be missing or incomplete.
■ Exclude data disks: Consider this option if you have a different policy or other
backup program that backs up the data disks. If Exclude data disks is enabled
in a policy, that policy does not back up the data disks.
Note the following about excluding data disks:
■ If the virtual machine has only one disk (such as C:), that drive is backed
up. It is not excluded.
■ If the virtual machine's boot disk is an independent disk, and the virtual
machine has a separate data disk, the boot disk is backed up. The restored
boot disk however contains no data, because NetBackup cannot back up
the data in an independent disk.
Note: When the virtual machine is restored from the backup, the virtual machine
data for the data disk may be missing or incomplete.
Caution: The exclude disk options can have unintended consequences if these
rules are not followed.
Restoring data from the backups that excluded the boot disk or data
disks
If the policy's Virtual disk selection option excluded the boot disk or data disks,
you can restore the backed-up data as follows:
■ If Enable file recovery from VM backup was enabled on the backup policy:
You can restore individual files from those portions of the virtual machine that
the Virtual disk selection option did not exclude.
■ If the Virtual disk selection option was set to Exclude boot disk: You can
restore the virtual machine and move the restored data disks to another virtual
machine.
Option Description
Enter the host name, display name, or GUID of the virtual machine. The format of the
host name or display name depends on your system. It may be the fully qualified name
or another name, depending on your network configuration and how the name is defined
in the guest OS. If NetBackup cannot find the name or GUID you enter, the policy
validation fails.
Browse virtual machines Click this option to discover Hyper-V servers or cluster nodes (shown in the left pane).
You can select virtual machines from a list (in the right pane).
The virtual machine names that are listed may be derived from a cache file. Use of the
cache file is faster than rediscovering the virtual machines on the network if your site
has a large number of virtual machines. If the virtual machine is turned off but was
turned on when the cache file was last created, its name appears in the list.
If the display name of the virtual machine was recently changed in the Hyper-V Manager,
note: The virtual machine name that was used for the backup does not change.
If NetBackup cannot obtain the IP address of the virtual machine, the IP address is
displayed as NONE.
■ The VSS snapshot provider must support transportable snapshots with the
Hyper-V writer. A transportable snapshot is one that can be imported to the
alternate client.
Check with the vendor of the VSS provider.
■ The VSS provider should be installed on both the primary client (the Hyper-V
server) and the alternate client.
■ All virtual machine files must reside on Hyper-V host volume(s) that the VSS
provider supports for transportable snapshots involving the Hyper-V writer.
■ The primary client (Hyper-V server) and alternate client must run the same
Windows operating system, volume manager, and file system. For each of these
I/O system components, the alternate client must be at the same version as the
primary client, or at a higher version.
■ The primary client and alternate client must run the same version of NetBackup.
For example, the use of a later version of NetBackup on the primary client and
an earlier version on the alternate client is not supported.
9 Select the Hyper-V tab and select Volume Shadow Copy Service (VSS).
10 Select Perform off-host backup and select Alternate client from the Use
list. Enter the name of the alternate client in the Machine field.
11 On the Hyper-V tab, review the other options.
See “Backup options on the Hyper-V tab” on page 35.
12 Select Create to validate and save the policy.
■ Query rules for virtual machine Notes that contain a newline character
Configure Hyper-V Intelligent Policies 50
About Hyper-V Intelligent Policy (automatic selection of virtual machines for backup)
■ Restoring a VM that was backed up with a Hyper-V Intelligent Policy and that
has a pass-through disk
Rule Description
Displayname Contains "vm" NetBackup selects the virtual machines that have the
characters vm anywhere in their display names.
Displayname EndsWith "vm" NetBackup selects the virtual machines that have the
characters vm at the end of their display names.
Powerstate Equal poweredOn NetBackup selects only the virtual machines that are
currently turned on.
Note! Explanation
Create rules carefully. Instead of manually selecting virtual machines for backup, you create guidelines for
automatic selection of virtual machines. The guidelines are called rules; you enter the
rules in the policy's Query Builder.
If the rules state: Back up all virtual machines with a host name that contains "prod",
NetBackup does that. Any virtual machine that is added to the environment with a host
name containing "prod" is automatically selected and backed up when the policy runs.
Virtual machines with the names that do not contain "prod" are not backed up. To have
other virtual machines automatically backed up, you must change the query rules (or
create additional policies).
Changes to the virtual If many virtual machines are temporarily added to your environment and happen to fall
environment can affect within the scope of the query rules, they are backed up. The backups can therefore
backup times. run much longer than expected.
Test the query rules. Test the query rules ahead of time. The policy includes a Test Query function for that
purpose. It's important to verify that your query operates as expected. Otherwise, the
query may select too many or too few virtual machines.
Note also: The policy's Primary VM identifier parameter can affect the automatic
selection process.
A query test does not create The automatic selection process is dynamic. Changes in the virtual environment may
the backup list. NetBackup affect which virtual machines the query rules choose when the backup runs.
creates the backup list when
Note: If virtual machine changes occur, the virtual machines that are selected for
the backup runs.
backup may not be identical to those listed in your query test results.
The policy does not display a If you select virtual machines manually (with the Browse for Virtual machines screen),
list of the virtual machines the selected virtual machines are listed on the policy Clients tab. But when you use
that are to be backed up. the Query Builder for automatic selection, the selected virtual machines are not listed
on the Clients tab.
Use the Activity monitor.
For a list of the backed up virtual machines, use the NetBackup Activity monitor.
Configure Hyper-V Intelligent Policies 53
NetBackup requirements for Hyper-V Intelligent Policy
Note! Explanation
When you save the policy, the When you save a policy, policy validation does not consult the query rules and select
query rules are not validated. virtual machines for backup. Because of the potential for changes in the virtual
environment, virtual machine selection must wait until the backup runs. As a result,
when you save the policy, NetBackup does not check the policy attributes against a
backup list. If the query rules select the virtual machines that are incompatible with a
policy attribute, policy validation cannot flag that fact. The incompatibility becomes
apparent when NetBackup determines the backup list at the time of the backup.
Set rules for virtual machine selection On the policy Clients tab, click Select automatically through Hyper-V
in the policy Query Builder Intelligent Policy query.
Choose a host for virtual machine selection (the default is the Hyper-V server).
Test the rules Click Test Query in the Query Builder on the Clients tab. Virtual machines
are labeled as included or excluded, based on the rules.
Note: The list of virtual machines is not saved in the Clients tab.
Note: The query rules are also displayed in the Backup selections tab. The
backup selections are pre-set to All_LOCAL_DRIVES (not displayed).
Run a backup When the policy runs, NetBackup consults the rules in the Query Builder,
creates a list of virtual machines, and backs them up.
Check the backup To see which virtual machines were backed up, use the Activity Monitor.
Option Description
Server type Select the type of environment in which NetBackup searches for the VMs to back up.
Server name Enter the name of the Hyper-V server or SCVMM server.
For a clustered environment, note:
■ Enter the name of the cluster (or one of the Hyper-V cluster nodes).
■ Set the NetBackup Legacy Network Service logon to the cluster user.
See “Changing the NetBackup Legacy Network Service logon (vnetd.exe) to the domain
user account” on page 23.
■ The NetBackup primary server should not be installed on any Hyper-V nodes in the cluster.
If the primary server resides on one of the nodes, you cannot log on to the NetBackup
web UI.
Select manually Click this option and click Add to manually enter virtual machines names, or to browse and
select them from a list.
Select automatically Click this option to allow NetBackup to automatically select virtual machines for backup based
through Hyper-V on the rules that you enter in the Query Builder.
Intelligent Policy
query
Option Description
Query Builder (Join, Use these fields to define rules for automatic selection of virtual machines. From left to right,
Field, Operator, each field refines the rule.
Value)
Select Add to add the rule to the Query pane.
Advanced mode Places the Query builder in Advanced mode for manual entry of rules.
Option Description
Actions > Edit Use this option to change an existing query rule when in Basic mode, as follows:
Test query Click this option to test which virtual machines NetBackup selects based on the rules in the
Query builder.
Note: This test option does not create the backup list for the policy. When the next backup
runs from this policy, NetBackup rediscovers virtual machines and consults the query rules.
At that time, NetBackup backs up the virtual machines that match the rules.
6 Select the Clients tab, and select the option Select automatically through
Hyper-V Intelligent Policy query.
If you had used the Select manually option to select virtual machines, those
virtual machines are removed from the policy.
7 Select the Server type.
This option designates the type of environment in which NetBackup searches
for the VMs to back up.
8 For Server name, enter the name of the Hyper-V server, cluster, or SCVMM
server.
Important: IPv6 addresses are not supported for Server Name. Use fully
qualified domain names (FQDN) or host names instead.
Another topic describes the requirements for SCVMM:
See “About backup of virtual machines in an SCVMM environment” on page 81.
For a clustered environment, note the following:
■ Enter the name of the cluster (or one of the Hyper-V cluster nodes) in the
Server Name field.
■ Set the NetBackup Legacy Network Service logon to the domain user
account:
See “Changing the NetBackup Legacy Network Service logon (vnetd.exe)
to the domain user account” on page 23.
■ The NetBackup primary server should not be installed on any Hyper-V
nodes in the cluster. If the primary server resides on one of the nodes, you
cannot log on to the NetBackup web UI.
9 Select the Basic mode tab. To create a rule, make selections from the Query
Builder fields.
■ For the first rule, you can start with the Field list, depending on the type of
rule. For the first rule, the only selections available for the Join field are
blank (none), or NOT.
Select a keyword for Field.
■ Select an Operator.
■ Indicate a Value.
Configure Hyper-V Intelligent Policies 58
Edit or remove a query in Basic mode
You can enter the value manually (enclose the value in single quotes or
double quotes).
As an alternative, you can click the folder icon to browse for values.
Depending on the Field keyword, you can use the Value list to select the
value.
Note that browsing with the folder icon may take some time in large
environments.
See “Query Builder field reference” on page 67.
The arrow icon resets the Join, Field, Operator, and Value fields to blank.
10 Select the Add button to add the rule to the Query pane.
11 Create more rules as needed.
See “Query Builder field reference” on page 67.
See “Examples for the NetBackup Query Builder” on page 61.
12 To see which virtual machines NetBackup currently selects based on your
query, click Test query.
The virtual machines in your current environment that match the rules for
selection in the policy are labeled Included. Note however that the Test query
option does not create the backup list for the policy. When the next backup
runs from this policy, NetBackup rediscovers virtual machines and consults
the query rules. At that time, NetBackup backs up the virtual machines that
match the query rules.
The list of virtual machines is saved but the virtual machines are not displayed
in the policy's Clients tab.
8 To insert a rule between existing rules, place the cursor where you want the
new rule to start and type it in.
When you create a rule with the fields, it appears at the end of the query. You
can cut and paste it to a different position.
9 To establish the proper order of evaluation in compound queries, use
parentheses to group rules as needed. Compound queries contain two or more
rules, joined by AND, AND NOT, OR, or OR NOT.
More information is available on the use of parentheses and on the order of
precedence.
See “AND vs. OR in queries” on page 60.
See “Order of operations in queries (precedence rules)” on page 65.
See “Parentheses in compound queries” on page 66.
the result is different: the backup list includes only the virtual machines that have
both vm1 and vm2 in their names (such as "acmevm1vm2"). A virtual machine with
the name "acmevm1" is not included in the backup.
Configure Hyper-V Intelligent Policies 61
Examples for the NetBackup Query Builder
No query rules specified (Query pane is All virtual machines are added to the backup list. Exceptions are those that
empty) do not have a host name, or that have invalid characters in the display name.
Displayname Contains "prod" All virtual machines with the display names that contain the string "prod" are
added to the backup list.
Displayname AnyOf The virtual machines named "grayfox7”and "grayfox9" are added to the
"grayfox7”,"grayfox9" backup list. Note that each value must be enclosed in its own quotes, with
a comma in between.
powerstate Equal "poweredOn" Any virtual machine that is turned on is added to the backup list.
powerstate Equal "poweredOn" Any virtual machine that is turned on and resides on Hyper-V server
HV_serv1 is added to the backup list.
AND HypervServer Equal "HV_serv1"
IsClustered Equal TRUE Any virtual machine that is in a clustered Hyper-V server is added to the
backup list.
Displayname Contains "pre-prod" Any virtual machine with a display name containing "pre-prod" and that is
not in a clustered Hyper-V server is added to the backup list.
AND IsClustered Equal FALSE
Configure Hyper-V Intelligent Policies 62
Examples for the NetBackup Query Builder
IsClustered Equal TRUE Adds to the backup list any virtual machine in a clustered Hyper-V server if
the virtual machine has "pre-prod" in its Notes field.
AND Notes Contains "pre-prod"
Displayname StartsWith "prod" Adds to the backup list any virtual machine with a display name starting with
"prod" or with Notes that contain "prod."
OR Notes Contains "prod"
ConfigurationVersion Greater "5" Adds to the backup list any virtual machine that has a VM configuration
version greater than 5.
Table 5-7 Query Builder examples for server type System Center Virtual
Machine Manager
Name StartsWith "prod" Adds to the backup list any VMs that have a display name that starts with
"prod".
Note: For VMs that reside under SCVMM, a Hyper-V Intelligent policy can
back up VMs by their host name even if they are powered off. In this example:
even if the policy's Primary VM identifier is set to VM hostname, VMs are
added to the backup list whether they are powered on or powered off.
ComputerName Contains "VM" Adds to the backup list any VMs that have a network host name that contains
"VM".
See the note in this table for the example Name StartsWith "prod".
VMHost AnyOf "hv1","hv2" Adds to the backup list any VMs that reside on Hyper-V servers "hv1" or
"hv2" if the VM has "pre-prod" in its Description field.
AND Description Contains "pre-prod"
The SCVMM Description field is similar to the VM's Notes field in Hyper-V.
Generation Equal "2" Adds to the backup list any VMs of Generation 2.
IsUndergoingLiveMigration Equal Adds to the backup list any VM that is not in live migration.
FALSE
VirtualMachineState Equal "Running" Adds to the backup list any VM that is running.
Cloud Contains "cloud9" Adds to the backup list any VM that meets the following: the VM is part of
an SCVMM cloud that contains cloud9 in its name, if the VM is in a cluster
AND HasSharedStorage Equal TRUE
that has shared storage.
Configure Hyper-V Intelligent Policies 63
The IsSet operator in queries
Table 5-7 Query Builder examples for server type System Center Virtual
Machine Manager (continued)
IsHighlyAvailable Equal TRUE Adds to the backup list any VM that resides in a CSV cluster if the VM is not
marked for fault tolerance.
AND IsFaultTolerant Equal FALSE
VMConfigurationVersion Greater "5" Adds to the backup list any virtual machine that has a VM configuration
version greater than 5.
Click Advanced to see the query rule in Advanced Mode. Only Advanced Mode
supports the use of parentheses for grouping sets of rules.
Query rules with IsSet operator Effect of the query on virtual machine selection
Displayname Contains "prod" INCLUDED: Any virtual machine with a display name that contains the string
"prod" if the virtual machine also has Notes.
AND Notes IsSet
EXCLUDED: Any virtual machines that do not have Notes.
Without Notes IsSet in this query, virtual machines without Notes cannot be
excluded.
Cluster Contains "dev" INCLUDED: Any virtual machine in a cluster that has a name that contains
the string "dev" if the virtual machine also has Notes.
AND Notes IsSet
EXCLUDED: Any virtual machines that do not have Notes, and any virtual
machines that have Notes but that are not in a cluster that has a name that
contains “dev”.
Table 5-9 Three policies that back up the virtual machines in phases
First policy Notes IsSet This policy backs up all virtual machines that have a
host name and any Notes. Any virtual machines that
Primary VM identifier
do not have a host name and do not have Notes are
parameter: VM hostname
either excluded from the backup or listed as FAILED.
Second policy NOT Notes IsSet This policy backs up all virtual machines that have a
display name, that are clustered, and that do not have
Primary VM identifier AND IsClustered Equal
any Notes. Any virtual machines that have Notes but
parameter: VM display name ‘TRUE’
are not clustered are excluded from the backup.
Third policy NOT Notes IsSet This policy backs up the virtual machines that were not
backed up by the first two policies. This policy selects
Primary VM identifier AND IsClustered NotEqual
the virtual machines that do not have any Notes and
parameter: VM GUID ‘TRUE’
are not clustered, but that do have a GUID.
More information is available on the Primary VM identifier parameter and its effect
on virtual machine selection.
See “Effect of Primary VM identifier parameter on Selection column in Test Query
results” on page 76.
Configure Hyper-V Intelligent Policies 65
Order of operations in queries (precedence rules)
x Equal y Is x equal to y 4
Note: Only the Query Builder's Advanced Mode supports the use of parentheses.
Configure Hyper-V Intelligent Policies 67
Query rules for virtual machine Notes that contain a newline character
HypervServer Equal "HV-serv1" OR All virtual machines in HV-serv1 (regardless of their power state), and any
IsClustered Equal TRUE AND virtual machines that are turned on in a clustered environment.
powerstate Equal ON
To select only the virtual machines that are turned on both in the Hyper-V
server and in clustered environments, use parentheses (see next example).
(HypervServer Equal "HV-serv1" OR All the virtual machines that are turned on in HV-serv1 and in clustered
IsClustered Equal TRUE) AND environments.
powerstate Equal ON
Server Location
Building A
Then the browsing icon returns “Server Location Building A”. The resulting query
rule is:
Since the newline character is not included in the query, the VM may not be backed
up. To include the VM in the backup, create the query manually without using the
browsing icon.
For this example, create the query: Notes Contains “Server Location” AND
Notes Contains “Building A”:
Table 5-12 Query Builder drop-down options: Join, Field, Operator, Value
For the first rule, choices are blank (none) or NOT. After you add a rule,
the available connectors are AND, AND NOT, OR, OR NOT.
Browse Allows browsing for values, depending on the selections that are made
in the other drop-down fields.
Add Adds the current drop-down selections to the Query pane as a new
rule.
Field (keywords)
The following tables describe the keywords available in the Field drop-down. The
tables also indicate whether the values for each keyword (in the Values field) are
case-sensitive.
Note that the Field keyword does not determine by itself the inclusion or exclusion
of virtual machines. Selection of virtual machines depends on the rule you construct:
the combination of Join, Field, Operator, and Value(s).
The available keywords depend on the Server Type that is selected:
■ For a description of the Hyper-V Standalone/Cluster keywords, see Table 5-13.
■ For a description of the System Center Virtual Machine Manager keywords,
see Table 5-14.
Configure Hyper-V Intelligent Policies 69
Query Builder field reference
IsClustered Boolean TRUE if the virtual machine resides in a Hyper-V server that is in a cluster.
Notes Alphanumeric A note that was recorded about the virtual machine, in the virtual machine's
string Summary tab in Hyper-V Manager.
Table 5-14 For server type System Center Virtual Machine Manager:
Keywords in the Field drop-down
Cloud Alphanumeric The name of the SCVMM cloud that the VM is a part of.
string
Values are not case-sensitive.
CloudVMRoleName Alphanumeric The name of the VM role for the SCVMM cloud.
string
Values are not case-sensitive.
Table 5-14 For server type System Center Virtual Machine Manager:
Keywords in the Field drop-down (continued)
Description Alphanumeric The VM's description in SCVMM. This field is similar to the VM's
string Notes field in Hyper-V.
See “Query rules for virtual machine Notes that contain a newline
character” on page 67.
Generation Numeric string The numeric Generation (or type) of the VM that the SCVMM
server manages.
HasVirtualFibreChannelAdapters Boolean TRUE if the VM has virtual Fibre Channel adapters. These
adapters enable Hyper-V VMs to have direct access to Fibre
Channel SAN array resources.
IsFaultTolerant Boolean TRUE if the VM is marked for fault tolerance (if it can run without
interruption in the case of a host failure).
IsHighlyAvailable Boolean TRUE if the virtual machine resides in a Hyper-V server that is
in a CSV cluster.
IsRecoveryVM Boolean TRUE if the VM is a replicated copy (of the primary VM) at a
secondary Virtual Machine Manager (VMM) site.
Configure Hyper-V Intelligent Policies 71
Query Builder field reference
Table 5-14 For server type System Center Virtual Machine Manager:
Keywords in the Field drop-down (continued)
You can exclude such VMs from the backup by creating queries
such as: IsTestReplicaVM Equal ‘FALSE’
RecoveryPointObjective Numeric The recovery point objective (RPO) value for this VM.
Tag Alphanumeric The name of the tag. A tag is a string for logical grouping of VMs
string in NetBackup.
TotalSize Numeric The total size on disk (in bytes) of all the VM's VHDs.
UserRole Alphanumeric The user role the VM is a part of, such as Administrator, Fabric
string Administrator, or Tenant Administrator.
Table 5-14 For server type System Center Virtual Machine Manager:
Keywords in the Field drop-down (continued)
VMHost Alphanumeric The name of the Hyper-V host for this VM.
string
Values are not case-sensitive.
Operators
Table 5-15 describes the operators available in the Operator drop-down.
Configure Hyper-V Intelligent Policies 73
Query Builder field reference
Operator Description
Contains Matches the value in the Value(s) field wherever that value occurs in the string.
For example: If the Value(s) entry is "dev", Contains matches strings such as "01dev",
"01dev99", "devOP", and "Development_machine".
EndsWith Matches the value in the Value(s) field when it occurs at the end of a string.
For example: If the Value(s) entry is "dev", EndsWith matches the string "01dev" but not
"01dev99", "devOP", or "Development_machine".
Equal Matches only the value that is specified in the Value(s) field.
For example: If the display name to search for is "VMtest27", Equal matches virtual machine
names such as "VMTest27" or "vmtest27" or "vmTEST27", and so forth. The name "VMtest28"
is not matched.
Greater Matches any value that is greater than the specified Value(s), according to the ASCII collating
sequence.
GreaterEqual Matches any value that is greater than or equal to the specified Value(s), according to the ASCII
collating sequence.
IsSet Determines whether a value is returned for the Field keyword. Use IsSet with another rule as a
condition, to ensure that the query selects the appropriate virtual machines.
Note that you do not make an entry under Value(s) for a rule that uses IsSet.
See “Effect of Primary VM identifier parameter on Selection column in Test Query results”
on page 76.
Less Matches any value that is less than the specified Value(s), according to the ASCII collating
sequence.
LessEqual Matches any value that is less than or equal to the specified Value(s), according to the ASCII
collating sequence.
NotEqual Matches any value that is not equal to the value in the Value(s) field.
Configure Hyper-V Intelligent Policies 74
Query Builder field reference
Operator Description
StartsWith Matches the value in the Value(s) field when it occurs at the start of a string.
For example: If the Value(s) entry is "box", StartsWith matches the string "box_car" but not
"flat_box".
Value
Table 5-16 describes the characters that can be entered in the Value field. The
Field keyword determines case sensitivity.
Note: The character string you enter in the Value field must be enclosed in single
quotes or double quotes.
For example: "*prod*" matches the string "prod" preceded or followed by any characters.
For example: "prod??" matches the string "prod" followed by any two characters.
Escape character \ (backslash) escapes the wildcard or meta-character that follows it.
For example: To search for a string that contains an asterisk (such as test*), enter "test\*"
Quotation marks Note: The characters you enter in Value(s) must be enclosed in single or double quotes.
To search for a string that contains quotation marks, either escape each quote (\") or enclose
the entire string in the opposite type of quotes.
For example: To search for a string that includes double quotes (such as "name"), enter
'"name"' (enclosing it in single quotes) or "\"name\"".
Configure Hyper-V Intelligent Policies 75
Test Query screen for Hyper-V
Field Description
Test query for Lists the rules in the Query Builder that were used in this test. The rules
policy are specified in the Query Builder on the policy Clients tab.
Test Query VM Name: Shows the display name of all discovered virtual machines.
Results Selection: Lists the virtual machines that were discovered, as follows:
Field Description
Included: The bottom of the screen gives a tally of how many virtual machines were
included, excluded, or failed in the test.
Excluded:
Failed:
Table 5-18 Effect of Primary VM identifier parameter and query rules on test
query results
VM hostname Displayname Contains INCLUDED: Any virtual machines that have a host name and
"VM" that have a display name that contains "VM".
VM display name Displayname Contains INCLUDED: Any virtual machines with the display names that
"VM" contain "VM". Since the Primary VM identifier parameter tells
NetBackup to select the virtual machine by display name, it
can back up the virtual machines.
rule specified Display name (such as Displayname Equal "vm1"), the virtual
machine appears on the Test Query screen by its host name.
The message includes the name of the VM, its virtual machine ID, and related
details.
Note: Although the VM does not start, the VM data (including the pass-through
disk) is successfully restored.
When the restored virtual machine is set to high availability, it should start
normally.
4 Right-click on the VM and click Start.
Configure Hyper-V Intelligent Policies 79
Restoring a VM that was backed up with a Hyper-V Intelligent Policy and that has a pass-through disk
Note: To restore the VMs, you can use the NetBackup Backup, Archive, and Restore
interface, or the NetBackup Add-in for SCVMM.
NetBackup primary
server
UNIX, Linux, or Windows
LAN / WAN
SCVMM
server
Hyper-V
servers
Virtual machines
VM VM VM
VM VM VM
Note: This SCVMM feature adds a new capability: For VMs that reside under
SCVMM, NetBackup can identify and back up VMs by their host name even if they
are shut down.
The following topics contain further information on NetBackup for Hyper-V with
SCVMM:
See “Creating a Hyper-V policy for automatic virtual machine selection” on page 56.
See “Examples for the NetBackup Query Builder” on page 61.
See “Query Builder field reference” on page 67.
See “Notes on NetBackup for Hyper-V with SCVMM” on page 83.
NetBackup Hyper-V for SCVMM 83
Notes on NetBackup for Hyper-V with SCVMM
■ Any VMs that do not reside on a Hyper-V server, such as VMware VMs.
Note: SCVMM can manage non-Hyper-V VMs. NetBackup for Hyper-V does
not back up these VMs. To back up VMware VMs for example, use
NetBackup for VMware.
The Test Query dialog lists these types of VMs as Excluded, with a message
that explains the reason for the exclusion. (The Test Query option is available
on the policy Clients tab.)
■ Changes that are made through Hyper-V Manager on individual Hyper-V hosts
or clusters can take up to 24 hours to be reflected in SCVMM. This delay is due
to the Microsoft SCVMM refresh cycle. In an SCVMM environment, Microsoft
recommends making VM configuration changes through SCVMM (not through
the Hyper-V Manager on individual hosts or clusters). Changes that are made
through the SCVMM Console are reflected immediately in SCVMM.
■ In an SCVMM environment, the VM GUID is referred to as the VM ID.
NetBackup Hyper-V for SCVMM 84
Creating a query to back up VMs in a localized SCVMM environment
Caution: If the SCVMM environment includes multiple VMs that have the same
VM ID, each SCVMM refresh cycle reports only one of the VMs. Any other VM
with the same VM ID is not visible. The NetBackup policy can back up only the
VM that is currently reported or visible. Any other VM that has the same VM ID
is not visible and is not backed up.
To make sure that NetBackup can discover and back up all VMs, avoid duplicate
VM IDs in the SCVMM environment.
When restoring a clustered virtual machine to its original location, note the following:
Windows Server failover cluster support 86
Notes on CSV backup and restore
To create a policy for the virtual machines that are in a CSV cluster
1 Open the NetBackup web UI.
2 On the left, click Protection > Policies.
3 Select Hyper-V as the policy type.
4 Click the Hyper-V tab and select the backup method (VSS or WMI).
5 For the VSS backup method only: Note the following options on the Hyper-V
tab:
Cluster shared Determines how many minutes the backup job waits, in case
volumes timeout another node backs up the same shared volume(s) that this
backup requires.
Note: This option is not used if the cluster is on Windows
2012.
6 On the Clients tab, enter the name of the cluster in the Hyper-V server field.
7 On the Clients tab, click Add.
Note: This procedure describes how to select virtual machines manually. For
automatic selection of virtual machines with a Hyper-V Intelligent policy, see
the following topics:
See “Creating a Hyper-V policy for automatic virtual machine selection”
on page 56.
See “Changing the NetBackup Legacy Network Service logon (vnetd.exe) to
the domain user account” on page 23.
8 You can enter the host name, display name, or GUID of the virtual machine to
back up, or click Browse virtual machines.
The cluster name and its nodes (Hyper-V servers) appear in the left pane,
under Hyper-V Manager. The virtual machines appear in the larger pane to
the right.
The Highly available column indicates whether the virtual machine is
configured as highly available in the cluster.
Windows Server failover cluster support 88
Location of the restored virtual machine in a cluster
Is the virtual Is the virtual Virtual machine is restored to this node (to non-HA
machine status HA machine status HA state):
at time of backup? at time of restore?
Restored to the node that owns the virtual machine at the time of
restore.
Windows Server failover cluster support 89
Virtual machine maintenance after a restore
Is the virtual Is the virtual Virtual machine is restored to this node (to non-HA
machine status HA machine status HA state):
at time of backup? at time of restore?
Restored to the node where the virtual machine resided at the time
of backup.
Restored to the node where the virtual machine resided at the time
of backup.
Restored to the node where the virtual machine resided at the time
of backup.
Note: In all cases, the virtual machine is restored to the non-HA state.
■ The existing virtual machine's cluster resources are removed during the
restore.
See “Removal of cluster resources during restore” on page 90.
■ The virtual machine's cluster group is not removed during restore. When two
or more virtual machines are created on the same cluster disks, the cluster
software places their resources in the same virtual machine group. Since
another virtual machine may share that group, NetBackup does not delete
the group.
Removal of the cluster group must be done manually. Refer to Microsoft
documentation for instructions.
Is the HA virtual machine These group resources are removed along with
based on a CSV volume? the existing virtual machine:
■ WMI backup method: State of the virtual machine before and after restore
■ Restore options for restore of Hyper-V individual files (NetBackup web UI)
■ Restore Options
■ The BAR interface may list Hyper-V snapshot files when you browse to restore
Hyper-V VM files
To create the policy, you can use the NetBackup web UI.
See “Creating a Hyper-V policy” on page 31.
To back up a virtual machine manually from an existing policy
1 Open the NetBackup web UI.
2 On the left, click Protection > Policies.
3 Select the policy.
4 Click Manual backup.
5 Select the type of schedule for the backup.
6 Select the clients (virtual machines) to back up.
7 Click Backup to start the backup.
8 To watch the backup progress, click Activity monitor.
Table 8-1 WMI backup method: State of the virtual machine before and
after restore
Running Off
Saved Saved
Paused Off
Off Off
machine but leave one or more of its virtual disk files on the destination server,
the virtual disk files from the backup are not restored.
■ (This item is a limitation in VSS, not in NetBackup.) Immediately after a full virtual
machine is restored, the virtual machine volume may be larger than it was when
the virtual machine was backed up. The increase is normal: After the restore,
snapshot-related cache files remain on the volume. After about 20 minutes, the
cache files are automatically removed and the volume returns to its original size
Note: A new backup of the restored virtual machine could fail if the virtual
machine volume contains insufficient space to create a snapshot for the backup.
According to Microsoft, this situation should not occur as long as the virtual
machine volume has at least 10 to 15% free space.
■ In the following case a race condition may result:
■ You attempt to do a full restore of two virtual machines at the same time.
■ The two virtual machines also share a virtual hard disk (vhd or vhdx file) that
both restore jobs have selected to restore.
The two jobs may simultaneously attempt to access the same vhd or vhdx file,
but only one job gains access to the file. The other job is denied access, and
that job may fail with error code 185.
See “NetBackup status codes related to Hyper-V” on page 136.
■ If you restore a virtual machine to a different Hyper-V server, the original Hyper-V
server and the target server must have the same number of network adapters
(NICs). You must configure the network adapter(s) for the restored virtual
machine on the target server.
See “Restored virtual machine fails to start” on page 144.
■ A restore of a virtual machine to an alternate location fails if any of its virtual
disks has an ampersand (&) in its path. As a workaround, restore the virtual
machine to its original location, or restore to a staging location and register the
virtual machine manually.
Use the following procedure to restore individual files to a host that has a NetBackup
client.
To restore individual Hyper-V files to a host that has a NetBackup client
1 Open the NetBackup web UI.
2 On the left, click Recovery > Regular recovery. Then click Start recovery.
3 Select the following.
Server to use for backups and restores Enter the NetBackup primary server that
performed the Hyper-V backup.
Source client for restores Enter the Hyper-V virtual machine that was
backed up.
Source client Enter the Hyper-V virtual machine that was backed up.
5 Click Next.
Back up and restore Hyper-V 99
Restore options for restore of Hyper-V individual files (NetBackup web UI)
6 NetBackup automatically displays the most recent backups available. Or, you
can select a date range or Use backup history.
7 Select the files to restore.
8 Click Next.
9 Select the recovery options.
Note the following:
■ Restore everything to its original location
Select this option to restore the files to their original paths or folders on the
destination client. If the original volume at the time of backup (such as E:\)
does not exist on the destination client for this restore, the restore fails.
■ Restore everything to a different location
Select this option to restore the files to a different path or folder on the
destination client. Specify the folder in the Destination field.
If the original volume at the time of backup (such as E:\) does not exist on
the destination client for this restore, the restore fails.
Use a different procedure to restore the files to a virtual machine that does
not have a NetBackup client:
See “Restoring individual Hyper-V files to a shared location on the virtual
machine” on page 100.
■ Restore individual directories and files to different locations
Select this option to restore files to particular locations. Each item you
selected to restore appears in the Source column. Double-click on an item
to enter or browse for a restore destination.
10 Click Next.
11 Review the recovery details. Then click Start recovery.
Option Description
Restore everything to Restores the folders and files to the location where they resided
its original location when the backup occurred.
Back up and restore Hyper-V 100
Restoring individual Hyper-V files to a shared location on the virtual machine
Option Description
Restore everything to Restores the folders and files with their original hierarchy, but to a
a different location different location.
If the original volume at the time of backup (such as E:\) does not
exist on the destination client for this restore, the restore fails.
Restore individual Restores the folders and files to individually designated locations.
directories and files
to different locations
Allow overwrite of If any of the files that you want to restore already exist at the restore
existing files destination, the restore overwrites the existing files.
Media server Defines the media server that has access to the storage unit that
contains the backup image. An example of such an environment
is a Media Server Deduplication Pool (MSDP) with multiple media
servers.
Note: If the storage unit that contains the backup image is not
shared with multiple media servers, this option is grayed out.
Job priority Determines the restore job's priority for restore resources. A higher
priority means that NetBackup assigns the first available drive to
the first restore job with the highest priority. Enter a number
(maximum 99999). The default for all restore jobs is 0, the lowest
priority possible. Any restore job with a priority greater than zero
has priority over the default setting.
Source client Specify the Hyper-V virtual machine that was backed up.
Destination client Select the host that has the NetBackup client. The virtual
machine to which you want to restore must have a share
for this host.
5 Click Next.
6 NetBackup automatically displays the most recent backups available. Or, you
can select a date range or Use backup history.
Back up and restore Hyper-V 102
Restoring the full Hyper-V virtual machine
NetBackup restores the files to the shared location on the virtual machine.
8 You may have to change the logon for the NetBackup Client Service.
See “Setting up NetBackup Client Service for restore to a shared location on
the virtual machine” on page 102.
You can restore the entire virtual machine to the original Hyper-V server or to a
different Hyper-V server.
For important notes on restoring the full virtual machine, see the following:
See “Notes on full virtual machine restore” on page 95.
To restore the entire Hyper-V virtual machine
1 Start the NetBackup web UI.
2 On the left, click Recovery > Regular recovery and click Start recovery.
3 On the Basic properties tab, select the following.
Source client Enter the Hyper-V virtual machine that was backed up.
4 Click Next.
5 NetBackup automatically displays the most recent backups available. Or, you
can select a date range or Use backup history.
6 Select the backup of the virtual machine that you want to restore.
Click Next.
7 Select the recovery options. See the table below for different options:
8 Hyper-V virtual machine Shows the Hyper-V hostname and GUID (Globally Unique
GUID Identifier) of the virtual machine that was backed up. Use
this value to verify that this backup represents the virtual
machine that you want to restore. The GUID is a unique
string for a virtual machine in addition to the hostname.
Restore Options
Restore to Hyper-V Restores the virtual machine to its original location on the
server original Hyper-V server.
Back up and restore Hyper-V 104
Restoring the full Hyper-V virtual machine
Restore to staging Restores the virtual machine files to the staging location on
location the server that you specify under Hyper-V server and
Restore everything to different directory. Use this option
if:
For instance, you can use this option to add restored files
as a .vhd volume to a virtual machine other than the one
from which they were backed up.
Restore Destinations
List of backed up files Lists the Hyper-V virtual machine files as they existed when
(Source) the virtual machine was backed up. By default, all listed files
are selected for restore.
Override default job Determines the restore job's priority for restore resources.
priority A higher priority means that NetBackup assigns the first
available drive to the first restore job with the highest priority.
Enter a number (maximum 99999). The default for all restore
jobs is 0, the lowest priority possible. Any restore job with
a priority greater than zero has priority over the default
setting.
Restore Options
Select from the following restore options.
Note: The available options depend on the backup method that was used to make
the backup: WMI or VSS.
Back up and restore Hyper-V 107
Restore Options
Option Description
Hyper-V virtual Shows the Hyper-V GUID (globally unique identifier) of the virtual machine that was backed up.
machine GUID Use this value to verify that this backup represents the virtual machine that you want to restore.
The GUID is a unique string for a virtual machine in addition to the host name.
Restore to original Restores the virtual machine to its original location on the original Hyper-V server.
Hyper-V server
Restore to different Restores the virtual machine to a different location on the original Hyper-V server, or restores
location on the it to a different Hyper-V server.
original or different
Hyper-V server
Restore to staging Restores the virtual machine files to the staging location on the server that you specify under
location Hyper-V server and Restore everything to different directory. Use this option if:
For instance, you can use this option to add restored files as a vhd volume or vhdx volume to
a virtual machine. The virtual machine must not be the one from which they were backed up.
Overwrite virtual If you selected Restore to Hyper-V server or Restore to different locations on same /
machine different Hyper-V server, note the following:
(If you selected ■ If a virtual machine with the same GUID exists at the destination server, that virtual machine
Restore to staging is removed with its configuration files and snapshot files. Any existing vhd or vhdx files for
location, this option the virtual machine on the destination server are overwritten. The virtual machine that you
is Overwrite selected to restore is restored from the backup.
existing files) ■ If the Overwrite virtual machine option is not selected and a virtual machine with the same
GUID exists on the destination server, the restore fails.
■ If the Overwrite virtual machine option is not selected and vhd or vhdx file(s) for the virtual
machine still exist on the destination: The vhd file(s) or vhdx file(s) from the backup are not
restored.
See “Problems with restore of the full virtual machine” on page 147.
If you selected Restore to staging location, note the following:
■ If the vhd file or vhdx file already exists on the destination server in the restore location, that
file on the destination server is overwritten.
■ If the Overwrite existing files option is not selected and any file you want to restore already
exists in the restore location, the file is not overwritten. Any other files that are selected for
restore are restored. The restore is reported as a partial success.
Back up and restore Hyper-V 108
Restore Options
Option Description
Retain original Keeps the original GUID for the restored virtual machine.
GUID
To generate a new GUID for the restored virtual machine, clear this option.
Note: This option applies only to the virtual machines on Hyper-V Server 2016 (and later) that
were backed up with the WMI method.
Note: For restore to the original location (Restore to original Hyper-V server), the Retain
Original GUID option is selected and cannot be deselected.
Note: NetBackup does not generate a new GUID if you select Restore to staging location.
Hyper-V virtual You can enter a new display name for the restored virtual machine.
machine display
Note: This option applies only to virtual machines on Hyper-V Server 2016 and later.
name
Note: This option is not available if you select Restore to staging location.
Hyper-V server If you selected Restore to Hyper-V server (to restore to the original location), note: the restore
destination is the name of the Hyper-V server from which the virtual machine was backed up.
In this case, the destination cannot be changed.
For the other restore options (restore to a different location, or restore to a staging location),
enter the destination Hyper-V server for the restore.
Back up and restore Hyper-V 109
Restore Options
Option Description
List of backed up Lists the Hyper-V virtual machine files as they existed when the virtual machine was backed
files (Source) up. By default, all listed files are selected for restore.
If you do not want the restore to replace certain files on the current virtual machine on the
destination server, deselect those files. Leave a check mark next to the files that you want to
restore. The files that are not selected are not restored. Note that the following virtual machine
configuration files are not de-selectable in restores other than staging restores:
The xml, vsv, and bin files, and avhd or avhdx files.
Caution: Replacing common files with earlier versions can be problematic for the virtual machines
that rely on the common files. If you do not want to overwrite the common files on the Hyper-V
server, deselect the common files that you do not want to restore.
Note the following about the listed files:
■ If you do not select any vhd files or vhdx files, NetBackup tries to find them in their original
location. If they are absent from the original location, the restore fails. If a parent vhd or vhdx
file was in E:\myVhds\ on the original virtual machine and is not selected during restore,
NetBackup looks for the parent file in E:\myVhds\ on the target virtual machine. If the file
does not exist, the restore fails.
■ For Restore to Hyper-V server or Restore to different locations on same / different
Hyper-V server, you can deselect any vhd files or vhdx files in this list. All other files are
pre-selected and cannot be deselected.
■ For Restore to staging location, you can deselect any files in the list.
■ Configuration files (such as xml, bin, vsv, and snapshot files) are always restored when you
restore the full virtual machine.
Restore everything This field is disabled if you selected Restore to Hyper-V server.
to different
For restore to a different location or to a staging location: Enter the path on the server or other
directory
computer that you specified under Hyper-V server or Staging machine name. NetBackup
creates the appropriate subdirectories.
View Paths Displays the directories on the destination server in which the Hyper-V files are to be restored.
You must specify a destination path in the Restore everything to different directory field.
Override default Determines the restore job's priority for restore resources. A higher priority means that NetBackup
job priority assigns the first available drive to the first restore job with the highest priority. Enter a number
(maximum 99999). The default for all restore jobs is 0, the lowest priority possible. Any restore
job with a priority greater than zero has priority over the default setting.
Back up and restore Hyper-V 110
About restoring common files
Option Description
Media Server You can use this option to select a media server that has access to the storage unit that contains
the backup image. An example of such an environment is a Media Server Deduplication Pool
(MSDP) with multiple media servers.
Note: If the storage unit that contains the backup image is not shared with multiple media
servers, this option is grayed out.
Caution: Use care when restoring common files. If you restore an earlier version
of the common files (overwriting the current version), the virtual machines that rely
on those files may experience problems.
■ To restore common files without overwriting any common files that exist on the
destination server: Specify a different location under Restore everything to
different directory.
In this case, use the following criteria (based on Hyper-V server version) to identify
the snapshot file and to decide whether to restore it:
Note: In the snapshot’s parent file (apvm.vhd in the example) and in the other VM
files, the data is complete. To restore the VM data, you should restore those files.
Note: In the snapshot’s parent file (apvm.vhd in the example) and in the other VM
files, the data is complete. To restore the VM data, you should restore those files.
■ About reporting the amount of Accelerator backup data that was transferred
over the network
made within a virtual machine. Only the changed data blocks are sent to the
NetBackup media server, to significantly reduce the I/O and backup time. The media
server combines the new data with previous backup data and produces a traditional
full NetBackup image that includes the complete virtual machine files.
Note: Accelerator is most appropriate for virtual machine data that does not
experience a high rate of change.
Note: After upgrade from any of the previous release, If the customer has configured
accelerator enabled Hyper-v policy, then optimization will be lost only for first backup.
in the checkpoint (the size of the checkpoint file). The smaller the checkpoint
file, the higher the rate of optimization in the third backup.
Similarly, if a checkpoint is deleted after the second backup, the optimization
rate in the next backup depends on the size of the virtual disk that was affected
by the checkpoint deletion.
■ Supports the disk storage units that have the following storage destinations:
■ Cloud storage. Storage that a supported cloud storage vendor provides.
■ NetBackup Media Server Deduplication Pool. In addition to NetBackup media
servers, NetBackup 5200 series appliances support Media Server
Deduplication Pool storage.
■ Qualified third-party OpenStorage devices.
To verify that your storage unit supports Accelerator, refer to the NetBackup
hardware compatibility list for the currently supported OST vendors:
NetBackup Compatibility List for all Versions
■ It is recommended that you do not enable Expire after copy retention for any
storage units that are used with storage lifecycle policies (SLP) in combination
with Accelerator. The Expire after copy retention can cause images to expire
while the backup runs. To synthesize a new full backup, the SLP backup needs
the previous backup image. If the previous image expires during the backup,
the backup fails.
■ Update the NetBackup device mapping files if needed.
The NetBackup device mapping files contain all storage device types that
NetBackup can use. To add support for the new devices or upgraded devices
that support Accelerator, download the current device mapping files from the
Veritas Technical Support website.
See the NetBackup Administrator's Guide Volume I for information on the device
mapping files and how to download them.
■ Storage unit groups are supported only if the storage unit selection in the group
is Failover.
■ Supports the full backups and incremental backups. Every Accelerator backup
(from a full schedule or incremental schedule) results in a complete image of
the virtual machine.
■ You can use incremental backups (cumulative or differential) as follows: To
reduce the file-mapping overhead and to reduce the number of files that are
recorded in the NetBackup catalog. Cumulative backups may involve more
file-mapping because they do not use the random indexing method to determine
which files have changed. In some cases, differential backups may be faster
than cumulative backups.
Use Accelerator to back up Hyper-V 118
Accelerator forced rescan for virtual machines (schedule attribute)
■ If a backup of the virtual machine does not exist, NetBackup performs a full
backup. This initial backup occurs at the speed of a normal (non-accelerated)
full backup. Subsequent Accelerator backups of the virtual machine use resilient
change tracking (RCT) to accelerate the backup.
■ If the storage unit that is associated with the policy cannot be validated when
you create the policy, note: The storage unit is validated later when the backup
job begins. If Accelerator does not support the storage unit, the backup fails. In
the bpbrm log, a message appears that is similar to one of the following:
...
When subsequent backups of the virtual machine use Accelerator, the following
messages appear in the job details log:
...
This message is a key trace for Accelerator. In this example Accelerator was
successful at reducing the backup data by 98.7%.
Windows: install_path\NetBackup\logs\bptm
Use Accelerator to back up Hyper-V 121
About reporting the amount of Accelerator backup data that was transferred over the network
Windows: install_path\NetBackup\logs\bpbkar
Windows: install_path\NetBackup\logs\bpfis
To create the log directories, run the following command on the NetBackup servers
and backup host:
On Windows:
install_path\NetBackup\logs\mklogdir.bat
On UNIX/Linux:
/usr/openv/netbackup/logs/mklogdir
bpdbjobs, Windows:
bpimagelist
install_path\NetBackup\bin\admincmd\
UNIX, Linux
/usr/openv/netbackup/bin/admincmd/
bpclimagelist Windows:
install_path\NetBackup\bin\
UNIX, Linux
/usr/openv/netbackup/bin/
The following example uses the bpimagelist command to show the results of a
backup of acmevm2:
bpimagelist -backupid acmevm2
Example output:
Note: This example output is for a VMware backup, but the output formatting is the
same for Hyper-V.
In this example, the backup image size in kilobytes is 7799632, and the amount of
data that was transferred over the network is 225792.
You can use the following commands to show the amount of data that was
transferred over the network for an Accelerator backup.
Use Accelerator to back up Hyper-V 123
About reporting the amount of Accelerator backup data that was transferred over the network
bpimagelist
bpimagelist -backupid backup_id [-l | -L | -json | -json_compact]
Brackets [ ] indicate optional elements, and the vertical bars | indicate that you can
choose only one of the options within the brackets.
Table 9-3 describes how the network-transferred data field appears in the
bpimagelist output.
"kilobytes_data_transferred": 225792,
"kilobytes_data_transferred":225792,
bpdbjobs
bpdbjobs –jobid job_id -report –most_columns
or
bpdbjobs –jobid job_id -report –all_columns
bpclimagelist
bpclimagelist -client client_name
This command can only show the network-transferred data in the field that normally
shows the Accelerator backup image size. To show the network-transferred data
with this command, you must configure a NetBackup setting:
See “Replacing the Accelerator image size with the network-transferred data in
NetBackup command output” on page 124.
Use Accelerator to back up Hyper-V 124
Replacing the Accelerator image size with the network-transferred data in NetBackup command output
Note: This example output is for a VMware backup, but the output formatting is the
same for Hyper-V.
Note: The same change occurs in the labeled output of the commands (such as
with the -L option of bpimagelist). For example, the Kilobytes field shows the
transferred data value (225792 in the example) rather than the Accelerator backup
image size.
Incremental Windows
Hyper-V
Accelerator echo REPLACE_IMAGE_SIZE_WITH_DATA_TRANSFERRED = REPLACE_IMAGE_SIZE_
backups FOR_ACCL_INC_HYPERV | install_path\NetBackup\bin\admincmd\bpsetconfig
UNIX, Linux
UNIX, Linux
Incremental Windows
Accelerator virtual
machine backups echo REPLACE_IMAGE_SIZE_WITH_DATA_TRANSFERRED = REPLACE_IMAGE_SIZE_
(VMware and FOR_ACCL_INC_VIRTUAL | install_path\NetBackup\bin\admincmd\bpsetconfig
Hyper-V)
UNIX, Linux
UNIX, Linux
echo "REPLACE_IMAGE_SIZE_WITH_DATA_TRANSFERRED =
REPLACE_IMAGE_SIZE_DISABLED" |
/usr/openv/netbackup/bin/admincmd/bpsetconfig
Chapter 10
Best practices and more
information
This chapter includes the following topics:
■ Best practices
Best practices
It is recommended the following for NetBackup for Hyper-V:
■ When creating virtual machines, use the same name for the VM's host name
and display name. If the NetBackup policy's Primary VM identifier option is
changed, the existing entries on the NetBackup policy Clients tab still work.
See “Primary VM identifier option (Hyper-V)” on page 37.
■ In a virtual desktop infrastructure where VMs share a common parent disk, do
the following when restoring a VM to its original location: Restore the VM's
differencing disk but not its parent disk. Make sure that the parent disk already
exists on the same restore path.
On the Restore Marked Files dialog, under List of backed up files, clear the
check mark from the parent disk. In the following example, the parent disk
vm1.vhdx is unselected:
Best practices and more information 129
Best practices
Note: If you restore the parent disk to the original location, the other linked VMs
that share the parent disk cannot be used. Their connection to the parent disk
is lost. Instead, restore the differencing disk without the parent disk and make
sure that the parent disk already exists on the same restore path. Otherwise,
the restore fails because the parent disk does not exist.
Note: This issue does not apply when you restore the VM to an alternate location.
As long as no other VMs at the restore location share the parent disk, you can
restore the parent disk along with the differencing disk.
Caution: For restore to the original location: If you restore the parent disk and
edit the linked VMs by reconnecting their differencing disks to the restored parent
disk, VM data may be lost.
■ When backing up the virtual machines that reside on the same CSV, Windows
warning 1584 can be ignored
■ Problem with a restart of a restored virtual machine: Why did the computer shut
down unexpectedly?
■ Unable to change virtual disk settings for a VM after restore if the VM had user
checkpoints during a backup that used the WMI method
Table 11-1 NetBackup logs that pertain to Hyper-V backup and restore
Table 11-1 NetBackup logs that pertain to Hyper-V backup and restore
(continued)
\Program Files\Common Files\Symantec Snapshot creation and VSS NetBackup client on the
Shared\VxFI\4\logs\ APIs. Hyper-V server
Note: These log folders must already exist in order for logging to occur. If these
folders do not exist, you must create them.
To create most of these log folders, run the following command on the NetBackup
servers and on the Hyper-V server:
Windows:
install_path\NetBackup\logs\mklogdir.bat
For more detail on snapshot-related logs, logging levels, and the required folders,
see the NetBackup Snapshot Manager for Data Center Administrator's Guide.
A broader discussion of NetBackup logging is available in the NetBackup
Troubleshooting Guide.
Note: VxMS logging may require significant resources on the Hyper-V server.
Note: Logging levels higher than 5 cannot be set in the Logging Assistant.
Note: Logging levels higher than 5 should be used in very unusual cases only. At
that level, the log files and metadata dumps may place significant demands on disk
space and host performance.
Level Description
0 No logging.
1 Error logging.
4 Same as level 3.
5 Highly verbose (includes level 1) + auxiliary evidence files (.mmf, .dump, VDDK
logs, .xml, .rvpmem).
You can set the logging level for the VDDK messages.
Troubleshooting 135
Errors during policy creation
Level Description
Windows VxMS-thread_id-user_name.mmddyy_tag.log
For example:
VxMS-7456-ALL_ADMINS.070214_core.log
VxMS-7456-ALL_ADMINS.070214_provider.log
For example:
VxMS-27658-root.log.081314_core
VxMS-27658-root.log.081314_provider
In either case, the NetBackup client service is not running on the current owner
(node) of the cluster. Start the NetBackup client service on the cluster node and
create the policy again.
42, network read The Windows shadow storage for the volume may have insufficient space to hold all required
failed snapshots. A larger shadow storage area may be required.
The virtual machine is either not running, or it is starting up. Make sure that the virtual
machine is running and then rerun the backup.
84, media write error Incremental backups of the VM may fail if the NTFS file system in the guest OS is corrupted
and the backup uses MSDP storage. This error may occur in the following case:
■ The VMware or Hyper-V backup policy specifies Media Server Deduplication Pool (MSDP)
storage.
■ The backup schedule includes incrementals (differential or cumulative).
■ The NTFS file system in the VM’s guest OS is corrupted. For example, the file system
contains orphaned file record segments. The bptm debug log contains messages similar
to the following:
Use the chkdsk command to examine the file system in the guest OS and repair it as
needed. Then restart the VM and rerun the backup.
156, snapshot error See “Snapshot error encountered (status code 156)” on page 139.
encountered
Troubleshooting 138
NetBackup status codes related to Hyper-V
185, tar did not find If you attempt to do a full restore of two VMs at the same time, note: If the two VMs share a
all the files to be virtual hard disk that contains a file that both restore jobs must restore, a race condition may
restored result. The two jobs may simultaneously attempt to access the same file, but only one job
gains access to the file. The other job is denied access, and that job may fail with status code
185.
After the first restore job successfully completes, retry the second job.
4207, Could not fetch For details on this status code, refer to the NetBackup Status Codes Reference Guide:
snapshot metadata or
http://www.veritas.com/docs/000003214
state files
Troubleshooting 139
NetBackup status codes related to Hyper-V
4287, A NetBackup See “Existing snapshot handling parameter (WMI)” on page 42.
snapshot of the
For additional details on this status code, refer to the NetBackup Status Codes Reference
virtual machine exists
Guide:
and the policy option
specifies aborting the http://www.veritas.com/docs/000003214
backup
The virtual A mismatch may exist between the virtual machine names that are specified on the policy Clients
machine name is tab and the actual names on the Hyper-V server. Check the actual names as listed in the Hyper-V
incorrectly Manager on the Hyper-V server.
specified in the The following are the recommended actions:
NetBackup policy.
■ In the NetBackup policy, the virtual machines must be specified as fully qualified names.
■ In the NetBackup policy, the virtual machine name may have been entered incorrectly.
Volumes on the Volumes on the virtual machine do not have enough free space for the snapshot. Microsoft
virtual machine are recommends that at least 10% of the virtual machine volume is available for the snapshot.
almost full.
Recommended action: create more space on the volume.
The Hyper-V The Hyper-V integration component is not properly installed in the virtual machine.
integration
Recommended action:
component is
absent. See “The Hyper-V integration component is not installed” on page 142.
Troubleshooting 140
NetBackup status codes related to Hyper-V
The VSS The following application error event may be written to the virtual machine during backup:
framework in the
virtual machine Event Type: Error
does not work Event Source: VSS
properly Event Category: None
Event ID: 12302
Date: 1/8/2009
Time: 1:36:21 AM
User: N/A
Computer: ARTICTALEVM8
Description:
If no writer is listed in the output and a similar error is logged, refer to the following to resolve this
issue:
http://support.microsoft.com/kb/940184
One or more or the required cluster shared volumes (CSV) cannot be prepared in the specified
timeout period. A current backup that started from another node needs one or more of the same
CSVs.
Increase the Cluster shared volumes timeout period and rerun the backup, or try the backup
at another time.
See “Cluster shared volumes timeout (Hyper-V with VSS)” on page 39.
Troubleshooting 141
Backup job hangs for multiple virtual machines
A local disk has For a successful backup of a virtual machine on a CSV, the virtual machine must use CSV
been added to a volumes only. If a local disk on the Hyper-V server (not a CSV volume) is added to the virtual
VM that is on CSV machine, the backup fails.
Reconfigure the virtual machine to use CSV volumes only, and rerun the backup.
NetBackup is not allowed to perform an offline backup of the virtual machine, because the Enable
offline backup for non-VSS VMs option is disabled.
See “Enable offline backup of non-VSS VMs (Hyper-V with VSS)” on page 38.
For the backups that are made with the System Provider Type (for a block-level
copy-on-write snapshot), note: Windows shadow storage for a volume on a Hyper-V
host must have enough space to hold all required snapshots. If too little space is
available, the backup fails with status code 42, "network read failed." In that case,
Troubleshooting 142
The Hyper-V integration component is not installed
You must restore the controller type of the .vhd disk to the controller type originally
assigned before the LDM volume was created. Then retry the backup.
Troubleshooting 143
Hyper-V snapshots (avhd or avhdx files) and status code 1
For this case, Microsoft has acknowledged that message 1584 is a false alarm. For
NetBackup backups of the virtual machines that reside on the same CSV, this
warning can be safely ignored.
■ VSS_E_PROVIDER_VETO
■ VSS_E_NO_SNAPSHOTS_IMPORTED
This string indicates that the snapshot resources are not available.
The snapshot device that the VSS hardware provider creates is not visible
to the primary client or alternate client. Check the Windows event logs and
the VSS hardware provider logs. Use the diskshadow command to rule out
any configuration issues. Refer to Microsoft documentation for assistance.
■ The restored virtual machine may fail to start if the virtual machine was not in
the Off state at the time of backup.
■ For the virtual machines that are configured in a volume GUID with a differencing
disk in another volume GUID, redirected restores are not supported. Note that
redirected restores are supported if the virtual machine's vhd or vhdx file is
configured in a drive-letter volume rather than a volume GUID.
A virtual machine restore to an alternate location may fail in the following case:
■ The virtual machine's vhd or vhdx file is in a GUID-based volume, and
■ A differencing disk for the same vhd or vhdx is in another GUID-based
volume.
In this case, the attempt to restore the virtual machine to an alternate location
fails. The cause of the failure is in the Microsoft Hyper-V Writer. The vhd or vhdx
files and other configuration files are restored to the correct location, but
registration of the virtual machine fails. As a result, Hyper-V is unable to start
the restored virtual machine. A Hyper-V writer event log similar to the following
may appear:
Troubleshooting 145
Problem with a restart of a restored virtual machine: Why did the computer shut down unexpectedly?
After the restore, you must configure a new virtual machine and attach the
restored vhd or vhdx files to the new virtual machine. The restored .xml file
contains information on the original configuration of the virtual machine.
■ When a virtual machine is restored to a different Hyper-V server: The location
of a virtual CD or DVD drive may prevent the virtual machine from restarting.
The problem occurs in the following case:
■ The original virtual machine had a CD ISO image that is attached to a virtual
CD or DVD drive.
■ On the Hyper-V server where the virtual machine was restored: The ISO
image is not on the same path as on the original Hyper-V host during backup.
For example: The virtual machine originally had E:\cd1.iso attached to its
virtual DVD drive. But E:\cd1.iso does not exist on the target Hyper-V host,
or it exists at a different location, such as F:\cd1.iso. In either case, the
restored virtual machine does not turn on.
problem ID. This message and prompt occur if the virtual machine was in the
Running state when the backup was initiated.
When a Windows system starts up, a bit is set indicating that the system did not
shut down gracefully. If the system is shut down gracefully, the bit is cleared.
However, when an online backup of a running virtual machine is performed, the
unexpected shutdown bit remains set in the backed-up image. When the restored
virtual machine is started, the bit is detected and the unexpected shutdown message
is displayed.
Files are selected from For example: The original virtual machine had two drives (C:\ and D:\), and files from each
multiple drives (volumes) drive are selected in the same restore operation. Messages similar to the following appear
on the virtual machine. in the job progress log:
Select files from a single drive at a time. Selecting files from multiple drives is not supported.
You have attempted to Restore the files by means of a shared location on the virtual machine (with a UNC path)
restore the files into a rather than by means of a mapped drive.
mapped drive on the
See “Restoring individual Hyper-V files to a shared location on the virtual machine”
virtual machine. The
on page 100.
restore fails with
NetBackup status code
185.
Troubleshooting 147
Problems with restore of the full virtual machine
The snapshot contains Windows Hyper-V provides no mechanism for quiescing file system activity on Linux virtual
invalid inodes. machines. As a result, invalid inodes may be present in the snapshot. A backup that was
made with the Enable file recovery from VM backup option may have file-mapping failures
if the virtual machine experiences heavy I/O. The failures are reported in the NetBackup
Administration Console in this form:
Note that the backup succeeds, but any files with metadata errors cannot be restored
individually.
For the backups that enable individual restore of all files, schedule the backup when the
I/O activity is lower. If metadata errors persist, shut down the virtual machine during the
backup.
The virtual machine restore job fails but the virtual machine
is nonetheless registered in the Hyper-V server.
The Hyper-V-VMMS writes the following warnings in the events log:
Event ID: 10127, sample event log message:
One or more errors occurred while restoring the virtual machine from backup.
The virtual machine might not have registered or it might not start. (Virtual
machine ID "0AD8DFCC-BDC0-4718-B6DF-7A3BA2A735BF ")
The Hyper-V writer encountered a Network configuration error. The restored virtual
machine can be started after you change the Network Adaptor configuration in the
virtual machine settings.
\\?\Volume{1a2b74b1-1b2a-11df-8c23-0023acfc9192}\
\\?\Volume{1a2b74b1-1b2a-11df-8c23-0023acfc9192}\
The virtual machine is then restored to a different volume GUID, such as:
\\?\Volume{2a3b70a1-3b1a-11df-8c23-0023acfc9192}\
If the restored virtual machine is backed up and you do a redirected restore from
the backup, the restore may fail.
To avoid this problem in a redirected restore, restore the virtual machine to a
subdirectory of the volume GUID, such as to the following:
\\?\Volume{1a3b70a1-3b1a-11df-8c23-0023acfc9192}\REDIR_subdirectory\
Note: The VM’s files are restored, but NetBackup was unable to restore the owner
of the vhd or vhdx file(s).
When these changes are complete, rerun the restore. The restore job should return
status 0, "the requested operation was successfully completed."
Troubleshooting 150
Unable to change virtual disk settings for a VM after restore if the VM had user checkpoints during a backup
that used the WMI method
Note: The default time-out period for Hyper-V disk creation is 24 hours.
Where host is the name of the NetBackup primary server where the
configuration is to be updated.
Troubleshooting 151
Linux VMs and persistent device naming
2 At the nbsetconfig prompt, enter the following to allow more time for creation
of the virtual disk.
This example sets the period to 48 hours:
HYPERV_WMI_CREATE_DISK_TIMEOUT = 48
Note: A value of 0 means the restore job never times out during virtual disk
creation.
Note: Limit the number of characters for each fstab entry to 90 on a VMware VM.
To find the device UUIDs, you can use either of the following commands:
blkid
ls -l /dev/disk/by-uuid/
Note: NetBackup also supports the by-LABEL method for persistent device naming.
Appendix A
VSS backup method:
Hyper-V online and offline
backups
This appendix includes the following topics:
■ Hyper-V 2012 R2 virtual machines may be in the Off state when restored
Online Specifies that a virtual machine that is in the Running state is briefly quiesced
for the backup. User access during the backup continues without interruption.
Offline Specifies that a virtual machine that is in the Running or Paused state is
rendered temporarily inactive. It is returned to its original state before the
backup completes. User access during the backup is interrupted.
VSS backup method: Hyper-V online and offline backups 154
Conditions that determine online vs. offline backup for VSS
The following table shows the possible combinations of virtual machine state and
the type of backup (online or offline) when you use the VSS backup method.
Table A-1 VSS backup: State of virtual machine before and after restore
Note: The WMI backup method (for Hyper-V Server 2016 and later) does not employ
online vs offline backups.
See “WMI backup method: State of the virtual machine before and after restore”
on page 92.
on the C:\ volume. The shadow copy storage for D:\ must be on D:\, and so
forth.
If these conditions are not met, the backup is performed offline. An offline backup
results in some downtime on the virtual machine. If the virtual machine is in the
Running or Paused state, it is put in a Saved state as part of the offline backup.
After the backup is completed, the virtual machine is returned to its original state.
■ The virtual machine's operating system does not support Windows Volume
Shadow Copy Service (VSS).
■ The virtual machine does not have Hyper-V integration services enabled.
During the backup, the virtual machine is not placed in the Saved state (the bin file
and vsv file are not generated or backed up). The Hyper-V VSS writer instead
creates a checkpoint of the virtual machine. As a result, the virtual machine remains
in the Off state when it is restored.
The following MSDN article contains more information:
Hyper-V Backup doesn’t interrupt running virtual machines (anymore)
Appendix B
Hyper-V pass-through
disks
This appendix includes the following topics:
The devices that NetBackup supports for pass-through are the same as for a physical
(non-hypervisor) environment: the device vendor however must support the device
in a virtual environment.
Note: The NetBackup for Hyper-V feature and Hyper-V snapshot method (as
described in other chapters of this guide) do not back up pass-through disks.
Note: The requirements for the NetBackup for Hyper-V feature do not apply to
backups of the disk arrays that are configured as pass-through disks. The NetBackup
for Hyper-V feature (using the Hyper-V snapshot method as described in other parts
of this guide) does not back up pass-through disks.
6 Click Options.
7 Select the VSS snapshot method.
The Hyper-V method does not apply.
The array may require additional OS and NetBackup configuration as described
in the NetBackup Snapshot Manager for Data Center Administrator's Guide.
8 Specify snapshot options for VSS.
Select the following:
■ Provider Type: You can select 1-system or 2-software. 3-hardware is
not supported for local backup.
See “Provider type configuration parameter (VSS)” on page 40.
See “Restrictions for Hyper-V pass-through disks” on page 159.
■ Snapshot Attribute: The selection depends on your VSS hardware provider.
For the supported snapshot methods and hardware types, see the
NetBackup Software Compatibility List available from the following location:
NetBackup Compatibility List for all Versions
■ Maximum snapshots (Instant Recovery only): This option sets the
maximum number of Instant Recovery snapshots to be retained at one
time.
For more information on this option, see the NetBackup Snapshot Manager
for Data Center Administrator's Guide.
9 In the policy Clients tab, select the virtual machine that has a pass-through
disk configured.
10 In the policy’s Backup Selections tab, specify the pass-through disk that you
want to back up. Or specify the files or volumes that reside on the pass-through
disk.
using original path names, and streams the image to the NetBackup media
server.
■ The alternate client handles the backup I/O processing; the backup has little or
no effect on the virtual machine. The media server reads the snapshot data from
the alternate client and writes the data to storage.
12 On the Clients tab, specify the virtual machine that has a pass-through disk
configured.
13 On the Backup selections tab, specify the pass-through disk that you want
to back up, or the files or volumes that reside on the pass-through disk.
■ Notes on Hyper-V policy attributes when you use the NetBackup commands
For a policy that automatically selects virtual machines through a query rule, see
the following:
See “Using NetBackup commands to create a Hyper-V Intelligent Policy” on page 165.
The NetBackup commands for policy creation are in the following directory:
Windows: install_path\Veritas\NetBackup\bin\admincmd
Note: To run virtual machine backups, a NetBackup client must be installed on the
Hyper-V server.
For example:
bppolicynew HVpolicy1
See “Notes on Hyper-V policy attributes when you use the NetBackup
commands” on page 169.
NetBackup commands to back up and restore Hyper-V virtual machines 165
Using NetBackup commands to create a Hyper-V Intelligent Policy
For the -st option, the available schedule types are FULL (full), INCR (differential
incremental), or CINC (cumulative incremental).
For example:
bpplsched policy1 -add Full -st FULL
On this command, specify one virtual machine at a time. Specify the virtual
machine's display name, host name, or GUID. You can use the Hyper-V
management console to obtain the display name or GUID.
For example:
bpplclients policy1 -add prodvm1.acme.com
Windows: install_path\Veritas\NetBackup\bin\admincmd
Note: To run virtual machine backups, a NetBackup client must be installed on the
Hyper-V server, and on the SCVMM server (if any).
For example:
bppolicynew p1_auto_select_VMs
See “Notes on Hyper-V policy attributes when you use the NetBackup
commands” on page 169.
4 Create a policy schedule.
bpplsched policy_name -add sched_label -st sched_type
For the -st option, the available schedule types are FULL (full), INCR (differential
incremental), or CINC (cumulative incremental). For example:
bpplsched p1_auto_select_VMs -add Full -st FULL
Note: To allow the policy to search all nodes of the cluster, you must set
the Netbackup Legacy Network Service logon to the domain user account.
See “Changing the NetBackup Legacy Network Service logon (vnetd.exe)
to the domain user account” on page 23.
To find the hardware type and operating system for your server, run the
following on the NetBackup primary server:
bpplclients
For further information, see the examples under bpplclients in the NetBackup
Commands Reference Guide.
6 Create a query rule to select virtual machines automatically.
bpplinclude policy_name -add
"hyperv:/;server_type=value?filter=query_rule”
The possible values for server_type=value are the following (these values
are not case-sensitive):
■ Hyperv
NetBackup discovers the VMs by communicating with the Hyper-V server
or cluster. The Hyper-V server or Hyper-V cluster must contain the
NetBackup client software.
NetBackup commands to back up and restore Hyper-V virtual machines 168
Using NetBackup commands to create a Hyper-V Intelligent Policy
■ Scvmm
NetBackup discovers the VMs by communicating with the SCVMM server.
The SCVMM server (as well as each of the Hyper-V hosts) must contain
the NetBackup client software.
For example:
This query rule selects from the virtual machines that an SCVMM server
manages. This example selects only the virtual machines with the display
names that contain the word "Production". Contains means that other
characters can also appear in the display names.
For the filter options that you can use in a Hyper-V query rule, refer to the Field
keywords in the following:
See “Query Builder field reference” on page 67.
7 Validate the policy.
bpclient -policy policy_name -validate –fi
To test the bpplinclude query rule before you run the backup
◆ Run the following on the Hyper-V server or SCVMM server that is designated
in the policy:
install_path\NetBackup\bin nbdiscover -noxmloutput “query
filter=query_rule” -noreason
A plus sign (+) appears before the virtual machines that the query rule selects
for the backup: those virtual machines are included in the backup when the
policy runs.
The virtual machines to exclude from the backup appear with a minus sign (-).
The -noreason option omits explanations as to why the query excluded a
virtual machine or why the query failed. For explanations, omit -noreason.
For more details on most of the command options, see the man page or the
NetBackup Commands Reference Guide.
-hyperv_server WMI, VSS The name of the Y Clients tab > Server type >
Hyper-V server Hyper-V standalone/cluster
-application_discovery WMI, VSS 0 disabled, 1 enabled N (only for Clients tab > Virtual machines
automatic for backup > Select
selection of VMs automatically through Hyper-V
through a query Intelligent Policy query
rule)
0 disabled, 1 enabled
alt_client_name VSS The name of the Y (with Attributes tab > Perform
alternate client use_alt_client) off-host backup > Machine
NetBackup commands to back up and restore Hyper-V virtual machines 171
The bpplinfo options for Hyper-V policies
Table C-2
Virtual_machine_ WMI, VSS 1 Disable file-level recovery Hyper-V tab > Enable
backup= file recovery from VM
2 Enable file-level recovery
backup
nameuse= WMI, VSS 0 Use VM host name to identify backup image Hyper-V tab > Primary
VM identifier
1 Use VM display name to identify backup image
allow_offline_ VSS 0 Do not allow offline backup of non-VSS virtual Hyper-V tab > Enable
backup= machines offline backup of
non-VSS VMs
1 Allow offline backup of non-VSS virtual machines
csv_timeout= VSS Determines how many minutes the backup job waits, Hyper-V tab > Cluster
in case another node in the cluster backs up the same shared volumes
shared volume at the same time. timeout
prov_type= VSS 0 Automatic selection of provider. Allows VSS to use Hyper-V tab >
the best possible provider for the snapshot. Advanced > Provider
type
1 Use system provider
exclude_swap= WMI Reduces the size of the backup image by excluding Hyper-V tab > Exclude
the data in the guest OS system paging file (Windows) swap and paging files
or the swap file (Linux).
0 Disable
1 Enable
hv_snapshot_ WMI Determines whether the VM's file system data is Hyper-V tab >
consistency_level= consistent (quiesced) before the backup starts. Advanced >
Consistency level
0 Application Consistent Then Crash Consistent
1 Application Consistent
2 Crash Consistent
The following nbrestorevm options are used in the examples in this topic:
■ –vmhv
Indicates a restore to the original location.
■ -vmhvnew
Indicates a restore to a different location (instead of –vmhv).
■ -vmhvstage
Indicates a restore to a staging or temporary location.
■ -vmncf
For a VM that uses files in common with other VMs, this option restores the VM
but does not restore the common files.
■ -C virtual_machine_to_restore
Identifies the VM to restore. The VM name must match the type of name that
was selected in the Primary VM identifier option of the backup policy. For
NetBackup commands to back up and restore Hyper-V virtual machines 174
Examples of nbrestorevm for restoring VMs to Hyper-V
example, if the VM was backed up by its VM display name, use the VM's display
name on the -C option.
■ -vmid
For restore to an alternate location, retains the original GUID for the restored
VM (prevents the creation of a new GUID).
■ -R absolute_path_to_rename_file
For restore to an alternate location, describes the path to a text file (the rename
file) that contains directives for restoring the VM's files. The rename file specifies
the original paths and the new paths for the restored VM files (xml, bin, vsv,
vhd). The rename file must specify paths for all four VM file types.
See “Hyper-V examples of restore to alternate locations” on page 176.
Further notes are available on the rename file:
See “The nbrestorevm -R rename file for Hyper-V” on page 178.
■ -vmserver Hyper-V_server
Specifies a different server as the target for the restore. The default is the
Hyper-V server that backed up the VM. To restore to the Hyper-V server that
backed up the VM, omit this option.
■ –S primary_server
Specifies the primary server that made the backup (if different from the current
primary server).
■ -O
Overwrites the VM and the associated resources if they already exist. This option
is required if the VM exists in the target location.
■ -w [hh:mm:ss]
The nbrestorevm command waits for completion of the restore before it returns
to the system prompt.
Without the -w option, nbrestorevm initiates the restore and exits. You can verify
the job completion status in the Activity Monitor of the NetBackup Administration
Console.
■ -L progress_log_file [-en]
Specifies an existing file to contain debug information about the restore. If the
server where you run nbrestorevm is configured for a non-English locale, the
-en option creates an additional log file in English.
NetBackup commands to back up and restore Hyper-V virtual machines 175
Examples of nbrestorevm for restoring VMs to Hyper-V
The -O option overwrites the existing VM. This option is required if the VM already
exists.
The file renamefile2 specifies the new display name. The following example rename
file changes the display name to vm6:
change /F/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.VMRS
to /F/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.VMRS
change /F/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.vmcx
to /F/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.vmcx
change /F/VMs/vm1/Virtual Hard Disks/vm1.vhdx
to /F/VMs/vm1/Virtual Hard Disks/vm1.vhdx
change vmname to vm6
Note: The paths in the rename file should be identical for both change and to. Only
the last directive (change vmname to vm6) specifies the new display name, where
vmname is a required literal entry, and to specifies the new name.
In the -R option rename file, enter the full path to a text file that contains the following
kinds of entries:
Make sure to include all four change entries to specify locations for the VM's files
(xml, bin, vsv, vhd). If any of the VM file paths are omitted, the restore may not
succeed.
Note: From the backups that were made with the WMI method, nbrestorevm
generates a new VM GUID by default when you restore to an alternate location.
To retain the original GUID, add the -vmid option.
Note: The -R option must specify the absolute path to the rename file. In this
example, renamefile1 contains the following directives to change the VM's file
paths at the alternate restore location:
change /F/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.VMRS
to /D/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.VMRS
change /F/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.vmcx
to /D/VMs/vm1/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.vmcx
change /F/VMs/vm1/Virtual Hard Disks/vm1.vhdx
to /D/VMs/vm1/Virtual Hard Disks/vm2.vhdx
The -vm_server option specifies the target server for the restore.
See example A or B for rename file examples.
■ The -vmhvstage option restores the virtual machine files to a staging location.
■ The -vmserver option specifies the host for the staging location.
■ The -L option specifies the name of an existing file in which to write progress
information.
■ For restore to a staging location, NetBackup does not generate a new GUID.
■ The file rfile4.tmp.chg specifies the new paths for the virtual machine files
at the staging location:
change /F/VMs/vm6/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.VMRS
to /E/VMs/vm6/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.VMRS
change /F/VMs/vm6/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.vmcx
to /E/VMs/vm6/2D7C007E-90FB-44EC-ABB2-6733D42A51F5.vmcx
change /F/VMs/vm6/Virtual Hard Disks/vm1.vhdx
to /E/VMs/vm6/Virtual Hard Disks/vm2.vhdx
Note: The -R option and rename file are not required when you restore the VM to
its original location with all its original settings.
change /original_VM_GUID.xml_path to The path to the VM's original .xml file and to the restored
/new_VM_GUID.xml_path .xml file.
change /original_VM_GUID.bin_path to The path to the VM's original .bin file and to the restored
/new_VM_GUID.bin_path .bin file.
change /original_VM_GUID.vsv_path to The path to the VM's original .vsv file and to the restored
/new_VM_GUID.vsv_path .vsv file.
change /original_VM.vhd_path to The path to the VM's original vhd file and to the restored
/new_VM.vhd_path vhd file.
23, socket The time span that is specified on the –w option is earlier than the time
read failed of the restore.
You can use -w without time values. The nbrestorevm job waits for the
restore to complete and then exits.
135, client The media server or recovery host where you are running nbrestorevm
is not is not allowed to access the NetBackup primary server.
validated to
Add the media server or recovery host to the primary server's Additional
perform the Servers list. In the NetBackup Administration Console, click Host
requested Properties > Master Servers > double-click the primary server > Servers.
operation
NetBackup commands to back up and restore Hyper-V virtual machines 180
Logs for troubleshooting the nbrestorevm command
190, found A name or value that is supplied with nbrestorevm does not match the
no images or VM's actual name or value.
media
The VM name as specified on nbrestorevm must match the type of name
matching the that was selected in the Primary VM identifier option of the backup
selection policy. For example, if the VM was backed up by its VM display name,
criteria use the VM's display name on the -C option.
Note: Spaces in the VM name must be represented as %20 on the
nbrestorevm -C option. For example, if the VM's name is acme vm1,
enter acme%20vm1 on the -C option.
Linux, UNIX
/usr/openv/netbackup/logs/bprd