Veritas NetBackup™ Plug-in for VMware vSphere Web Client Guide

Last Published:
Product(s): NetBackup (8.1.1)
  1. Introduction and notes
    1.  
      About the NetBackup plug-in for VMware vSphere Web Client
    2.  
      Notes on the NetBackup plug-in for vSphere Web Client
    3.  
      How to access the features of the NetBackup plug-in for vSphere Web Client
    4.  
      Updates to this guide for NetBackup 8.1.1
  2. Installing the NetBackup plug-in for vSphere Web Client
    1.  
      Requirements for the NetBackup plug-in for vSphere Web Client
    2.  
      Using consistent vCenter naming with the NetBackup plug-in for vSphere Web Client
    3.  
      vCenter privileges for managing NetBackup plug-in installation
    4.  
      Notes on using the plug-in in a VMware Platform Services Controller (PSC) environment
    5.  
      Installing the NetBackup plug-in for vSphere Web Client
    6.  
      Upgrading the NetBackup plug-in for vSphere Web Client
    7.  
      Disabling the NetBackup plug-in for vSphere Web Client
    8.  
      Uninstalling the NetBackup plug-in for vSphere Web Client
    9. Configuration overview for the NetBackup Recovery Wizard (in the NetBackup plug-in for vSphere Web Client)
      1.  
        Creating an authentication token for the NetBackup plug-in for vSphere Web Client
      2.  
        Authorizing the NetBackup plug-in for vSphere Web Client to restore virtual machines
      3.  
        Setting vCenter privileges for recovering virtual machines with the NetBackup plug-in for vSphere Web Client
      4.  
        Adding or deleting an additional host name or IP address for an authentication token
      5.  
        Revoking an authorization token for the NetBackup plug-in for vSphere Web Client
      6.  
        Renewing an authorization token
      7.  
        Listing all current authentication tokens for the NetBackup plug-in for vSphere Web Client
      8.  
        Permissions on the NetBackup vSphere Web Client plug-in authentication token file may need to be changed
      9.  
        Port usage for the NetBackup vSphere Web Client Plug-in
  3. Excluding virtual disks from the backup
    1.  
      About excluding virtual disks from the backup
    2.  
      Setting the exclude disks Custom Attribute
  4. Monitoring backup status
    1.  
      vCenter privileges for backup monitoring
    2.  
      Veritas NetBackup tab in vSphere Web Client
    3.  
      Summary display (in the NetBackup plug-in for vSphere Web Client)
    4.  
      Virtual Machines display (in the NetBackup plug-in for vSphere Web Client)
    5.  
      Events display (in the NetBackup plug-in for vSphere Web Client)
    6.  
      Using the Veritas NetBackup tab for backup reporting (in the NetBackup plug-in for vSphere Web Client)
    7.  
      How to respond to backup status with the NetBackup plug-in for vSphere Web Client
  5. Restoring virtual machines
    1.  
      Configuring settings for the virtual machine recovery
    2.  
      Notes on the NetBackup recovery wizards in the NetBackup plug-in for vSphere Web Client
    3.  
      How to access the NetBackup Recovery Wizards in the NetBackup plug-in for vSphere Web Client
    4. NetBackup Recovery Wizard screens
      1.  
        Virtual Machine Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      2.  
        Image Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      3.  
        Destination Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      4.  
        Transport Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      5.  
        Disk Provision screen (NetBackup Recovery Wizard for vSphere Web Client)
      6.  
        Virtual Machine Options screen (NetBackup Recovery Wizard for vSphere Web Client)
      7.  
        Network Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      8.  
        Pre-Recovery Check screen (NetBackup Recovery Wizard for vSphere Web Client)
    5. NetBackup Instant Recovery Wizard screens
      1.  
        Selecting virtual machines for instant recovery
      2.  
        Selecting backup images for instant recovery
      3.  
        Selecting the destination for instant recovery
      4.  
        Setting virtual machine options
      5.  
        Reviewing recovery settings
    6.  
      Cleaning the recovery environment and releasing the NetBackup resources
  6. Troubleshooting
    1.  
      The message NoPermission appears during plug-in installation
    2.  
      Reducing the load time for the NetBackup plug-in for vSphere Web Client
    3.  
      A NetBackup master server is not available in the master server list when searching for VMs for instant recovery
    4.  
      The NetBackup plug-in for vSphere Web Client does not find any backup images in the listed events
    5.  
      The NetBackup Recovery Wizard for vSphere Web Client does not find a particular backup image
    6.  
      Mismatch in vCenter server name (uppercase vs. lowercase letters) causes the VMware connectivity test to fail
    7.  
      IR operation is not complete due to NFS mount limit exceed
    8.  
      Instant recovery-ready backup images are not available for selection
    9.  
      The vCenter server and NetBackup master server names are not available for search
    10.  
      Preferred IR-destination options are not saved
    11.  
      Virtual machine display name conflicts are not shown before the pre-recovery check
    12.  
      Reasons for failure of pre-recovery checks
    13.  
      Too much time taken to populate the list of NetBackup master servers
    14.  
      The NetBackup plug-in is not shown in the vSphere Web Client interface even after registration
    15.  
      Correct NetBackup master server does not show up for selection for a given vCenter server on the IR wizard
    16.  
      Error stack displayed in the NetBackup plug-in for vSphere Web Client
    17.  
      Troubleshooting master server communication failures in the plug-in's Recovery Portal
  7. Appendix A. Instant recovery operations
    1.  
      Instant recovery events for non-available virtual machines
    2.  
      Best practices for instant recovery operations
  8. Appendix B. Installing the vSphere Web Client plug-in from a NetBackup media server and plug-in package host
    1.  
      Installing the vSphere Web Client plug-in from a NetBackup media server and plug-in package host (web server)

Requirements for the NetBackup plug-in for vSphere Web Client

This topic describes the overall requirements for installing and using the plug-in for vSphere Web Client.

Table: NetBackup plug-in installation requirements

Requirement

Notes

NetBackup master server

The NetBackup master server must be installed before you can install the plug-in. By default, the master server operates as the plug-in package host web server. During plug-in installation, the vCenter downloads the plug-in installation file from the master server.

Note: Before using the plug-in, make sure NetBackup is configured to back up the virtual machines. The following for example are required:

  • The VMware backup host (proxy, or access host).

  • The NetBackup credentials for the vCenter server.

    Note:

    Enter the vCenter server name in the same format in which it is registered in DNS and in the vCenter server (whether short or fully-qualified).

    Note:

    Veritas recommends the use of fully qualified names. The entire name must be properly formed without empty or null elements. For example, a fully-qualified name must include the domain name and not end in a period (.).

  • A VMware policy to back up the VMs.

  • In the policy's Advanced Attributes, the Post vCenter events option must be set to All Events.

See Installing the NetBackup plug-in for vSphere Web Client.

The NetBackup for VMware Administrator's Guide explains how to configure NetBackup for VMware:

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

vCenter server credentials (user name and password)

NetBackup must have credentials for the vCenter server(s) where virtual machines are to be restored.

For information on VMware Platform Services Controller (PSC) environments:

See Notes on using the plug-in in a VMware Platform Services Controller (PSC) environment.

Note:

To install the plug-in, the Extension privileges are required on the vCenter.

See vCenter privileges for managing NetBackup plug-in installation.

Consistent vCenter naming

See Using consistent vCenter naming with the NetBackup plug-in for vSphere Web Client.

vCenter privileges for backup monitoring

To use the plug-in to monitor virtual machine backups, the vCenter Global credentials Manage custom attributes and Set custom attribute are required.

See vCenter privileges for backup monitoring.

vCenter privileges for configuring a Custom Attribute to exclude disks from backups

To use the plug-in to configure a Custom Attribute to exclude disks from backups, the vCenter Global credentials Manage custom attributes and Set custom attribute are required.

See About excluding virtual disks from the backup.

NetBackup Recovery Wizards

See Configuration overview for the NetBackup Recovery Wizard (in the NetBackup plug-in for vSphere Web Client).

For a list of NetBackup versions and VMware versions that are supported for the plug-in, see the following document: