Veritas NetBackup™ Plug-in for VMware vSphere Web Client Guide

Last Published:
Product(s): NetBackup (8.1)
  1. Introduction and notes
    1.  
      About the NetBackup plug-in for VMware vSphere Web Client
    2.  
      Notes on the NetBackup plug-in for vSphere Web Client
    3.  
      How to access the features of the NetBackup plug-in for vSphere Web Client
    4.  
      Updates to this guide for NetBackup 8.1
  2. Installing the NetBackup plug-in for vSphere Web Client
    1.  
      Requirements for the NetBackup plug-in for vSphere Web Client
    2.  
      Using consistent vCenter naming with the NetBackup plug-in for vSphere Web Client
    3.  
      vCenter privileges for managing NetBackup plug-in installation
    4.  
      Notes on using the plug-in in a VMware Platform Services Controller (PSC) environment
    5.  
      Installing the NetBackup plug-in for vSphere Web Client
    6.  
      Upgrading the NetBackup plug-in for vSphere Web Client
    7.  
      Disabling the NetBackup plug-in for vSphere Web Client
    8.  
      Uninstalling the NetBackup plug-in for vSphere Web Client
    9. Configuration overview for the NetBackup Recovery Wizard (in the NetBackup plug-in for vSphere Web Client)
      1.  
        Creating an authentication token for the NetBackup plug-in for vSphere Web Client
      2.  
        Authorizing the NetBackup plug-in for vSphere Web Client to restore virtual machines
      3.  
        Setting vCenter privileges for recovering virtual machines with the NetBackup plug-in for vSphere Web Client
      4.  
        Adding or deleting an additional host name or IP address for an authentication token
      5.  
        Revoking an authorization token for the NetBackup plug-in for vSphere Web Client
      6.  
        Renewing an authorization token
      7.  
        Listing all current authentication tokens for the NetBackup plug-in for vSphere Web Client
      8.  
        Permissions on the NetBackup vSphere Web Client plug-in authentication token file may need to be changed
      9.  
        Port usage for the NetBackup vSphere Web Client Plug-in
  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.  
      Veritas NetBackup tab in vSphere Web Client
    3.  
      Summary display (in the NetBackup plug-in for vSphere Web Client)
    4.  
      Virtual Machines display (in the NetBackup plug-in for vSphere Web Client)
    5.  
      Events display (in the NetBackup plug-in for vSphere Web Client)
    6.  
      Using the Veritas NetBackup tab for backup reporting (in the NetBackup plug-in for vSphere Web Client)
    7.  
      How to respond to backup status with the NetBackup plug-in for vSphere Web Client
  5. Restoring virtual machines
    1.  
      Configuring settings for the virtual machine recovery
    2.  
      Notes on the NetBackup recovery wizards in the NetBackup plug-in for vSphere Web Client
    3.  
      How to access the NetBackup Recovery Wizards in the NetBackup plug-in for vSphere Web Client
    4. NetBackup Recovery Wizard screens
      1.  
        Virtual Machine Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      2.  
        Image Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      3.  
        Destination Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      4.  
        Transport Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      5.  
        Disk Provision screen (NetBackup Recovery Wizard for vSphere Web Client)
      6.  
        Virtual Machine Options screen (NetBackup Recovery Wizard for vSphere Web Client)
      7.  
        Network Selection screen (NetBackup Recovery Wizard for vSphere Web Client)
      8.  
        Pre-Recovery Check screen (NetBackup Recovery Wizard for vSphere Web Client)
    5. NetBackup Instant Recovery Wizard screens
      1.  
        Selecting virtual machines for instant recovery
      2.  
        Selecting backup images for instant recovery
      3.  
        Selecting the destination for instant recovery
      4.  
        Setting virtual machine options
      5.  
        Reviewing recovery settings
    6.  
      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 Web Client
    3.  
      A NetBackup master server is not available in the master server list when searching for VMs for instant recovery
    4.  
      The NetBackup plug-in for vSphere Web Client does not find any backup images in the listed events
    5.  
      The NetBackup Recovery Wizard for vSphere Web Client 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.  
      IR 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 IR-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 Web Client even after registration
    15.  
      Correct NetBackup master server does not show up for selection for a given vCenter server on the IR wizard
    16.  
      Error stack displayed in the NetBackup plug-in for vSphere Web Client
    17.  
      Troubleshooting master server communication failures in the plug-in's Recovery Portal
  7. Appendix A. Instant recovery operations
    1.  
      Instant recovery events for non-available virtual machines
    2.  
      Best practices for instant recovery operations
  8. Appendix B. Installing the vSphere Web Client plug-in from a NetBackup media server and plug-in package host
    1.  
      Installing the vSphere Web Client plug-in from a NetBackup media server and plug-in package host (web server)

Installing the vSphere Web Client 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 Web Client from a NetBackup media server.

By default, the vSphere Web Client 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.

Table: Requirements for installing the vSphere Web Client plug-in from a NetBackup media server is a brief list of the installation requirements, followed by the installation procedure.

Table: Requirements for installing the vSphere Web Client 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 (netbackup-vwc-plugin.zip) 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.

Note:

Do not rename the netbackup-vwc-plugin.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 Web Client even after registration.

To install the vSphere Web Client plug-in from a NetBackup media server

  1. Download the netbackup-vwc-plugin.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.

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

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

    Note:

    This example uses a port number of 8443. However, the port number on the master server 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 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 Web Client 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).

  8. The following appears:
  9. Click Close.
  10. To verify that the plug-in installed correctly, go to the vSphere Web Client object navigator.

    For example, under Home > Hosts and Clusters > Monitor, look for the Veritas NetBackup tab.

    See How to access the features of the NetBackup plug-in for vSphere Web Client.

    If the Veritas NetBackup tab does not appear:

    See The NetBackup plug-in is not shown in the vSphere Web Client even after registration.

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