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)

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

To recover VMs, the plug-in must have a registered NetBackup master server with a valid and correct authentication token. The NetBackup administrator generates the authentication token on a specific NetBackup master server for a specific client (such as a vCenter server). The token gives the vCenter access to the NetBackup master server where the token was generated. (Note: you can validate authentication tokens for currently registered master servers by means of the Register Master Servers option in the plug-in's Recovery Portal.)

If the TCP/IP address or host name of the vCenter does not exactly match the information in the authentication token, the following operations fail: the Register Master Servers operation, and VM recovery. For VM recovery, the error message you receive depends on where in the plug-in interface you launched the restore attempt. Among the errors you can receive are:

Failed to get master server version. then java.security.cert.CertificateException

No mapping found between vCenter(s) and Master Server(s) Master Server "master_server_name" java.security.cert.CertificateException

Failed to communicate with NetBackup master server master_server_name on port 8443 with the supplied authentication token. Please verify that NetBackup master server name, port and authentication token are valid.

To correctly determine the problem and the corrective action, you must review the VxUL log file. On the master server, enter the following command:

vxlogview -i nbwebservice -p nb - L -E

Error example 1

The log file includes messages similar to the following:

02/17/2017 10:03:37.831 [Error] Remote host name does not match the 
name in the certificate, remote name:vcenter02.domain.com, name from 
certificate:vcenter02

In the log snip shown, the name in the token is vcenter02 and the required name is vcenter02.domain.com.

Veritas recommends that you revoke the existing token, generate a new token with the required name, and use the new token on the vCenter. If you cannot do that, add the vCenter's fully qualified domain name as an alias for the existing token, as follows:

manageClientCerts -addAlias vcenter02 -HOST vcenter02.domain.com

As an alternative, you can use the -ANY option:

manageClientCerts -addAlias vcenter02 -ANY

-ANY allows any host or any IP address to communicate with the NetBackup server by means of this token.

Caution:

The -ANY option is not a secure method for restores. Please see the NetBackup Commands Reference Guide for more information on the manageClientCerts command.

Error example 2

The log file includes messages similar to the following:

02/17/2017 16:18:13.951 [Error] Remote host name does not match the 
name in the certificate, remote name:10.10.10.11, name from 
certificate:vcenter02

In the log snip shown, the name in the token is vcenter02 and the required name is 10.10.10.11.

Veritas recommends that you revoke the existing token, generate a new token with the required name, and use the new token on the vCenter. If you cannot do that, add the vCenter's TCP/IP address as an alias for the existing token, as follows:

manageClientCerts -addAlias vcenter02 -IP 10.10.10.11

As an alternative, you can use the -ANY option:

manageClientCerts -addAlias vcenter02 -ANY

-ANY allows any host or any IP address to communicate with the NetBackup server by means of this token.

Caution:

The -ANY option is not a secure method for restores.

Additional information is available:

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

See the manageClientCerts command in the NetBackup Commands Reference Guide.