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)

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

This topic describes how to install the NetBackup plug-in for vSphere Client (HTML5) from a NetBackup media server.

By default, the plug-in is installed over an https connection by means of the NetBackup master server. If the master server does not have a network connection to the vCenter server, you can install the plug-in from a NetBackup media server and your own plug-in package host.

The following table is a brief list of the installation requirements, followed by the installation procedure.

Table: Requirements for installing the plug-in from a NetBackup media server

Requirement

Description

Plug-in package host (web server)

The plug-in package host must be a web server. It must be accessible as follows:

  • The vCenter server where you want to install the plug-in must have network access to this package host.

  • The NetBackup media server where you run the plug-in installation must have network access to this package host.

Note:

You must supply the URL of the plug-in package host during plug-in installation.

Plug-in installation media

The plug-in installation media is a zip file that needs to be hosted on a web server. This file contains the plug-in software that the VMware vCenter downloads for plug-in deployment.

  • For vCenter versions earlier than 7.0, use the following zip file:

    netbackup-vwc-plugin.zip

  • For vCenter versions 7.0 or later, use the following zip file

    netbackup-vwc-plugin-html5ui.zip

Note:

Do not rename the netbackup-vwc-plugin.zip file or the netbackup-vwc-plugin-html5ui.zip file.

NetBackup media server

The media server from which you install the plug-in must have network access to the plug-in package host web server and to the vCenter server.

Additional configuration if the URL for the plug-in package host uses HTTP instead of HTTPS.

To configure the vCenter to allow an http URL, add allowHttp=true to the vCenter's webclient.properties file. Use the procedure in the following topic:

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

To install the plug-in from a NetBackup media server

  1. Download the appropriate zip file from the NetBackup master server and copy it to the appropriate folder on the plug-in package host (web server). The vCenter later downloads the file from the web server.
    • For vCenter versions earlier than 7.0, use the following zip file:

      netbackup-vwc-plugin.zip

    • For vCenter versions 7.0 or later, use the following zip file

      netbackup-vwc-plugin-html5ui.zip

    Note:

    Do not rename the netbackup-vwc-plugin.zip file or the netbackup-vwc-plugin-html5ui.zip file.

    You can download the file from the master server by means of a browser:

    For vCenter versions earlier than 7.0:

    https://master_server_host_name:8443/nbwebservice/plugins
    /netbackup-vwc-plugin.zip

    For vCenter versions 7.0 or later:

    https://master_server_host_name:8443/nbwebservice/plugins
    /netbackup-vwc-plugin-html5ui.zip

    Note:

    This example uses a port number of 8443. The port number on the master server however may be different.

  2. A security pop-up may ask you to verify or confirm the master server's certificate for the download. To proceed with the download, you must verify the certificate by confirming the security exception.

    If the certificate has already been trusted or added as an exception, the security pop-up does not appear.

  3. From the media server that has network access to the vCenter and to the plug-in package host, start the vwcp_manage command:

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

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

    Note:

    If you run vwcp_manage with administrator or root privileges, the command discovers the available vCenters and presents them in a list (in a following step). Otherwise, you must provide the vCenter name or IP address.

  4. Registration begins with the End User License Agreement (click Accept):
  5. On the following dialog, use the pull-down list to select the vCenter server and enter the credentials, then click Validate.

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

    The registration utility connects to the vCenter server and determines whether the plug-in is registered. If the plug-in is not registered, the Plug-in package location dialog appears.

  6. Select Use alternate plug-in package location and enter the full URL of the plug-in package host where the netbackup-vwc-plugin.zip or netbackup-vwc-plugin-html5ui.zip file is hosted. This host is the web server where the plug-in zip file was copied in step 1. You can test the URL by downloading the plug-in zip file using a web browser.

    Note:

    The URL field is not pre-populated with the plug-in package host URL. You must enter the URL.

  7. Click Register.
    • If the URL entered in step 6 uses the secure https protocol, a security alert appears:

      This security alert shows the identity of the web server that hosts the plug-in package. The vCenter later downloads the plug-in from this server. Use this dialog to verify the identity of the plug-in package web server.

      To allow the installation to proceed, click Continue.

    • If the URL entered in step 6 uses http instead of https, you are prompted to configure the vCenter to allow an http URL:

      To configure the vCenter to allow an http URL, use the procedure in the following topic:

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

      When you have completed the procedure to allow installation of the plug-in over HTTP, click OK on the Warning.

      Note:

      If the vCenter's webclient.properties file already includes allowHttp=true, you can skip the HTTP procedure (click OK on the Warning).

    The following appears:

  8. Click Close.
  9. 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.

    See How to access the features of the NetBackup plug-in for vSphere Client (HTML5).

    If the Veritas NetBackup tab does not appear:

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

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