NetBackup102 VSphereClient HTML5 Plug-In Guide
NetBackup102 VSphereClient HTML5 Plug-In Guide
Release 10.1.2
NetBackup™ Plug-in for VMware vSphere Client
(HTML5) Guide
Last updated: 2023-03-17
Legal Notice
Copyright © 2023 Veritas Technologies LLC. All rights reserved.
Veritas, the Veritas Logo, Veritas Alta, and NetBackup are trademarks or registered trademarks
of Veritas Technologies LLC or its affiliates in the U.S. and other countries. Other names may
be trademarks of their respective owners.
This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-party Programs”). Some of the Third-party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the Third-party Legal Notices document accompanying this
Veritas product or available at:
https://www.veritas.com/about/legal/license-agreements
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:
https://www.veritas.com/support
You can manage your Veritas account information at the following URL:
https://my.veritas.com
If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:
Japan [email protected]
Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:
https://sort.veritas.com/documents
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents
Limitations .................................................................................. 77
■ How to access the features of the NetBackup plug-in for vSphere Client (HTML5)
Figure 1-1
■ To access and manage the backup and recovery of the virtual machines with a
specific NetBackup server, the user must select the same NetBackup server
when logging in to the Plug-in.
■ With vSphere version 7.0, it is possible to register multiple NetBackup servers
with the plug-in, which would appear in the login screen, for selection. Register
each NetBackup primary server with the plug-in, in order to access it for recovery
management and virtual disc exclusion. For detailed information about
registration from multiple NetBackup servers, See “Installing the NetBackup
plug-in for vSphere Client (HTML5)” on page 16.
■ For NetBackup version 10.0, all the Plug-ins that are installed before the
NetBackup version 10.0, are not supported.
■ For detailed information about un-registration of the Plug-ins which are installed
before NetBackup 10.0:
See “Uninstalling the NetBackup plug-in for vSphere Client (HTML5)” on page 25.
■ The best screen resolution for the plug-in is 1280 x 1024 or greater.
■ The plug-in does not support auto-refresh. To refresh the display, click the
vSphere Client refresh icon.
■ In vCenter, the default retention period for vCenter events is 180 days. This
value is the recommended setting.
■ If an ESXi server is removed from vCenter and re-added, the events for the VMs
managed by that ESXi are lost. For VM status, the plug-in shows "No Backup
Information." The status changes as new backup events occur for each VM.
■ See “Notes on the NetBackup recovery wizards” on page 53.
■ The NetBackup primary server must be configured with backup policies of type
VMware, with the Post events to vCenter option set to All Events.
The plug-in monitors backups that a NetBackup VMware policy made. The
plug-in does not monitor backups from other policy types.
Note the following exceptions:
■ The plug-in does not monitor backups from a VMware policy that had Use
Replication Director enabled and Application Consistent Snapshot
disabled (under Options).
■ The plug-in does not monitor all the copies that a storage lifecycle policy
(SLP) makes; it monitors the first image only.
■ Search for virtual machines does not support non-ASCII characters. However,
the search results show the VM names that contain non-ASCII characters.
Therefore, you can search for ASCII characters only and still see the VMs that
contain non-ASCII characters in their names.
Introduction and notes 10
How to access the features of the NetBackup plug-in for vSphere Client (HTML5)
Table 1-1 Accessing basic functions of the NetBackup plug-in for vSphere
Client
Log in to the In vSphere client, click NetBackup. See “Log-in to the plug-in”
Plug-in on page 36.
Monitor the status In vSphere Client, click Hosts and Clusters or VMs, then click Monitor.
of virtual machine
Select the vSphere object to monitor, such as vCenter, ESXi server,
backups.
VM, or other object.
Configure a In vSphere Client, click Veritas NetBackup, then click Virtual Disk
custom attribute to Exclusion.
exclude disks from
Note: The disk exclusion wizard is optional. It is not required for
backups.
monitoring virtual machine backups.
Restore a virtual In vSphere Client, click Veritas NetBackup, then click Recovery or
machine. Instant Recovery and Cleanup.
You can access the Recovery options in several other ways:
■ Using consistent vCenter naming with the NetBackup plug-in for vSphere Client
(HTML5)
Requirement Notes
NetBackup primary The NetBackup primary server must be installed before you can install the plug-in. The
server NetBackup primary server hosts the plug-in. During plug-in installation the vCenter refers to
the details of the NetBackup server and accordingly opens the extension point.
Note: Before using the plug-in, make sure NetBackup is configured to back up the virtual
machines. The following for example are required:
Note: Veritas recommends the use of fully qualified names. The entire name must be
properly formed without empty or null elements. For example, a fully-qualified name must
include the domain name and not end in a period (.).
■ A VMware policy to back up the VMs.
■ In the policy's Advanced Attributes, the Post vCenter events option must be set to All
Events.
See “Installing the NetBackup plug-in for vSphere Client (HTML5)” on page 16.`
The NetBackup for VMware administrator's guide explains how to configure NetBackup for
VMware:
http://www.veritas.com/docs/DOC5332
vCenter server NetBackup must have credentials for the vCenter servers where virtual machines are to be
credentials (user name restored.
and password)
For information on VMware Platform Services Controller (PSC) environments:
See “Notes on using the vSphere Client (HTML5) plug-in in a VMware Platform Services
Controller (PSC) environment” on page 15.
Note: To install the plug-in, the Extension privileges are required on the vCenter.
See “vCenter privileges for managing NetBackup plug-in installation” on page 14.
Consistent vCenter See “Using consistent vCenter naming with the NetBackup plug-in for vSphere Client (HTML5)”
naming on page 13.
vCenter privileges for To use the plug-in to monitor virtual machine backups, the vCenter Global credentials Manage
backup monitoring custom attributes and Set custom attribute are required.
Requirement Notes
vCenter privileges for To use the plug-in to configure a Custom Attribute to exclude disks from backups, the vCenter
configuring a Custom Global credentials Manage custom attributes and Set custom attribute are required.
Attribute to exclude
See “About excluding virtual disks from the backup” on page 37.
disks from backups.
NetBackup Recovery See “How to access the NetBackup Recovery Wizard” on page 54.
Wizards
NetBackup privileges See “ NetBackup permissions for the plug-in” on page 31.
or RBAC
For a list of NetBackup versions and VMware versions that are supported for the
plug-in, see the following document:
■ Support for NetBackup 7.x and 8.x in virtual environments:
http://www.veritas.com/docs/000006177
Note: If the vCenter server name is not entered correctly, the plug-in may not be
able to access one or more of the virtual machine images.
Installing the NetBackup plug-in for vSphere Client (HTML5) 14
vCenter privileges for managing NetBackup plug-in installation
Note: The Extension privileges are also required for updating or uninstalling the
plug-in.
■ Only plug-in version 10.0 supported for NetBackup version 10.0 and later.
Note: Earlier version of the plug-in does not support NetBackup version 10.0
onwards.
■ If you have NetBackup version prior to 10.0, continue to use earlier version of
the plug-in. Or uninstall earlier version of the plugin. For uninstalling, See
“Uninstalling the NetBackup Local plug-in for vSphere Client (HTML5)”
on page 27.
install_path\NetBackup\bin\goodies\vwcp_manage.exe
UNIX, Linux
/usr/openv/netbackup/bin/goodies/vwcp_manage
Note: Support for the older NetBackup plug-in for vCenter has been
discontinued.
3 Registration begins with the End User License Agreement. Click Accept.
4 On the VMware vCenter Server Details dialog, enter the required credential
details and click Validate.
Note: The vCenter credentials require the Extension privileges. See “vCenter
privileges for managing NetBackup plug-in installation” on page 14.
If the vwcp_manage command was not run with administrator or root privileges,
you must enter the vCenter name (or IP address) manually.
Installing the NetBackup plug-in for vSphere Client (HTML5) 18
Installing the NetBackup plug-in for vSphere Client (HTML5)
5 If the VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
configuration option is enabled See
“VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers
and clients” on page 24., the security alert pop up appears.
Note: If there are multiple vCenter server root certificates, the security alert
appears for each of the certificate.
7 Click Register.
8 Click Continue to accept the security alert about NetBackup plug-in installation.
9 After successful installation, click Close.
10 Log on to vSphere Client (HTML5). If you are currently logged on, log out first.
Ensure that Veritas NetBackup appears as one of the options in the left pane.
11 If the Veritas NetBackupoption is not available, See “The NetBackup plug-in
is not shown in the vSphere Client (HTML5) interface even after registration”
on page 71.
install_path\NetBackup\bin\goodies\vwcp_manage.exe
UNIX, Linux
/usr/openv/netbackup/bin/goodies/vwcp_manage
2 On the primary server, run the vwcp_manage command to begin plug-in 10.x
installation.
Notes:
Installing the NetBackup plug-in for vSphere Client (HTML5) 19
Installing the NetBackup plug-in for vSphere Client (HTML5)
Note: Support for the older NetBackup plug-in for vCenter has been
discontinued.
Note: The vCenter credentials require the Extension privileges. See “vCenter
privileges for managing NetBackup plug-in installation” on page 14..
If the vwcp_manage command was not run with administrator or root privileges,
you must enter the vCenter name (or IP address) manually.
5 If the VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
configuration option is enabled See
“VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers
and clients” on page 24., the security alert pop up appears.
Note: If there are multiple vCenter server root certificates, the security alert
appears for each of the certificate.
■ If you do not trust any of the certificates or the certificate validation fails,
the plug-in installation does not proceed further.
install_path\NetBackup\bin\goodies\vwcp_manage.exe
UNIX, Linux
/usr/openv/netbackup/bin/goodies/vwcp_manage
2 On the primary server, run the vwcp_manage command to begin plug-in 10.x
installation.
Notes:
■ vwcp_manage is a NetBackup Administration Console application. Ensure
that your UNIX or Linux environment supports NetBackup Administration
Console 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 plug-in and
lets you either upgrade it or uninstall it. See “Uninstalling the NetBackup
plug-in for vSphere Client (HTML5)” on page 25.
Installing the NetBackup plug-in for vSphere Client (HTML5) 21
Installing the NetBackup plug-in for vSphere Client (HTML5)
■ 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.
Note: Support for the older NetBackup plug-in for vCenter has been
discontinued.
3 Registration begins with the End User License Agreement. Click Accept.
4 On the VMware vCenter Server Details dialog, entire the required credential
details and click Validate.
Note: The vCenter credentials require the Extension privileges. See “vCenter
privileges for managing NetBackup plug-in installation” on page 14..
If the vwcp_manage command was not run with administrator or root privileges,
you must enter the vCenter name (or IP address) manually.
5 If the VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
configuration option is enabled See
“VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers
and clients” on page 24., the security alert pop up appears.
Note: If there are multiple vCenter server root certificates, the security alert
appears for each of the certificate.
6 Ensure that on the Select the plug-in type dialog, Remote Plug-in option is
selected. Click Next.
7 Click Register.
8 Click Continue to accept the security alert about NetBackup plug-in installation.
9 After successful installation, click Close.
Installing the NetBackup plug-in for vSphere Client (HTML5) 22
Installing the NetBackup plug-in for vSphere Client (HTML5)
10 Log on to vSphere Client (HTML5). If you are currently logged on, logout and
then relog in. Ensure that Veritas NetBackup appears in the navigation pane.
11 If the Veritas NetBackup option is not available,See “The NetBackup plug-in
is not shown in the vSphere Client (HTML5) interface even after registration”
on page 71.
install_path\NetBackup\bin\goodies\vwcp_manage.exe
UNIX, Linux
/usr/openv/netbackup/bin/goodies/vwcp_manage
2 On the primary server, run the vwcp_manage command to begin plug-in 10.x
installation.
Notes:
■ vwcp_manage is a NetBackup Administration Console application. Ensure
that your UNIX or Linux environment supports NetBackup Administration
Console 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 plug-in and
lets you either upgrade it or uninstall it. See “Uninstalling the NetBackup
plug-in for vSphere Client (HTML5)” on page 25.
■ 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.
Note: Support for the older NetBackup plug-in for vCenter has been
discontinued.
Installing the NetBackup plug-in for vSphere Client (HTML5) 23
Installing the NetBackup plug-in for vSphere Client (HTML5)
Note: The vCenter credentials require the Extension privileges. See “vCenter
privileges for managing NetBackup plug-in installation” on page 14..
If the vwcp_manage command was not run with administrator or root privileges,
you must enter the vCenter name (or IP address) manually.
5 If the VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
configuration option is enabled See
“VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers
and clients” on page 24., the security alert pop up appears.
Note: If there are multiple vCenter server root certificates, the security alert
appears for each of the certificate.
6 Ensure that on the Select the plug-in type dialog, Remote Plug-in option is
selected. Click Next.
7 Click Register.
8 Click Continue to accept the security alert about NetBackup plug-in installation.
9 After successful installation, click Close.
10 Log on to vSphere Client (HTML5). If you are currently logged on, logout and
then relog in. Ensure that Veritas NetBackup appears in the navigation pane.
11 If the Veritas NetBackup option is not available,See “The NetBackup plug-in
is not shown in the vSphere Client (HTML5) interface even after registration”
on page 71.
Installing the NetBackup plug-in for vSphere Client (HTML5) 24
VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers and clients
For example:
password_file is the path to a text file that contains only the password.
Note: As a NetBackup CLI user, you can create text files in your home directory
only at /home/nbusers. For more information on the vwcp_manage command,
see the NetBackup Commands Reference Guide.
2 Log on to vSphere Client (HTML5). If you are currently logged on, log out and
re-log in. The Veritas NetBackup option must appear in the navigation pane
and in Shortcuts. If it is not available, See “The NetBackup plug-in is not shown
in the vSphere Client (HTML5) interface even after registration” on page 71.
3 To register the plug-in with another vCenter server, repeat this procedure.
VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
for servers and clients
The VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED option enables the
validation of virtualization server certificates using its root or intermediate certificate
authority (CA) certificates.
Before you enable the option, review the steps from the 'Validating VMware
virtualization server certificates in NetBackup ' section in the NetBackup for VMware
Administrator's Guide.
By default, the VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED option is set to
UNDEFINED.
The security certificate validation is enabled for Red Hat Virtualization and Nutanix
AHV servers, but is disabled for VMware servers.
Installing the NetBackup plug-in for vSphere Client (HTML5) 25
Uninstalling the NetBackup plug-in for vSphere Client (HTML5)
Usage Description
How to use Use the nbgetconfig and the nbsetconfig commands to view,
add, or change the option.
Use the following format to enable certificate validation for the Red
Hat Virtualization, VMware, or Nutanix AHV servers:
VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED = YES
Note: To unregister and uninstall the plug-in, the vCenter credentials require the
Extension privileges.
See “vCenter privileges for managing NetBackup plug-in installation” on page 14.
Installing the NetBackup plug-in for vSphere Client (HTML5) 26
Uninstalling the NetBackup plug-in for vSphere Client (HTML5)
Note: This unregister's the Plug-in from the logged in NetBackup primary server
but other NetBackup primary servers remain unaffected.
5 Log on to the vSphere Client. If you are currently logged on, log out first.
Installing the NetBackup plug-in for vSphere Client (HTML5) 27
Uninstalling the NetBackup Local plug-in for vSphere Client (HTML5)
To unregister and uninstall the NetBackup plug-in for vSphere Client (HTML5)
by means of the NetBackup appliance as primary server
1 Log on to the appliance as a NetBackup CLI user and run the vwcp_manage
command to uninstall the plug-in.
The vwcp_manage command is located here:
/usr/openv/netbackup/bin/goodies/vwcp_manage
For example:
vwcp_manage --unregister –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 NetBackup CLI user, you can create text files in your home directory
only: /home/nbusers
Note: To unregister and uninstall the plug-in, the vCenter credentials require the
Extension privileges.
See “vCenter privileges for managing NetBackup plug-in installation” on page 14.
3 On the VMware vCenter Server Details dialog, select the vCenter from the
pull-down list and enter the vCenter credentials. Click Validate.
4 Unregister Local Plug-in when one or more Plug-ins installed.
■ On the Select the Plug-in type dialog, select the local plug-in and click
Next.
■ On the Unregister the Plug-in window, click Unregister and confirm it.
■ On the Finish dialog, click Close.
5 Log on to the vSphere Client. If you are currently logged on, log out first.
To unregister and uninstall the NetBackup local plug-in for vSphere Client
(HTML5) by means of the NetBackup appliance as primary server
1 Log on to the appliance as a NetBackup CLI user and run the
vwcp_managecommand to uninstall the plug-in.
For example:
Note: password_file is the path to a text file that contains only the password.
Note: As a NetBackup CLI user, you can create text files in your home directory
only at /home/nbusers. For more information see, NetBackup Commands
Reference Guide
2 Log on to the vSphere Client. If you are currently logged on, log out first.
Chapter 3
Plug-in Configurations
This chapter includes the following topics:
To use the NetBackup Recovery and Instant Recovery Wizards to restore virtual
machines, configure the following:
Table 3-2 Ports used in NetBackup and the vSphere Client plug-in
environment
For Plug-in access: vCenter RESTful interface at port 443 Primary server
server version before 7.0 (or (https)
vSphere Client server if
deployed independently)
Caution: The NetBackup Virtual Machine Recovery privilege grants global recovery
authorization. It allows users with that role to recover any virtual machine that resides
on that vCenter. Use caution when granting this privilege to users.
C:\Program Files\Veritas\NetBackup\jre\bin\keytool"
-storetype BCFKS providerpath "C:\Program
Files\Veritas\NetBackup\wmc\ webserver\lib\ccj-3.0.1.jar" -
providerclass com.safelogic.cryptocomply.
jcajce.provider.CryptoComplyFipsProvider
-importcert -trustcacerts -file
C:\Users\labuser\Downloads\download \certs\win\ vCenter
Certificate -keystore "C:\Program Files
\Veritas\NetBackup\var\global\wsl\credentials\truststoreVWC
P.bcfks" -storepass 3588289782 -alias VMwareCA
Linux
■ Prerequisites
Note: Login is required only in case of managing recovery and instant recovery.
However, it is not needed for the monitoring purpose.
Prerequisites
■ The user must have valid NetBackup user credentials.
■ The user credentials must have appropriate privileges, to access specific feature
of the Plug-in.
Log in to the Plug-in 36
Log-in to the plug-in
Note: For example, a specific user with privileges to perform recovery, can only
perform recovery on the virtual machines. The other user would see error
describing insufficient rights.
Note: For vCenter version 7.0 and later, multiple NetBackup servers are available
for selection. All the NetBackup servers, need to be registered with the Plug-in.
For vCenter versions before 7.0, multiple NetBackup servers registration is not
possible and hence only one server is displayed for selection.
3 On the Virtual Machine Selection screen, select the VMs to which you want
to apply the Custom Attribute, as follows:
a. In the vCenter Server drop-down list, select the vCenter server that hosts the
virtual machines.
By default, the wizard selects the server that you selected in the vSphere Client.
b. In the Custom Attribute field, enter the name for the attribute.
c. Click in the Search field to enter a value to search for, then click Search.
d. In the search results list, select the VMs to which you want to add the Custom
Attribute and then click ADD VIRTUAL MACHINE. You can change the Search
Results order by clicking on the column headers.
At the top of the screen, a message shows how many VMs that you successfully
added.
4 On the Select Virtual Disks to Exclude screen, select the virtual disks to
which you want to apply the Custom Attribute, as follows:
You can remove VMs or refresh the display by clicking the vertical ellipsis next
to the VM:
b. In the Available Disks list, select the disk or disks to add to the Custom Attribute.
You can select all disks in the list by clicking the check box next to the Exclude
disk column header. If a disk is excluded already, a warning icon appears in the
Exclude disk column.
d. When you finish selecting disks, click Next to continue to the next wizard screen.
Excluding virtual disks from the backup 41
Setting the exclude disks Custom Attribute
5 On the Review Selections screen, review and set the Custom Attribute, as
follows:
b. Click Exclude Disks to add the Custom Attribute to all of the selected VMs. The
list box shows the results of the operation.
c. Click Finish.
Chapter 6
Monitoring backup status
This chapter includes the following topics:
■ Backup monitoring displays in the NetBackup plug-in for vSphere Client (HTML5)
■ Summary display
■ Events display
Note: Select an object, such as a vCenter, folder, datacenter, or ESXi host. The
plug-in displays information for the VMs within the object that you select.
Monitoring backup status 44
Summary display
Figure 6-1 The three monitor options: Summary, Virtual Machines, Events
The following table describes the available displays based on the selected objects:
Summary A summary and graphical display of backup success and backup events for a specified time
period. Can show the current backup status for a selected VM.
You can filter the information with a range of criteria. Includes an option for customized sorting
in multiple columns.
Backup Events More detailed tabular display of backup information based on events. Can show backup events
for a VM or its parent object.
You can filter the information with a range of criteria. Includes an option for customized sorting
in multiple columns.
Summary display
This display summarizes backup status, backup events, and backup age for the
VMs in the vSphere object that you select. If you select an individual VM, the
Summary display shows backup status and events for that VM. . If you select a
Monitoring backup status 45
Summary display
non-VM object, then for the backup events the information suggests you to visit
individual VM for more details of the events data.
The following shows an example of the Summary display for multiple VMs.
Table 6-2 Summary display in the NetBackup plug-in for vSphere Client
(HTML5)
Panel Description
Virtual Machines Shows the current backup status for a particular VM or for all the VMs that belong to the selected
vSphere object.
If the vSphere object is higher than the level of a VM, the backup status appears in a color-coded
pie chart.
Note: If the panel applies to more than one VM: click on the linked values (such as for Backup
Successful or Total) to see the details in the Virtual Machines display.
Monitoring backup status 46
Virtual Machines display
Table 6-2 Summary display in the NetBackup plug-in for vSphere Client
(HTML5) (continued)
Panel Description
Virtual Machines Shows the backup age of the VMs in a bar chart. This panel is available only for a vSphere object
By Backup Age that is higher than the level of a VM.
Lists the total number of backup events and a breakdown of the events by Backup Successful,
Backup Failed, and Snapshot Delete Failed.
Note: Click on the linked values for Backup Successful, Backup Failed, Snapshot Delete
Failed, or Total to see the details in the Events display.
Includes a color-coded bar chart that represents the type and number of backup events that
occurred within a specified period.
You can configure the chart as follows:
■ Select the types of events that appear in the chart by clicking on the color-coded check boxes.
■ Select a different time period from View events from the last.
User needs to visit an individual VM for more details of its events data.
Figure 6-3 Virtual Machines display in the NetBackup plug-in for vSphere
Client (HTML5)
The following table describes the fields and options in the Virtual Machines display.
Option Description
Backup Successful For the selected vSphere object, shows only the VMs
that were successfully backed up.
Backup Failed For the selected vSphere object, shows only the VMs
that were not successfully backed up.
No Backup Information For the selected vSphere object, shows only the VMs
for which no backup status exists.
Excluded From Reporting For the selected vSphere object, shows the VMs that
were intentionally excluded from scheduled backups
(contact the NetBackup administrator).
Table 6-3 Fields and options in the Virtual Machines display (continued)
Option Description
Backup Status The current status of backups for the VM. The status
values are:
Last Successful Backup The date and time of the last successful backup.
Events display
This display shows backup information based on events, such as backup successful,
backup failed, and snapshot delete failed.
The following is an example of the Events display.
Option Description
ALL For the selected vSphere object, shows all backup status (successful, failed, and so forth).
Backup For the selected vSphere object, shows only the VMs that were successfully backed up.
Successful
Backup Failed For the selected vSphere object, shows only the VMs that were not successfully backed up.
Snapshot Delete For the selected vSphere object, shows only the VMs for which NetBackup failed to delete the
Failed snapshot after the backup completed.
Note: After it creates a snapshot, NetBackup deletes the snapshot when the backup completes.
If NetBackup fails to delete snapshots, the performance of the VM may eventually decline. In that
case, you may need to delete the snapshots manually.
Option Description
Backup Host The backup host (proxy) that performed the backup.
Primary The NetBackup primary server where the backup policy is defined.
Job Duration The amount of time that the backup job needed to complete.
To recover a VM, select Backup Successful under Event Details, click on the vertical ellipsis
in the VM's row, and click Recover.
Click the export icon to export the rows to a comma-separated text (CSV) file:
To export the information for a particular VM, first click on the check box of the VM.
The copy icon copies the information to the Clipboard. The export icon exports
the rows to a comma-separated text (CSV) file.
Monitoring backup status 52
How to respond to backup status
Table 6-5 Tips for responding to backup status in the NetBackup plug-in
for vSphere Client
Status Action
Backup failures ■ Look at the number of consecutive failures on the Virtual Machines
display.
■ If too many failures have occurred, export the display results (use
the save-file icon in the lower right). Send the file to the NetBackup
administrator.
Snapshot delete NetBackup attempts to delete old snapshots at the start of each backup.
failed If snapshots are not deleted, you can manually delete them in vSphere
Client.
Chapter 7
Restoring virtual machines
This chapter includes the following topics:
■ The recovery wizards are an optional feature of the plug-in. They are not required
for monitoring virtual machine backups.
■ The NetBackup Recovery Wizard is for recovery of an entire virtual machine,
not for recovery of individual files. To recover individual files from the virtual
machine backup, use the NetBackup Backup, Archive, and Restore interface.
Or use the plug-in's Instant Recovery Wizard to boot the virtual machine
instantly and access the files.
See also: "About restore of individual files" and "Restoring individual files" in the
NetBackup for VMware Administrator's Guide.
■ The recovery wizards do not support recovery of vCloud Director backup images.
To recover virtual machines into vCloud Director, use the NetBackup Backup,
Archive, and Restore interface.
See the "Use NetBackup for vCloud Director" chapter in the NetBackup for
VMware Administrator's Guide.
■ You can also perform VM recovery and instant recovery using the nbrestorevm
command. For more information, refer to the NetBackup for VMware
Administrator's Guide and the NetBackup Commands Reference Guide.
Table 7-1 How to start the NetBackup recovery wizard in vSphere Client
Action Description
1 In the vSphere Client left pane (or in the Menu), click Veritas
NetBackup.
Log-in Login page appears if you are not already logged in.
Restoring virtual machines 56
How to access the NetBackup Recovery Wizard
Table 7-1 How to start the NetBackup recovery wizard in vSphere Client
(continued)
Action Description
Table 7-1 How to start the NetBackup recovery wizard in vSphere Client
(continued)
Action Description
In the Virtual Machines pane (or in the left pane), right-click on the
VM to restore and click Veritas NetBackup > Recover.
■ Select the appropriate date and time range and click SEARCH RECOVERY
POINTS.
■ From the Recovery Points, select Virtual machine recovery and click
Next. See “Recovery points screen” on page 59.
Note: You can restore the virtual machine to its original location or to a
different location.
Note: Click CHANGE in front of receptive field to change the default value.
4 On the Recovery Options tab, select all the applicable options. See “Recovery
options screen” on page 60.
5 On the Pre-Recovery Check tab, review all the parameters. Click RUN
PRE-RECOVERY CHECK.
6 Once the pre-recovery check is successful, click START RECOVERY.
7 Click OK for Recovery Job Initiated dialog.
Note: The Recovery Wizard is dismissed when you click on the side navigation or
header, and any entries cannot be saved. Click Acknowledge to continue.
Restoring virtual machines 59
Restore virtual machine
Field Description
VMware server Shows the VMware server where the plug-in is installed.
Note: Use the drop-down list to select the VMware server where the VM resided when it
was backed up.
Note: If the plug-in is not authorized to restore VMs, this field is empty.
SEARCH Enter the name (or portion of the name) of the virtual machine that you want to restore, and
click Search.
Note: This field is case-sensitive.
The NetBackup primary server identifies each VM in the backup policy as a "client." In the
search results, the NetBackup Client Name column displays that name.
Field Description
Search Recovery Use the From and To date and time fields to choose a date range, then click SEARCH
Points RECOVERY POINTS.
Recovery Points Lists the recovery points that fall within the search dates. Select a recovery point. Instant
Recovery option will be enabled if and only if the recovery point is ready for instant recovery.
Virtual Machine Select the Virtual Machine Recovery option to restore a virtual machine from its NetBackup
Recovery recovery point. You can restore the virtual machine to its original location or to a different
location.
Restoring virtual machines 60
Restore virtual machine
Field Description
Instant Virtual Select the Instant Virtual Machine Recovery option to instantly restore virtual machine backup
machine Recovery recovery point.
Table 7-4
Field Description
ESXi server or cluster The selected ESXi server or cluster name. Click Change to select different value for this
field.
Resource pool or vApp The selected resource pool server or cluster name. Click Change to select different value
for this field.
Data store or Data The selected datastore server. Click Change to select different value for this field.
store cluster
Field Description
Advanced options
Field Description
Remove original To remove original network associated with the backed up VM.
network configuration
Format of restored Select Provision for backed up VMs virtual disks. Options available are:
virtual disks
■ Original provisioning
■ Thick provisioning lazy zeroed
■ Thick provisioning eager zeroed
■ Thin provisioning
Transport mode Select transport mode from backup or from below options:
Field Description
Field Description
Note: You can restore the virtual machine to its original location or to a
different location.
Note: Click CHANGE in front of receptive field to change the default value.
4 On the Recovery Options tab, select all the applicable options. See “Instant
Recovery: Recovery Options” on page 63.
Restoring virtual machines 63
Perform Instant Recovery of virtual machines
5 On the Pre-Recovery Check tab, review all the parameters. Click RUN
PRE-RECOVERY CHECK.
6 Once the pre-recovery check is successful, click START RECOVERY.
7 Click OK for Recovery Job Initiated dialog.
Note: The Recovery Wizard is dismissed when you click on the side navigation or
header, and the entries are not saved. Click Acknowledge to continue.
Operations Description
vCenter Server Shows the vCenter server where the plug-in is installed.
Note: Use the drop-down list to select the vCenter server where the VM resided when
it was backed up.
SEARCH Type the name or portion of the name of the virtual machine that you want to restore,
and click SEARCH.
The NetBackup primary server identifies each VM in the backup policy as a client. In
the search results, the NetBackup Client Name column displays that name.
The results of the search appear under Search results. Select the virtual machines
and add them to restore and then click Next.
Click Next to select the backup images for instant recovery.
Table 7-7 Fields in the Instant recovery virtual machine selection screen
Field Description
Remove original network Removes the existing network settings of all the selected VMs after the recovery.
Remove tag associations NetBackup does not restore any tag associations from the backup.
Retain original hardware NetBackup restores the virtual machine with its original hardware version (such as 4). It
version retains the original version even if the target ESXi server by default uses a later hardware
version (such as 7 or 8).
If this option is not selected, the restored virtual machine is converted to the default
hardware version that the ESXi server uses.
Field Description
Initiate Instant Use this option to complete the instant recovery operation after you have performed the Storage
Recovery Done vMotion of the virtual machines to a different datastore. This option completes the virtual machine
instant recovery operation after the vMotion migration of the virtual machine is completed.
When the datastore is removed, its resources are released on the NetBackup media server.
Deactivate Use this option when you are done with the restore and do not intend to retain the restored
virtual machine. This action removes the virtual machine from the ESX host. If no other virtual
machine uses the NetBackup datastore, this option removes that datastore and releases its
resources on the NetBackup media server.
Restoring virtual machines 66
Instant Recovery: Cleaning the recovery environment and releasing the NetBackup resources
Field Description
Reactivate Use this option when the connection to the virtual machine was interrupted. The interruption
may occur due to a network disconnect between the NetBackup media and the ESX server.
This option reactivates a restored virtual machine by remounting the NetBackup datastore. It
also registers the restored virtual machines on the ESX host.
■ A NetBackup primary server is not available in the primary server list of the login
screen
■ The NetBackup plug-in for vSphere Client (HTML5) does not find any backup
images in the listed events
■ Mismatch in vCenter server name (uppercase vs. lowercase letters) causes the
VMware connectivity test to fail
■ Instant recovery operation is not complete due to NFS mount limit exceed
■ Virtual machine display name conflicts are not shown before the pre-recovery
check
■ Too much time taken to populate the list of NetBackup primary servers
■ The NetBackup plug-in is not shown in the vSphere Client (HTML5) interface
even after registration
■ 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
Note: When the VMware connectivity test fails because of a vCenter name mismatch
regarding its case, the failure can be ignored. Click Finish and the VM recovery
should succeed.
Troubleshooting 69
Instant recovery operation is not complete due to NFS mount limit exceed
To prevent the VMware connectivity test from failing, delete the NetBackup credential
for the vCenter and re-enter the credential with the correct case. For instructions
on how to add credentials, see "Adding NetBackup credentials for VMware" in the
NetBackup for VMware Administrator's Guide. Alternatively, you can edit the name
of the vCenter server in vSphere Client to match the credentials that were entered
in the NetBackup primary server.
■ Does not support a virtual machine that had disks that were excluded from the
backup. The policy Virtual disk selection option must be set to include all disks.
■ Does not support a virtual machine that has a disk in raw device mapping mode
(RDM) or that has a disk in Persistent mode.
■ Supports the following policy schedule types: Full backups, and the incremental
backups that include the Use Accelerator option with a disk-based storage unit.
Incremental backups without the Use Accelerator policy option are not
supported.
■ Does not support virtual machine templates.
Contact a NetBackup administrator to check the backup details.
Troubleshooting 70
The vCenter server names are not available for search
Table 8-1 Reasons for the NetBackup plug-in not appearing in the vSphere
Client
The NetBackup plug-in does not Messages similar to the following may appear in the vsphere_client_virgo
support the vCenter version. .log file:
For a list of supported vCenter versions for the plug-in, see the following document:
http://www.veritas.com/docs/000006177
You have not used the default In this case, the default vCenter configuration does not allow the plug-in to be
URL for the plug-in ZIP-file downloaded and deployed. Messages similar to the following may appear in the
download (securely hosted by VMware vsphere_client_virgo.log file:
the NetBackup primary server).
The plugin package download was blocked because the URL
Instead, your plug-in download is not secure. To allow http URLs add allowHttp=true to
URL uses the HTTP protocol webclient.properties
(http://) rather than the secure
HTTPS protocol (https://). See the procedure To allow installation of the plug-in over an HTTP URL.
Troubleshooting 73
The NetBackup plug-in is not shown in the vSphere Client (HTML5) interface even after registration
Table 8-1 Reasons for the NetBackup plug-in not appearing in the vSphere
Client (continued)
For assistance with the command line or vSphere Client, see the VMware article
"How to stop, start, or restart vCenter Server 6.x services (2109881)":
https://kb.vmware.com/kb/2109881
a. On a vCenter appliance, remove the directories or files that the following find
command returns:
b. On a Windows vCenter, remove the directories or files that the following dir
commands return:
dir "%programdata%\*netbackup*" /s /a /b
dir "%programfiles%\*netbackup*" /s /a /b
Note: This example uses a port number of 8443. The port number on the primary
server however may be different.
See “Installing the NetBackup plug-in for vSphere Client (HTML5)” on page 16.
Troubleshooting 75
Unregistering the plug-in may result in total uninstallation of the plug-in
is not available.
Troubleshooting 76
No recovery point found error
■ Limitations
Limitations
■ Recovery and discovery of VMs created by VMware templates is not supported
by the remote plug-in.
■ The vwcp_manage utility only supports NetBackup primary servers and does
not support the media server. If you try to register the media server with the
vwcp_manage utility either in UI mode or in CLI mode, then you may get console
or UI error pop-up as Null.
■ Currently the application can provide monitoring details for up to 500 VMs and
up to 200 thousand events data records. Beyond this, any increase in #VM
and/or #events data records, would make the application unstable.
The following table provides the time taken by the monitoring page to fetch data,
when the user has clicked on the mentioned level in the tree (root/ESX/resource
pool etc.)
Table 9-1
Number of VMs Root level in ESX/Host level in Resource pool
minutes minutes level in minutes
Event ID Description