Veritas NetBackup™ Plug-in for VMware vSphere Client (HTML5) Guide

Last Published:
Product(s): NetBackup (8.2)
  1. Introduction and notes
    1.  
      About the NetBackup plug-in for VMware vSphere Client (HTML5)
    2.  
      Notes on the NetBackup plug-in for vSphere Client (HTML5)
    3.  
      How to access the features of the NetBackup plug-in for vSphere Client (HTML5)
    4.  
      Updates to this guide for NetBackup 8.2
  2. Installing the NetBackup plug-in for vSphere Client (HTML5)
    1.  
      Requirements for the NetBackup plug-in for vSphere Client (HTML5)
    2.  
      Using consistent vCenter naming with the NetBackup plug-in for vSphere Client (HTML5)
    3.  
      vCenter privileges for managing NetBackup plug-in installation
    4.  
      Notes on using the vSphere Client (HTML5) plug-in in a VMware Platform Services Controller (PSC) environment
    5.  
      Installing the NetBackup plug-in for vSphere Client (HTML5)
    6.  
      Upgrading the NetBackup plug-in for vSphere Client (HTML5)
    7.  
      Uninstalling the NetBackup plug-in for vSphere Client (HTML5)
    8. 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 Client (HTML5) plug-in
      3.  
        Creating an authentication token for the NetBackup plug-in for vSphere Client (HTML5)
      4.  
        Authorizing the NetBackup vSphere Client (HTML5) plug-in to restore virtual machines
      5.  
        Configuring the plug-in for an external certificate
      6.  
        Reconfiguring the plug-in for a NetBackup CA-signed certificate
      7.  
        Setting vCenter privileges for recovering virtual machines
      8.  
        Adding or deleting an additional host name or IP address for an authentication token
      9.  
        Revoking an authorization token
      10.  
        Renewing an authorization token
      11.  
        Listing all current authentication tokens
      12.  
        Permissions on the NetBackup 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.  
      Backup monitoring displays in the NetBackup plug-in for vSphere Client (HTML5)
    3.  
      Summary display
    4.  
      Virtual Machines display
    5.  
      Events display
    6.  
      Using the Veritas NetBackup plug-in for backup reporting
    7.  
      How to respond to backup status
  5. Restoring virtual machines
    1.  
      Configuring settings for virtual machine recovery
    2.  
      Notes on the NetBackup recovery wizards
    3.  
      How to access the NetBackup Recovery Wizards
    4. NetBackup Recovery Wizard screens
      1.  
        Virtual Machine Selection screen
      2.  
        Image Selection screen
      3.  
        Destination Selection screen
      4.  
        Transport Selection screen
      5.  
        Disk Provision screen
      6.  
        Virtual Machine Options screen
      7.  
        Network Selection screen
      8.  
        Pre-Recovery Check screen
    5. NetBackup Instant Recovery Wizard screens
      1.  
        Instant Recovery: Virtual Machine Selection screen
      2.  
        Instant Recovery: Image Selection screen
      3.  
        Instant Recovery: Destination Selection
      4.  
        Instant Recovery: Virtual Machine Options screen
      5.  
        Instant Recovery: Review Selection
    6.  
      Instant Recovery: 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 Client (HTML5)
    3.  
      A NetBackup master server is not available in the master server list of the Instant Recovery Wizard
    4.  
      The NetBackup plug-in for vSphere Client (HTML5) does not find any backup images in the listed events
    5.  
      The NetBackup Recovery wizard for vSphere Client (HTML5) 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.  
      Instant recovery 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 Instant recovery 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 Client (HTML5) interface even after registration
    15.  
      The correct NetBackup master server does not show up for selection for a given vCenter server on the Instant recovery wizard
    16.  
      Troubleshooting master server communication failures in the plug-in's Recovery Portal
  7. Appendix A. Instant recovery events and best practices
    1.  
      Instant recovery events for non-available virtual machines
    2.  
      Best practices for instant recovery operations
  8. Appendix B. Installing the vSphere Client (HTML5) plug-in from a NetBackup media server and plug-in package host
    1.  
      Installing the vSphere Client (HTML5) plug-in from a NetBackup media server and plug-in package host (web server)

Installing the NetBackup plug-in for vSphere Client (HTML5)

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

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

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

To install the NetBackup plug-in 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 plug-in and lets you either upgrade it or uninstall it.

      See Uninstalling the NetBackup plug-in for vSphere Client (HTML5).

    • 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 Client (HTML5) 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 vSphere Client (HTML5). If you are currently logged on, log out first.

    The Veritas NetBackup option should appear in the left pane and in Shortcuts.

    If the Veritas NetBackup option does not appear:

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

  9. 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.

  10. If the NetBackup master server uses an external certificate, see the following topic:

    See Configuring the plug-in for an external certificate.

To install the NetBackup plug-in 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 vSphere Client (HTML5). If you are currently logged on, log out first.

    The Veritas NetBackup option should appear in the left pane and in Shortcuts.

    If the Veritas NetBackup option does not appear:

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

  3. To register the plug-in with another vCenter server, repeat this procedure.
  4. If the NetBackup appliance uses an external certificate, see the following topic:

    See Configuring the plug-in for an external certificate.