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

Last Published:
Product(s): NetBackup (8.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
  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 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)

Creating an authentication token for the NetBackup plug-in for vSphere Web Client

To allow the plug-in to restore VMs, you must generate an authentication token on the NetBackup master server (or on the NetBackup appliance as master server). When an authentication token is created on a master server and deployed on the vCenter with the plug-in, it allows that vCenter to restore any VMware backup from that master server.

To create an authentication token on the NetBackup master server

  1. Enter the following on the master server:

    Windows

    install_path\NetBackup\wmc\bin\install\manageClientCerts.bat -create clientName

    UNIX, Linux

    /usr/openv/wmc/bin/install/manageClientCerts -create clientName

    Where clientName is the DNS name of the vCenter where the plug-in is installed.

    The manageClientCerts command returns the location of a compressed file that contains the authentication token.

    Additional information is available on manageClientCerts:

    See Adding or deleting an additional host name or IP address for an authentication token.

  2. Provide the compressed file to the vCenter administrator.

    Caution:

    Be sure to share or send the compressed file in a secure manner.

    With the master server token, the plug-in can be authorized to restore virtual machines.

    See Authorizing the NetBackup plug-in for vSphere Web Client to restore virtual machines.

    See Troubleshooting master server communication failures in the plug-in's Recovery Portal.

To create an authentication token (certificate) on the NetBackup appliance as master server

  1. To generate the token, see the "Manage > Certificates" topic in the NetBackup Appliance Administrator's Guide, available from this location:

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

    See Adding or deleting an additional host name or IP address for an authentication token.

  2. Provide the compressed token file to the vCenter administrator.

    Caution:

    Be sure to share or send the compressed file in a secure manner.

    With the master server token, the plug-in can be authorized to restore virtual machines.

    See Authorizing the NetBackup plug-in for vSphere Web Client to restore virtual machines.

    See Troubleshooting master server communication failures in the plug-in's Recovery Portal.