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

Last Published:
Product(s): NetBackup (8.0)
  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.0
  2. Installing the NetBackup plug-in for vSphere Web Client
    1.  
      Requirements for the NetBackup plug-in for vSphere Web Client
    2.  
      Installation overview for the NetBackup plug-in for vSphere Web Client
    3.  
      Using consistent vCenter naming with the NetBackup plug-in for vSphere Web Client
    4.  
      Installing the NetBackup plug-in for vSphere Web Client
    5.  
      Installing the NetBackup plug-in for vSphere Web Client on an additional vSphere Web Client server
    6.  
      Registering the NetBackup plug-in for vSphere Web Client with additional vCenter servers
    7.  
      Un-registering the NetBackup plug-in for vSphere Web Client
    8.  
      Upgrading the NetBackup plug-in for vSphere Web Client
    9.  
      Disabling the NetBackup plug-in for vSphere Web Client
    10. 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.  
        Revoking an authorization token for the NetBackup plug-in for vSphere Web Client
      3.  
        Listing all current authentication tokens for the NetBackup plug-in for vSphere Web Client
      4.  
        Authorizing the NetBackup plug-in for vSphere Web Client to restore virtual machines
      5.  
        Permissions on the NetBackup vSphere Web Client plug-in authentication token file may need to be changed
      6.  
        Setting vCenter privileges for recovering virtual machines with the NetBackup plug-in for vSphere Web Client
  3. Monitoring backup status
    1.  
      Setting 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
  4. 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
  5. Troubleshooting
    1.  
      Reducing the load time for the NetBackup plug-in for vSphere Web Client
    2.  
      The NetBackup plug-in for vSphere Web Client does not find any backup images in the listed events
    3.  
      The NetBackup Recovery Wizard for vSphere Web Client does not find a particular backup image
    4.  
      Mismatch in vCenter server name (uppercase vs. lowercase letters) causes the VMware connectivity test to fail
    5.  
      IR operation is not complete due to NFS mount limit exceed
    6.  
      Instant recovery-ready backup images are not available for selection
    7.  
      vCenter server and NetBackup master server names are not available for search
    8.  
      Preferred IR-destination options are not saved
    9.  
      Virtual machine display name conflicts are not shown before the pre-recovery check
    10.  
      Reasons for failure of pre-recovery checks
    11.  
      Too much time taken to populate the list of NetBackup master servers
    12.  
      NetBackup plug-in not shown in vSphere Web Client portal even after registration
    13.  
      Correct NetBackup master server does not show up for selection for a given vCenter server on the IR wizard
    14.  
      Error stack displayed in the NetBackup plug-in for vSphere Web Client
  6. Appendix A. Instant recovery operations
    1.  
      Instant recovery events for non-available virtual machines
    2.  
      Port usage for the plug-in
    3.  
      Best practices for instant recovery operations

Installing the NetBackup plug-in for vSphere Web Client

This topic describes how to obtain the installation media and install the NetBackup plug-in for vSphere Web Client.

The following is a list of the installation requirements:

  • The plug-in installation media (NetBackup_8.0_Plugins folder). A plug-in package (netbackup-vwc-plugin.zip) is included in the installation media.

  • A Windows host on which to download the installation media.

  • A plug-in package host (web server) on which to copy the plug-in package (netbackup-vwc-plugin.zip).

    Important! The plug-in package host must be a web server.

Figure: Simplified view of plug-in installation shows the steps and components for installation.

Figure: Simplified view of plug-in installation

Simplified view of plug-in installation

Table: NetBackup plug-in download location and installation requirements describes the installation requirements in more detail.

Table: NetBackup plug-in download location and installation requirements

Requirement

Notes

NetBackup plug-in media

You can download the plug-in installation media from the following location:

https://my.veritas.com/

See the following procedure for instructions:

To install the NetBackup plug-in for vSphere Web Client

Windows host

Download the plug-in media to a Windows host.

Note:

The Windows host must have network connectivity to the vCenter server and to the vSphere Web Client server.

Note:

The Java Runtime Environment (JRE) version 1.7 update 55 or later must be installed on the Windows host.

Plug-in package host web server and its URL

The downloaded plug-in media contains a plug-in package folder. Use the procedure in this topic to copy the plug-in package to this package host, which must be a web server. The package host can be a separate web server or the vSphere Web Client server.

Note:

The URL of the plug-in package host is required during plug-in installation.

vSphere Web Client server(s)

When the plug-in is installed, it runs on the vSphere Web Client server.

Note:

If the plug-in package host is not the vSphere Web Client server, the vSphere Web Client server must have access to the package host.

Note:

The vSphere Web Client server can manage multiple vCenter servers, and multiple vSphere Web Client servers can manage the same vCenter server.

vCenter server(s) and their credentials

The plug-in monitors backups of virtual machines that VMware vCenter servers manage.

The following are required to complete the plug-in installation:

  • Host name or IP address of each vCenter server.

  • User name and password of each vCenter server.

  • Port number for each vCenter server (default is 443).

Note:

Installing the NetBackup plug-in for vSphere Web Client does not uninstall the original NetBackup plug-in for vCenter. The older plug-in continues to exist separately from the new one. You can uninstall the original plug-in as explained in the NetBackup Plug-in for VMware vCenter Guide:

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

To install the NetBackup plug-in for vSphere Web Client

  1. If you are a new Licensing Portal user, contact your company's administrator or Veritas Customer Care for assistance with obtaining a MyVeritas account.

    https://my.veritas.com/

    You can email us at:

    CustomerCare@veritas.com

  2. Log on to the MyVeritas website with your MyVeritas account.
  3. Under Licensing, use your entitlement ID to locate the NetBackup plug-in and download the NetBackup_8.0_Plugins.zip file to your Windows host.

    See the following MyVeritas guide for assistance with the Veritas Licensing Portal:

    https://www.veritas.com/support/en_US/article.000001129

  4. Unzip the file.
  5. In the unzipped plug-in folders, locate the netbackup-vwc-plugin.zip folder. Copy that folder to the plug-in package host web server.

    The vSphere Web Client server can be the plug-in package host.

  6. On the Windows host, in the downloaded plug-in folders, locate the \vwcplugin_registration\jars folder:
  7. In the \jars folder, double click the PluginUtil.jar file.

    Note:

    The Java Runtime Environment (JRE) must be installed on the Windows host.

    Double-clicking this .jar file starts the registration process on the vCenter server.

  8. Follow the prompts to register the plug-in.

    Note:

    The Windows host must have network access to the vCenter server and to the vSphere Web Client server.

    Registration begins with the End User License Agreement (click Accept):

    In the next screen, enter the vCenter server host name (or URL) and credentials, and click Validate:

    The registration utility connects to the vCenter server and determines whether the plug-in is registered. If the plug-in is not registered, the following dialog appears:

    Enter the URL of the plug-in package host and click Register. The netbackup-vwc-plugin.zip folder was copied to this host at step 5.

  9. Log on to a vSphere Web Client server that manages the vCenter server where you registered the plug-in.

    When you log on, the vSphere Web Client server asks vCenter for a list of the registered plug-ins. The vSphere Web Client server also determines whether it has the plug-in binaries.

    • If the vSphere Web Client server has the plug-in binaries, it automatically installs the plug-in and the logon process continues.

    • If the vSphere Web Client server does not have the plug-in binaries, it asks the vCenter for the location of the plug-in package. The vSphere Web Client server automatically downloads the plug-in package from the package host, unzips the package, and installs it.

    Then the vSphere Web Client server displays the following:

  10. To register the plug-in with another vCenter, repeat steps 8 and 9.

    Note:

    The vSphere Web Client server where the plug-in is installed can manage multiple vCenter servers. The plug-in must be registered with each vCenter server that you want to monitor with the plug-in.

See Installation overview for the NetBackup plug-in for vSphere Web Client.