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

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  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 9.0
  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)
      1.  
        VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers and clients
    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
    17.  
      The NetBackup plug-in is not shown in the vSphere Client (HTML5) interface after vCenter upgrade from older versions to vCenter 7.0 or later
  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)

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

This issue may occur for any of the following reasons:

Table: Reasons for the NetBackup plug-in not appearing in the vSphere Client

Reason

Description and recommended action

The NetBackup plug-in does not support the vCenter version.

Messages similar to the following may appear in the vsphere_client_virgo .log file:

javax.net.ssl.SSLHandshakeException: Received fatal alert: 
handshake_failure

For a list of supported vCenter versions for the plug-in, see the following document:

Support for NetBackup 7.x and 8.x in virtual environments:

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

You have not used the default URL for the plug-in ZIP-file download (securely hosted by the NetBackup master server).

Instead, your plug-in download URL uses the HTTP protocol (http://) rather than the secure HTTPS protocol (https://).

In this case, the default vCenter configuration does not allow the plug-in to be downloaded and deployed. Messages similar to the following may appear in the VMware vsphere_client_virgo.log file:

The plugin package download was blocked because the URL 
is not secure. To allow http URLs add allowHttp=true to 
webclient.properties

See the procedure To allow installation of the plug-in over an HTTP URL.

A previous instance of the NetBackup plug-in did not properly clean up after uninstallation.

Do the following:

  1. On the vCenter server, stop the vSphere Client services.

    The services are vsphere-ui and vsphere-client.

    For assistance with the command line or vSphere Client, see the VMware article "How to stop, start, or restart vCenter Server 6.x services (2109881)":

    https://kb.vmware.com/kb/2109881

  2. Remove references to the plug-in, as follows:

    a.

    On a vCenter appliance, remove the directories or files that the following find command returns:

    # find / -iname "*netbackup*"

    b.

    On a Windows vCenter, remove the directories or files that the following dir commands return:

    dir "%programdata%\*netbackup*" /s /a /b

    dir "%programfiles%\*netbackup*" /s /a /b

    Note:

    For a VMware Platform Services Controller (PSC) environment with multiple vCenters, you need only uninstall the plug-in on the vCenter where the plug-in was installed. However, you should remove references to the plug-in from all of the vCenters that are managed by the PSC.

  3. On the vCenter server, start the vSphere Client services.

    The services are vsphere-ui and vsphere-client.

To allow installation of the plug-in over an HTTP URL

  1. Add the following directive to the vCenter's webclient.properties file:

    allowHttp=true

    The webclient.properties file may be located in the following directory:

    Windows: C:\ProgramData\VMware\vCenterServer\cfg\vsphere-ui\

    Linux: /etc/vmware/vsphere-ui/

  2. Restart the vSphere Client service.

    The following VMware article contains further information on starting the vSphere Client service:

    https://kb.vmware.com/kb/2109887

  3. Log on again to the vSphere Client.

    When you log on, the plug-in is then installed.

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