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

Last Published:
Product(s): NetBackup (8.1.2)
  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
  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 and Instant Recovery Wizards
      1.  
        Configuring ports for the NetBackup Web Services
      2.  
        Port usage for the NetBackup vSphere Web Client Plug-in
      3.  
        Creating an authentication token for the NetBackup plug-in for vSphere Web Client
      4.  
        Authorizing the NetBackup plug-in for vSphere Web Client to restore virtual machines
      5.  
        Setting vCenter privileges for recovering virtual machines with the NetBackup plug-in for vSphere Web Client
      6.  
        Adding or deleting an additional host name or IP address for an authentication token
      7.  
        Revoking an authorization token for the NetBackup plug-in for vSphere Web Client
      8.  
        Renewing an authorization token
      9.  
        Listing all current authentication tokens for the NetBackup plug-in for vSphere Web Client
      10.  
        Permissions on the NetBackup vSphere Web Client plug-in authentication token file may need to be changed
  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 for instant recovery
      5.  
        Reviewing instant 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)

Installing the NetBackup plug-in for vSphere Web Client

This topic describes how to install the NetBackup plug-in for vSphere Web Client from either of the following:

Note: To use a custom web server instead of the NetBackup master server:

See Installing the vSphere Web Client plug-in from a NetBackup media server and plug-in package host (web server).

To install the NetBackup plug-in for vSphere Web Client from the NetBackup master server

  1. On the NetBackup master server, locate the following command:

    Windows: install_path\NetBackup\bin\goodies\vwcp_manage.exe

    UNIX, Linux: /usr/openv/netbackup/bin/goodies/vwcp_manage

  2. On the master server, start vwcp_manage to begin plug-in installation.

    Note the following:

    • vwcp_manage is a Java GUI application. Make sure that your UNIX or Linux environment supports Java GUI applications.

    • If you run the command with administrator or root privileges, the command discovers the available vCenters and presents them in a list. Otherwise, you must provide the vCenter names.

    • The vwcp_manage command detects any existing version of the vSphere Web Client plug-in and lets you either upgrade it or uninstall it.

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

    • The vwcp_manage command does not uninstall the older NetBackup plug-in for vCenter (C# plug-in). The older plug-in continues to exist separately from the new one. You can uninstall the older plug-in as explained in the NetBackup Plug-in for VMware vCenter Guide for NetBackup 8.0:

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

      Note:

      Support for the older NetBackup plug-in for vCenter has been discontinued.

  3. Registration begins with the End User License Agreement (click Accept):
  4. On the following dialog, select the vCenter server from the Hostname or IP Address pull-down list, enter its credentials, then click Validate.

    Note:

    The vCenter credentials require the Extension privileges.

    See vCenter privileges for managing NetBackup plug-in installation.

    If the vwcp_manage command was not run with administrator or root privileges, you must enter the vCenter name (or IP address) manually.

    The registration utility determines whether the plug-in is registered on the vCenter. If the plug-in is not registered, the following dialog appears and shows the plug-in URL.

    The URL field is pre-populated with the plug-in package URL as hosted on the master server.

    To use a custom web server instead of the master server, select Use alternate plug-in package location and enter the full URL for the plug-in package.

    See Installing the vSphere Web Client plug-in from a NetBackup media server and plug-in package host (web server).

  5. Click Register. A security alert appears:

    This security alert shows the identity of the web server that hosts the plug-in package. By default this web server is the NetBackup master server. The vCenter later downloads the plug-in from this server (the plug-in package host). Use this dialog to verify the identity of that server.

  6. To allow the installation to proceed, click Continue.

    The following appears:

  7. Click Close.
  8. Log on to the vSphere Web Client. If you are currently logged on, log out first.
  9. To verify that the plug-in installed correctly, go to the vSphere Web Client object navigator.

    For example, under Home > Hosts and Clusters > Monitor, look for the Veritas NetBackup tab.

    See How to access the features of the NetBackup plug-in for vSphere Web Client.

    If the Veritas NetBackup tab does not appear:

    See The NetBackup plug-in is not shown in the vSphere Web Client interface even after registration.

  10. To register the plug-in with another vCenter server, repeat this procedure starting at step 2.

    Note:

    For the vCenter servers that a VMware Platform Services Controller (PSC) manages, you only need to install the plug-in on one of the vCenter servers. The plug-in is then accessible to all the vCenters under the PSC.

To install the NetBackup plug-in for vSphere Web Client from the NetBackup appliance as master server

  1. Log on to the appliance as a NetBackupCLI user and run the vwcp_manage command to install the plug-in.

    The vwcp_manage command is located here:

    /usr/openv/netbackup/bin/goodies/vwcp_manage

    For example:

    vwcp_manage --register - v vCenter.example.com - u vCenter_username - p password_file

    Where password_file is the path to a text file that contains only the password.

    Note:

    As a NetBackupCLI user, you can create text files in your home directory only: /home/nbusers

    For more information on the vwcp_manage command, see the NetBackup Commands Reference Guide:

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

  2. Log on to the vSphere Web Client. If you are currently logged on, log out first.
  3. To verify that the plug-in installed correctly, go to the vSphere Web Client object navigator.

    For example, under Home > Hosts and Clusters > Monitor, look for the Veritas NetBackup tab.

    See How to access the features of the NetBackup plug-in for vSphere Web Client.

    If the Veritas NetBackup tab does not appear:

    See The NetBackup plug-in is not shown in the vSphere Web Client interface even after registration.

  4. To register the plug-in with another vCenter server, repeat this procedure.