Veritas NetBackup™ Plug-in for VMware vSphere Web Client Guide
- Introduction and notes
- Installing the NetBackup plug-in for vSphere Web Client
- Requirements for the NetBackup plug-in for vSphere Web Client
- Using consistent vCenter naming with the NetBackup plug-in for vSphere Web Client
- vCenter privileges for managing NetBackup plug-in installation
- Notes on using the plug-in in a VMware Platform Services Controller (PSC) environment
- Installing the NetBackup plug-in for vSphere Web Client
- Configuring the plug-in for an external certificate
- Reconfiguring the plug-in for a NetBackup CA-signed certificate
- Upgrading the NetBackup plug-in for vSphere Web Client
- Disabling the NetBackup plug-in for vSphere Web Client
- Uninstalling the NetBackup plug-in for vSphere Web Client
- Configuration overview for the NetBackup Recovery and Instant Recovery Wizards
- Configuring ports for the NetBackup legacy Web Services
- Port usage for the NetBackup vSphere Web Client Plug-in
- Creating an authentication token for the NetBackup plug-in for vSphere Web Client
- Authorizing the NetBackup plug-in to restore virtual machines
- Setting vCenter privileges for recovering virtual machines
- Adding or deleting an additional host name or IP address for an authentication token
- Revoking an authorization token
- Renewing an authorization token
- Listing all current authentication tokens
- Permissions on the NetBackup plug-in authentication token file may need to be changed
- Excluding virtual disks from the backup
- Monitoring backup status
- Restoring virtual machines
- Troubleshooting
- The message NoPermission appears during plug-in installation
- Reducing the load time for the NetBackup plug-in for vSphere Web Client
- A NetBackup master server is not available in the master server list when searching for VMs for instant recovery
- The NetBackup plug-in for vSphere Web Client does not find any backup images in the listed events
- The NetBackup Recovery Wizard for vSphere Web Client does not find a particular backup image
- Mismatch in vCenter server name (uppercase vs. lowercase letters) causes the VMware connectivity test to fail
- IR operation is not complete due to NFS mount limit exceed
- Instant recovery-ready backup images are not available for selection
- The vCenter server and NetBackup master server names are not available for search
- Preferred IR-destination options are not saved
- Virtual machine display name conflicts are not shown before the pre-recovery check
- Reasons for failure of pre-recovery checks
- Too much time taken to populate the list of NetBackup master servers
- The NetBackup plug-in is not shown in the vSphere Web Client interface even after registration
- Correct NetBackup master server does not show up for selection for a given vCenter server on the IR wizard
- Error stack displayed in the NetBackup plug-in for vSphere Web Client
- Troubleshooting master server communication failures in the plug-in's Recovery Portal
- Appendix A. Instant recovery operations
- Appendix B. Installing the vSphere Web Client plug-in from a NetBackup media server and plug-in package host
Installing the NetBackup plug-in for vSphere Web Client
This topic describes how to install the NetBackup plug-in for vSphere Web Client from either of the following:
The NetBackup master server
See “To install the NetBackup plug-in for vSphere Web Client from the NetBackup master server”.
The NetBackup appliance as master server
Note: To use a custom web server instead of the NetBackup master server:
See Installing the plug-in from a NetBackup media server and plug-in package host (web server).
To install the NetBackup plug-in for vSphere Web Client from the NetBackup master server
- On the NetBackup master server, locate the following command:
Windows: install_path\NetBackup\bin\goodies\vwcp_manage.exe
UNIX, Linux: /usr/openv/netbackup/bin/goodies/vwcp_manage
- On the master server, start vwcp_manage to begin plug-in installation.
Note the following:
vwcp_manage is a Java GUI application. Make sure that your UNIX or Linux environment supports Java GUI applications.
If you run the command with administrator or root privileges, the command discovers the available vCenters and presents them in a list. Otherwise, you must provide the vCenter names.
The vwcp_manage command detects any existing version of the vSphere Web Client plug-in and lets you either upgrade it or uninstall it.
See Uninstalling the NetBackup plug-in for vSphere Web Client.
The vwcp_manage command does not uninstall the older NetBackup plug-in for vCenter (C# plug-in). The older plug-in continues to exist separately from the new one. You can uninstall the older plug-in as explained in the NetBackup Plug-in for VMware vCenter Guide for NetBackup 8.0:
http://www.veritas.com/docs/DOC5332
Note:
Support for the older NetBackup plug-in for vCenter has been discontinued.
- Registration begins with the End User License Agreement (click Accept):
- On the following dialog, select the vCenter server from the Hostname or IP Address pull-down list, enter its credentials, then click Validate.
Note:
The vCenter credentials require the Extension privileges.
See vCenter privileges for managing NetBackup plug-in installation.
If the vwcp_manage command was not run with administrator or root privileges, you must enter the vCenter name (or IP address) manually.
- If the VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED configuration option is enabled, the following security alert appears:
See VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers and clients.
If there are multiple vCenter server root certificates, the same screen appears for each of the certificates. Click Continue if you trust the certificate, else click Cancel. If you trust one or more certificates and the certificates are successfully validated, the wizard proceeds with the plug-in registration process. If you do not trust any of the certificates or the certificate validation fails, the plug-in installation does not proceed further.
The registration utility determines whether the plug-in is registered on the vCenter. If the plug-in is not registered, the following dialog appears and shows the plug-in URL.
The URL field is pre-populated with the plug-in package URL as hosted on the master server.
To use a custom web server instead of the master server, select Use alternate plug-in package location and enter the full URL for the plug-in package.
See Installing the plug-in from a NetBackup media server and plug-in package host (web server).
- Click Register. A security alert appears:
This security alert shows the identity of the web server that hosts the plug-in package. By default this web server is the NetBackup master server. The vCenter later downloads the plug-in from this server (the plug-in package host). Use this dialog to verify the identity of that server.
- To allow the installation to proceed, click Continue.
The following appears:
- Click Close.
- Log on to the vSphere Web Client. If you are currently logged on, log out first.
- 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 interface even after registration.
- To register the plug-in with another vCenter server, repeat this procedure starting at step 2.
Note:
For the vCenter servers that a VMware Platform Services Controller (PSC) manages, you only need to install the plug-in on one of the vCenter servers. The plug-in is then accessible to all the vCenters under the PSC.
- If the NetBackup master server uses an external certificate, see the following topic:
To install the NetBackup plug-in for vSphere Web Client from the NetBackup appliance as master server
- Log on to the appliance as a NetBackupCLI user and run the vwcp_manage command to install the plug-in.
The vwcp_manage command is located here:
/usr/openv/netbackup/bin/goodies/vwcp_manage
For example:
vwcp_manage --register - v vCenter.example.com - u vCenter_username - p password_file
Where password_file is the path to a text file that contains only the password.
Note:
As a NetBackupCLI user, you can create text files in your home directory only:
/home/nbusersFor more information on the vwcp_manage command, see the NetBackup Commands Reference Guide:
- Log on to the vSphere Web Client. If you are currently logged on, log out first.
- 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 interface even after registration.
- To register the plug-in with another vCenter server, repeat this procedure.
- If the NetBackup appliance uses an external certificate, see the following topic: