Veritas NetBackup™ for VMware Administrator's Guide

Last Published:
Product(s): NetBackup (8.1.1)
  1. Introduction
    1.  
      About NetBackup for VMware
    2.  
      Updates to this guide for NetBackup 8.1.1
    3.  
      About the virtual machine backups that include database data
    4.  
      About the NetBackup appliance as a VMware backup host
    5.  
      NetBackup for VMware components
    6.  
      Appliance as backup host: component overview
    7.  
      Media servers as backup or discovery hosts
    8.  
      Overview of the VMware backup process
    9.  
      NetBackup for VMware license requirement
    10.  
      NetBackup for VMware terminology
  2. Required tasks: overview
    1.  
      Overview of VMware tasks
    2.  
      Overview of NetBackup tasks
  3. Notes and prerequisites
    1.  
      NetBackup for VMware prerequisites
    2.  
      NetBackup for VMware: notes and restrictions
    3.  
      Notes on VMware Virtual Volumes (VVols)
    4.  
      NetBackup IPv6 parameter required for backups in VMware IPv6 environments
    5.  
      NetBackup for VMware: notes on Linux virtual machines
    6.  
      Notes on the NetBackup appliance as a VMware backup host
    7.  
      NetBackup for VMware support for SAN multi-pathing
    8.  
      NetBackup for VMware support for fault tolerant VMs
    9.  
      NetBackup character restrictions for the Primary VM identifier
    10.  
      In the policy Query Builder, display names, resource pool names, and vApp names are case-sensitive
    11.  
      Notes on the hotadd transport mode
    12.  
      Notes and limitations for tag usage in VMware Intelligent Policy queries
    13.  
      Notes and limitations for the backup and restore of VMware tag associations
  4. Configure NetBackup communication with VMware
    1.  
      Adding the VMware backup host to NetBackup
    2. Adding NetBackup credentials for VMware
      1.  
        Using the VMware Managed Object Browser to verify the server name
    3.  
      Changing the host name of a VMware server in NetBackup
    4.  
      Setting privileges for posting events to vCenter
    5.  
      Authentication token for the NetBackup vSphere Web Client plug-in
    6.  
      Setting global limits on the use of VMware resources
  5. Configure NetBackup policies for VMware
    1.  
      Configuring a VMware policy from the Policy Wizard
    2.  
      Configuring a VMware policy from the Policies utility
    3.  
      Limit jobs per policy on the Attributes tab (for VMware)
    4. VMware backup options
      1.  
        VMware backup host
      2.  
        Optimizations options (VMware)
      3.  
        Primary VM identifier options (VMware)
      4.  
        Existing snapshot handling options (VMware)
      5.  
        Transport modes options (VMware)
      6.  
        Application protection options (VMware)
      7.  
        VMware - Advanced Attributes dialog
      8.  
        About the Post vCenter events option (VMware Advanced Attributes)
    5. Exclude Disks tab
      1.  
        About the exclude disk options for virtual disk selection
      2.  
        Exclude disks from backups: an example to avoid
      3.  
        Restoring data from the backups that excluded the boot disk or data disks
    6.  
      Browse for VMware virtual machines
    7.  
      Limiting the VMware servers that NetBackup searches when browsing for virtual machines
    8.  
      Virtual machine host names and display names should be unique if VMs are selected manually in the policy
    9.  
      Primary VM identifier option and manual selection of virtual machines
    10.  
      About incremental backups of virtual machines
    11.  
      Configuring incremental backups
    12.  
      Storage Foundation Volume Manager volumes in the virtual machine
  6. Configure a VMware Intelligent Policy
    1.  
      About automatic virtual machine selection for NetBackup for VMware
    2.  
      Support and use of VMware tag associations
    3.  
      The basics of a NetBackup query rule
    4.  
      Important notes on automatic virtual machine selection
    5.  
      NetBackup requirements for automatic virtual machine selection
    6.  
      Automatic virtual machine selection: Task overview
    7.  
      Options for selecting VMware virtual machines
    8.  
      Configuring automatic virtual machine selection
    9.  
      Editing an existing query in Basic Mode
    10.  
      Using the Query Builder in Advanced Mode
    11.  
      AND vs. OR in queries
    12.  
      Examples for the NetBackup Query Builder
    13.  
      The IsSet operator in queries
    14.  
      About selecting virtual machines by means of multiple policies
    15.  
      Order of operations in queries (precedence rules)
    16.  
      Parentheses in compound queries
    17.  
      Query rules for resource pools
    18.  
      Query rules for datacenter folders (host folder)
    19.  
      Query rules for duplicate names
    20.  
      Query rules for tags
    21.  
      Query Builder field reference
    22.  
      Test Query screen for VMware
    23.  
      Test Query: Failed virtual machines
    24.  
      Effect of Primary VM identifier parameter on Selection column in Test Query results
    25.  
      Effect of Primary VM identifier parameter on VM Name column in Test query results
    26.  
      Refreshing the display of virtual environment changes in the Query Builder
  7. Reduce the size of backups
    1.  
      About reducing the size of VMware backups
    2.  
      Block-level backup (BLIB): full vs incremental
    3.  
      Deleting a vSphere Client snapshot
  8. Back up virtual machines
    1.  
      Backing up virtual machines
    2.  
      Using the Activity Monitor to monitor virtual machine backups
    3.  
      Restarting jobs individually in the Activity Monitor
    4.  
      Viewing NetBackup activity in vSphere Web Client
    5.  
      Using OpsCenter to report on virtual machine backups
  9. Use Accelerator to back up virtual machines
    1.  
      About the NetBackup Accelerator for virtual machines
    2.  
      Accelerator: full vs. incremental schedules
    3.  
      How the NetBackup Accelerator works with virtual machines
    4.  
      Accelerator notes and requirements for virtual machines
    5.  
      Accelerator forced rescan for virtual machines (schedule attribute)
    6.  
      Accelerator requires the OptimizedImage attribute
    7.  
      Accelerator backups and the NetBackup catalog
    8.  
      Accelerator messages in the backup job details log
    9.  
      NetBackup logs for Accelerator with virtual machines
    10.  
      About reporting the amount of Accelerator backup data that was transferred over the network
    11.  
      Replacing the Accelerator image size with the network-transferred data in NetBackup command output
  10. Restore virtual machines
    1.  
      Restore notes and restrictions
    2.  
      Restore notes and restrictions on Linux
    3. Restoring the full VMware virtual machine
      1. Virtual Machine Recovery dialog boxes (restore to original location)
        1.  
          Recovery Destination dialog box
        2.  
          Recovery Options dialog box
        3.  
          Virtual Machine Options dialog box
        4.  
          Perform Recovery dialog box
      2. Virtual Machine Recovery dialogs boxes (restore to alternate location)
        1.  
          Recovery Destination dialog box (restore to alternate location)
        2.  
          Recovery Options dialog box (restore to alternate location)
        3.  
          Select ESX server dialog box (restore to alternate location)
        4.  
          Select Folder dialog box (restore to alternate location)
        5.  
          Select Datastore or Datastore Cluster dialog box (restore to alternate location)
        6.  
          Storage Destination dialog box (restore to alternate location)
        7.  
          Network Connections and Other Recovery Options dialog box (restore to alternate location)
        8.  
          Perform Recovery dialog box (restore to alternate location)
    4.  
      About VMware virtual machine disk restore
    5. Restoring VMware virtual machine disks by using Backup, Archive, and Restore
      1.  
        Select Virtual Disks panel
      2.  
        Recovery Destination panel
      3.  
        Virtual Disk Destination panel
      4.  
        Storage Destination panel
      5.  
        Recovery Summary panel
    6. Restoring VMware virtual machine disks by using NetBackup commands
      1.  
        Determining the backup image ID from which to restore a VMware virtual machine disk
      2.  
        Creating the VMware virtual machine disk restore file
      3.  
        Modifying the virtual machine disk restore file
      4.  
        Validating the virtual machine disk restore file
      5.  
        Restoring the virtual machine disk or disks by using the nbrestorevm command
      6.  
        VMware virtual machine disk restore file
    7.  
      About restoring individual VMware files
    8. Restoring individual VMware virtual machine files
      1.  
        Setting up NetBackup Client Service for VMware restores to a Windows shared virtual machine drive
      2.  
        Restore Marked Files dialog for restore of VMware files
    9.  
      How NetBackup handles VMware tag associations at restore
    10. Browse and search virtual machines for restore
      1.  
        Search Virtual Machines for Restore dialog
      2.  
        Browse the vCloud or vSphere view for virtual machine clients
      3.  
        Search results dialog
    11.  
      If the recovery host is not at the same NetBackup release level as the backup host
  11. Restore virtual machines with Instant Recovery
    1.  
      About Instant Recovery for VMware
    2.  
      Task overview for Instant Recovery for VMware
    3.  
      Performance recommendations for Instant Recovery for VMware
    4.  
      Requirements for Instant Recovery for VMware
    5.  
      Notes on Instant Recovery for VMware
    6.  
      Restarting the Client for NFS service on a Windows restore host
    7.  
      Instant Recovery options on the nbrestorevm command
    8.  
      Restoring a virtual machine with Instant Recovery for VMware
    9.  
      Restoring a virtual machine to a different location with Instant Recovery for VMware
    10.  
      Restoring individual files with Instant Recovery for VMware while the current virtual machine is running
    11.  
      Job types for Instant Recovery for VMware
    12.  
      Reactivating a restored virtual machine with Instant Recovery for VMware
  12. Use NetBackup for vCloud Director
    1.  
      About NetBackup for vCloud Director
    2.  
      Notes on creating a NetBackup policy for vCloud
    3.  
      Notes on restoring virtual machines into vCloud Director
    4.  
      Restoring virtual machines into vCloud Director
    5.  
      Reducing the time required for VM discovery in a large vCloud environment
    6. Virtual machine recovery dialog boxes for vCloud Director
      1.  
        Recovery Destination dialog box (vCloud Director)
      2.  
        Recovery Options dialog box (vCloud Director)
      3.  
        Recovery vApp Options for vCloud Director dialog box (restore to original location)
      4.  
        Virtual Machine Options dialog box for vCloud Director
      5.  
        Perform Recovery dialog box for vCloud Director
      6.  
        Recovery Options dialog box for vCloud Director (restore to alternate location)
      7.  
        Recovery vApp Options for vCloud Director dialog box (restore to alternate location)
      8.  
        Select a vApp dialog box
      9.  
        Recovery Destination Options for vCloud Director dialog box (restore to alternate location)
      10.  
        Virtual Machine Options (restore to alternate location)
      11.  
        Network connections (restore to alternate location)
      12.  
        Perform Recovery dialog box for vCloud Director (restore to alternate location)
  13. Best practices and more information
    1. NetBackup for VMware best practices
      1.  
        NetBackup for VMware with deduplication
    2.  
      Best practices for VMware tag usage
    3.  
      Further assistance with NetBackup for VMware
  14. Troubleshooting
    1.  
      Notes on troubleshooting NetBackup for VMware
    2.  
      Beware of unsupported backup host
    3.  
      How to determine the ESX network that NetBackup used for the backup or restore
    4.  
      NetBackup logging for VMware
    5.  
      Configuring VxMS logging
    6.  
      Format of the VxMS core.log and provider.log file names
    7.  
      Configuring the VDDK logging level
    8.  
      Preventing browsing delays caused by DNS problems
    9.  
      Changing the browsing timeout for virtual machine discovery
    10.  
      Changing timeout and logging values for vSphere
    11.  
      Credentials for VMware server are not valid
    12.  
      Snapshot error encountered (status code 156)
    13.  
      The origin of the snapshot failure: NetBackup or VMware?
    14.  
      Conflict between NetBackup and VMware Storage vMotion with vSphere 5.0 or later
    15.  
      Incremental backups of the VM may fail if the NTFS file system in the guest OS is corrupted and the backup uses MSDP storage
    16.  
      The restore fails when you restore individual files to a virtual machine that has NetBackup client software
    17.  
      Backup or restore job hangs
    18.  
      VMware SCSI requirements for application quiesce on Windows
    19.  
      Mount point missing on a restored Windows virtual machine
    20.  
      Mount points not available when restoring files from a Linux virtual machine
    21.  
      Invalid client error when you restore files using NetBackup BAR interface installed on the virtual machine
    22.  
      VMware virtual machine does not restart after restore
    23.  
      A restored VM may not start or its file system(s) may not be accessible
    24.  
      NetBackup job fails due to update tasks on the VMware server
    25.  
      The vSphere interface reports that virtual machine consolidation is needed
    26.  
      The Enable file recovery from VM backup option does not work if a volume disk set contains a mixture of disk types
    27.  
      Linux VMs and persistent device naming
    28.  
      For a VMware virtual machine with Windows dynamic disks, a restore from incremental backup fails with a Windows restore host and the hotadd transport mode
    29.  
      Simultaneous hotadd backups (from the same VMware backup host) fail with status 13
    30.  
      Troubleshooting VMware tag usage
    31.  
      Ensuring that guest customizations can be restored in vCloud Director
    32.  
      Troubleshooting vmdk restore to existing VM
  15. Appendix A. NetBackup commands to back up and restore virtual machines
    1. Using NetBackup commands to create a VMware policy
      1.  
        Notes on creating a VMware policy for vCloud Director
      2.  
        VMware policy: bpplinfo options and keywords
      3.  
        bpplinclude options for modifying query rules in a VMware policy
    2.  
      Using the nbdiscover command to search the virtual environment
    3.  
      Using the nbrestorevm command to restore virtual machines into vSphere
    4.  
      Using the nbrestorevm command to restore virtual machines into vCloud Director
    5.  
      Using the nbrestorevm command to restore virtual machine disks
    6.  
      The nbrestorevm -R rename file for restoring virtual machines
    7.  
      Logs for troubleshooting the nbrestorevm command
    8.  
      Query format and examples for searching virtual machine backups
    9.  
      Allowing other servers or clients to restore virtual machines
  16. Appendix B. Configuring services for NFS on Windows
    1.  
      About installing and configuring Network File System (NFS) for Granular Recovery Technology (GRT)
    2. About configuring services for NFS on Windows 2012 or 2016 (NetBackup for VMware)
      1.  
        Enabling Services for Network File System (NFS) on a Windows 2012 or 2016 media server (NetBackup for VMware)
      2.  
        Enabling Services for Network File System (NFS) on a Windows 2012 or 2016 restore host (NetBackup for VMware)
    3. About configuring services for NFS on Windows 2008 and 2008 R2 (NetBackup for VMware)
      1.  
        Enabling Services for Network File System (NFS) on Windows 2008 or 2008 R2 (NetBackup for VMware)
    4.  
      Disabling the Server for NFS (NetBackup for VMware)
    5.  
      Disabling the Client for NFS on the media server (NetBackup for VMware)
    6.  
      Configuring a UNIX media server and Windows backup or restore host for Granular Recovery Technology (NetBackup for VMware)
    7.  
      Configuring a different network port for NBFSD (NetBackup for VMware)
  17. Appendix C. The Reuse VM selection query results option
    1.  
      About the Reuse VM selection query results option
    2.  
      The effect of virtual machine discovery on vCenter
  18. Appendix D. Backup of VMware raw devices (RDM)
    1.  
      About VMware raw device mapping (RDM)
    2.  
      Configurations for backing up RDMs
    3.  
      About alternate client backup of RDMs
    4.  
      Requirements for alternate client backup of RDMs
    5.  
      Configuring alternate client backup of RDMs

Restore notes and restrictions

This topic is about restores from a NetBackup backup of a VMware virtual machine.

Before you begin the restore, note the following:

  • Cross-platform restore of individual files is not supported. You can restore Windows files to Windows guest operating systems but not to Linux. You can restore Linux files to supported Linux guest operating systems but not to Windows. In other words, the restore host must be the same platform as the files that you want to restore.

    See About restoring individual VMware files.

  • Unless a NetBackup client is installed on the virtual machine, you must do the restore from the NetBackup master server.

  • To restore files to the original virtual machine location, the destination must be specified as the virtual machine's host name (not display name or UUID).

  • To restore directly to an ESX server, the name that is specified for the restore must match the ESX server's official host name. The name must be in the same format in which it is registered in DNS and in the VMware server (whether short or fully-qualified).

    See Adding NetBackup credentials for VMware.

  • If the VM's display name was changed after the VM was backed up, the pre-recovery check may fail when you click Start Recovery:

    VM exists overwrite -Failed. Vmxdir for VM exists

    You can ignore the error and click Start Recovery, but note: The restore may succeed but the folder that contains the vmx file for the newly restored VM has a different name than the vmx folder of the existing VM. VMware does not rename this folder when the VM is renamed, but continues to use the existing folder.

    As an alternative, restore the VM to a different location.

  • A virtual machine template cannot be restored to a standalone ESX server. Because templates are a feature of vCenter servers, you must restore the template through vCenter. If you restore a template to a standalone ESX server, the template is converted to a normal virtual machine and is no longer a template.

  • Changes to a VM's boot settings reside in the VM's non-volatile random-access memory (the .nvram file). Note that NetBackup does not back up the .nvram file: Changes to a VM's default boot settings are not backed up. When you restore the VM, the changed boot settings are not available, and the VM may be unable to boot.

    For more details and a workaround, see the following tech note:

    How to reconfigure the BIOS in a restored VMware VM

  • If the virtual machine was backed up by its display name or UUID, and the display name differs from the host name, note: You must specify the correct destination client for the restore. Use the Specify NetBackup Machines and Policy Type dialog in the NetBackup Backup, Archive, and Restore interface.

    See Invalid client error when you restore files using NetBackup BAR interface installed on the virtual machine.

  • Restore of individual files from a backup of the full virtual machine is not supported if the virtual machine contains Storage Foundation Volume Manager volumes.

  • To restore Windows NTFS-encrypted files individually, you must install a NetBackup client on the virtual machine.

    See NetBackup for VMware best practices.

  • If the attempt to restore a full virtual machine fails while using the SAN transport type, try the NBD transport type instead.

  • Restoring a virtual machine with a transport mode of NBD or NBDSSL may be slow in the following cases:

    • The virtual machine had many small data extents due to heavy fragmentation. (A file system extent is a contiguous storage area defined by block offset and size.)

    • The restore is from a block-level incremental backup and the changed blocks on the disk were heavily fragmented when the incremental backup occurred.

    For faster restores in either of these cases, use the hotadd transport mode instead of NBD or NBDSSL.

  • VMware does not support the restore of virtual machines directly to an ESX 5.x server that vCenter manages. To restore the virtual machine, select the vCenter server as the destination.

    As an alternative, you can set up an independent ESX server to be used for restores. You must add NetBackup restore credentials for that ESX server by means of the VMware restore ESX server server type.

    See Adding NetBackup credentials for VMware.

  • For the SAN transport mode, the job may be slow when you restore to a vCenter Server. For greater speed, designate a VMware restore ESX server as the destination for the restore.

    See Adding NetBackup credentials for VMware.

  • For the SAN transport mode and a restore host on Windows 2008 R2 or later, the restore fails if the datastore's LUN is offline. The detailed status log contains messages similar to the following:

    5/22/2013 4:10:12 AM - Info tar32(pid=5832) done. status: 24: 
    socket write failed       
    5/22/2013 4:10:12 AM - Error bpbrm(pid=5792) client restore EXIT 
    STATUS 24: socket write failed     
    
    • Make sure the status of the SAN disk on the restore host is online (not offline). Disk status can be checked or changed using the Windows diskpart.exe utility or the Disk Management utility (diskmgmt.msc). When the disk status reads online, retry the restore.

    • If multipathing is enabled, make sure all the paths are online.

  • A restore by means of the SAN transport mode may be slow in other circumstances. The following Veritas article provides details:

    VMware Transport Modes: Best practices and troubleshooting

  • The APIs in VMware's Virtual Disk Development Kit (VDDK) contain the following limitation: The maximum write speed during virtual machine restore is roughly one third of the hardware's maximum speed. The following Veritas tech note contains further information:

    Two causes of slow NetBackup for VMware restore performance

    http://www.veritas.com/docs/TECH169860

  • If a virtual machine had vmdk files in different directories in the same datastore, note: When the virtual machine is restored to the original location its vmdk files are restored to a single directory, not to the original directories. (This behavior follows current VMware design.)

    As a workaround, do the following: Remove the vmdk files from the restored virtual machine, move the files to their respective directories, then re-attach the moved files to the virtual machine.

  • When restoring large files, make sure that no snapshots are active on the destination virtual machine. Otherwise, the files are restored to the VMware configuration datastore, which may be too small to contain the files you want to restore. In that case, the restore fails.

    The configuration datastore (sometimes called the vmx directory) contains the configuration files that describe the virtual machine, such as *.vmx files. Note that active snapshots of vmdk files are also stored on the configuration datastore.

  • If you cancel the virtual machine restore before it completes, the not-fully-restored virtual machine remains at the target location. NetBackup does not delete the incomplete virtual machine when the restore job is canceled. You must manually remove the incomplete virtual machine.

  • If the virtual machine display name contains unsupported characters, the backup may succeed but the restore fail. To restore the virtual machine, you must change the display name to contain supported characters only and retry the restore.

    See NetBackup character restrictions for the Primary VM identifier.

  • NetBackup for VMware does not support individual file restore by means of client-direct restore.

  • On a restore, NetBackup recreates the linking between a hard link and its original file only in this case: The link file and its target file are restored in the same job. If each file is restored individually in separate restore jobs, they are restored as separate files and the link is not re-established.

  • If you restore a VM in vCloud to an expired vApp, the vApp is automatically renewed and added back into the vCloud organization. If the expired vApp contained other VMs, all those VMs are also removed from the expired list and added to the organization.

    Note that in vCloud Director, an expired vApp must be renewed before you can import a VM into that vApp.

  • With a remote connection from a Windows Java GUI that uses the English locale, the restore of files that have non-ASCII characters may fail.

    See the following tech note for further information on how to restore the files:

    http://www.veritas.com/docs/TECH75745

  • In VMware vSphere 6.0 U1b and later, a full restore of a virtual machine may trigger an alarm if the original VM was not deleted. The alarm is a VM MAC address conflict alarm. This VMware alarm behavior is by design. If there is a MAC address conflict, VMware eventually changes the MAC address of the new VM. If you do not want to receive alarms, disable the VM MAC address conflict alarms in vCenter.

  • See NetBackup for VMware: notes and restrictions.