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

Last Published:
Product(s): NetBackup (9.1)
  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.1
  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)

Configuring ports for the NetBackup Web Services

The NetBackup Recovery Wizard requires the proper configuration of web ports for the NetBackup Web Services on the master server. Otherwise, you cannot authorize the NetBackup plug-in to restore the virtual machines that were backed up by that master server.

The NetBackup installation process automatically runs the configurePorts script to configure NetBackup Web Services to run on any of the following sets of ports.

Table: Port sets for NetBackup Web Services

Port set

HTTPS port

Shutdown port

First set

8443

8205

Second set

8553

8305

Third set

8663

8405

If the configurePorts script does not find one of the sets free (for example 8443 and 8205), it logs an error to the following file:

Windows:

install_path\NetBackup\wmc\webserver\logs\nbwmc_configurePorts.log

UNIX and Linux:

/usr/openv/wmc/webserver/logs/nbwmc_configurePorts.log

On UNIX and Linux, the following appears on the NetBackup system console:

configurePorts: WmcPortsUpdater failed with exit status <status_code>

When this error occurs, use the following procedure on the master server to manually configure the ports. The configurePorts command is in the following location:

Windows:

install_path\NetBackup\wmc\bin\install\configurePorts

UNIX or Linux:

/usr/openv/wmc/bin/install/configurePorts

Note:

NetBackup Web Services on the master server require port 1024 or higher. Do not use a port number that is less than 1024. Ports that are less than 1024 are privileged and cannot be used with the NetBackup Web Services.

To configure ports for the NetBackup Web Services

  1. On the master server, enter the following to list the currently configured ports:

    configurePorts -status

    Example output:

    Current Https Port: 8443
    Current Shutdown Port: 8205
    
  2. Use the configurePorts command in the following format to re-configure a port:

    configurePorts -httpsPort https_port | -shutdownPort shutdown_port

    You can configure one or two ports at a time. For example, to configure the HTTPS port to 8553:

    configurePorts -httpsPort 8553

    Output:

    Old Https Port: 8443
    New Https Port: 8553
    

    Use this command as needed to configure a set of ports for HTTPS and shutdown.

    See Table: Port sets for NetBackup Web Services for a list of the port sets.

  3. If the master server is in a clustered environment, do the following:

    • Make sure that the same set of ports are free on all the cluster nodes: Do step 1 on each node.

    • Reconfigure the ports on each node as required: Do step 2.

    • To override the ports that are used across all nodes, enter the following:

      configurePorts - overrideCluster true

      This command updates the following file on shared disk:

      Windows:

      install_path\NetBackup\var\global\wsl\portfile

      UNIX or Linux:

      /usr/openv/netbackup/var/global/wsl/portfile

      The NetBackup installer for Web Services uses this file during installation in a clustered mode.

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