NetVault Plug-in for VMware 12.1


	IMPORTANT: The plug-in applies the inclusion and exclusion patterns to the virtual machines that you select. During a backup job, the plug-in accesses the virtual machines that you selected, applies the inclusion pattern to the selected machines, and then applies the exclusion pattern to the remaining selected machines.

To add patterns:

In the Navigation pane, click Create Backup Job.

Next to the Selections list, click Create New.

In the list of plug-ins on the NetVault Backup Selections page, open VMware plugin.

Below the My Virtual Environment node, the plug-in displays two additional nodes, Inclusion List and Exclusion List. These nodes provide two options, Open and Add VM pattern. As you add patterns, the plug-in displays an informational node for each saved pattern.

To add a pattern that you want to include in a backup, right-click Inclusion List, and select Add VM pattern.

In the Enter Pattern dialog box, type the pattern that you want the plug-in to search for.

Use the asterisk (*) wildcard character as part of the pattern to search for. For example, if you want the plug-in to locate all VMs that start with SQL, type SQL*. Be aware that the inclusion and exclusion features do not support the use of spaces at the beginning or end of a virtual machine name pattern.


	NOTE: If you do not specify an inclusion pattern but you do specify an exclusion pattern, the plug-in applies the exclusion pattern to the selected list of virtual machines. If a virtual machine meets both the inclusion and exclusion patterns, it is excluded from the backup job.

To save the pattern, click OK.

Repeat Step 4 through Step 6 for each pattern that you want to add for inclusion.

To add a pattern that you want to exclude from a backup, right-click Exclusion List, and select Add VM pattern.

In the Enter Pattern dialog box, type the pattern that you want the plug-in to search for using the same guidelines described previously for include patterns, and then click OK.

Continuing with the previous example, if you want the plug-in to locate all VMs that start with SQL but exclude specific versions of the SQL Server VMs, type the complete name of the virtual machine that you want to exclude, such as SQLQATest1.

Repeat Step 8 and Step 9 for each pattern that you want to add for exclusion.

When you are finished, select all required VMs under the My Virtual Environment node, and then select the applicable inclusion and exclusion patterns.

Click Save, enter a name in the Create New Set dialog box, and click Save.

The name can contain alphanumeric and nonalphanumeric characters, but it cannot contain non-Latin characters. On Windows, there is no length restriction. However, a maximum of 40 characters is recommended on all platforms.

Performing image-level backups

In the Navigation pane, click Create Backup Job to start the configuration wizard.

— or —

In the Navigation pane, click Guided Configuration, and then on the NetVault Configuration Wizard page, click Create Backup Jobs.

In Job Name, specify a name for the job.

Assign a descriptive name that lets you easily identify the job for monitoring its progress or restoring data. A job name can contain alphanumeric and nonalphanumeric characters, but it cannot contain non-Latin characters. There is no length restriction. However, a maximum of 40 characters is recommended on all platforms.

In the Selections list, select an existing Backup Selection Set, or complete the following steps to create a set:

To open the NetVault Backup Selections page, click Create New.

Open the NetVault Backup Client on which the plug-in is installed, and then open VMware Plugin.

Open the applicable VMware ESXi or VMware vCenter Server.

Depending on your VMware setup and inventory view type, open the applicable container nodes.


	NOTE: To switch between the two views (Hosts and Clusters and VMs and Templates), click the ESXi or vCenter Server, and select Toggle Inventory View from the context menu. This option is only available when server node is open.

Select the data that you want to back up:

•

Back up all virtual machines within a container: Select the container node. Data selection is possible at all levels, starting from the Datacenter node. For example, to back up all virtual machines hosted on an ESXi server, select the host node; in the VMs and Templates view, select the corresponding folder node.

•

Back up individual virtual machines: Open the applicable container nodes, for example, Datacenter, Cluster, and Resource Pool, and select the virtual machines that you want to back up. In the VMs and Templates view, open the folder node, and select the virtual machines that you want to back up.

You can also select the container node, and then clear the check marks for the virtual machines that you do not want to back up.

•

Back up individual virtual drives: Open the virtual machine node, and select the disks that you want to back up. The virtual drives are named “Hard Disk 1,” “Hard Disk 2,” … “Hard Disk n.” The plug-in only lists those disks for which it can generate a snapshot.

You can also select the container node — for example, Datacenter, Resource Pool, ESXi Server, or folder — or the individual virtual machines, and specify the disk type — system or data — in the Backup Options Set. For more information about this setting, see Virtual machine disk selection options.

The virtual machine configuration files, “.nvram”, and log files are always backed up whether you select the entire virtual machine or its individual disks.

Click Save, and in the Create New Set dialog box, type a name for the set.

A set name can contain alphanumeric and nonalphanumeric characters, but it cannot contain non-Latin characters. On Linux OS, the names can have a maximum of 200 characters. On Windows OS, there is no length restriction. However, a maximum of 40 characters is recommended on all platforms.

To close the dialog box, click Save.

In the Plugin Options list, select an existing Backup Options Set, or complete the following steps to create a set:


	IMPORTANT: On Windows, when you create a Backup Options Set for image‑level backups, you must use the default set “Default Backup Options — VMware Plugin — Windows” as the template. If you use any other set as the template, the backup may fail.

To open the VMware Plugin Backup Options page, click Create New.

Under Backup Type, select one of the following options.


Option	Description
Full	To back up all allocated sectors on a virtual drive, select this option.
Incremental	To back up disk sectors that have changed since the last Full, Differential, or Incremental Backup, select this option.
Differential	To back up disk sectors that have changed since the last Full Backup, select this option.

For more information about image-level backup types, see Image-level backups.


	IMPORTANT: After reverting to a snapshot that is older than its last Incremental Backup, you must perform a Full Backup of that virtual machine before performing Incremental Backups again. If you perform an Incremental Backup, the job reports a filefault error and fails. For more information, see http://kb.vmware.com/kb/1021607.

Under VM disk selection options, select one of the following options.

The disk selection option is applied to all virtual machines that you have selected explicitly by selecting the corresponding nodes or implicitly by selecting the container node — for example, ESXi Server, Resource Pool, Datacenter, or folder. This option is not applied to virtual machines for which you have explicitly selected one or more virtual drives in the selections tree.

Table 4. Virtual machine disk selection options
Option	Description
Back up all disks	To back up all available virtual drives for the selected virtual machines, use this option. NOTE: The plug-in only backs up those disks for which it can generate a snapshot.
Exclude boot disk	To back up only the data disks and exclude the boot disks for the selected virtual machines, use this option.
Exclude data disks	To back up only the boot disk and exclude the data disks for the selected virtual machines, use this option. NOTE: To identify the boot disks, the plug-in only considers the active partitions on the MBR disk. Moreover, the plug-in only considers the first disk that meets the active boot partition criteria as the boot disk. The plug-in does not handle machines with multiple operating systems.

Under Other Options, configure the following settings:

Option

Description

Enable Change Block Tracking for VM

By default, CBT is disabled for a virtual machine. If you want to perform Incremental or Differential Backups of virtual machines, you must enable CBT for the Full Backup that serves as the base backup for subsequent Incremental and Differential Backups.

To enable CBT on all virtual machines included in the backup job, select this check box. (You can also enable CBT on specific virtual machines by using the Enable Change Block Tracking method. For more information, see Enabling CBT on individual virtual machines.)

If you select this check box and the plug-in fails to change this setting on a virtual machine, a warning message is logged.

If you do not select this check box, the plug-in does not change the CBT setting on the virtual machines during backups. Depending on whether CBT is enabled or disabled, the plug-in uses the appropriate backup method (CBT-based Full, Incremental, or Differential or non-CBT Full Backup) to back up the virtual machines.

Note the following:

•

To create the first Full Backup of a virtual machine with Changed Block Tracking enabled, the target virtual machine must be turned off to enable CBT. For more information, see http://kb.vmware.com/kb/1031873.

The virtual machine can be restarted when the backup job starts transferring data. During subsequent Full, Incremental, or Differential Backups, the virtual machine can remain turned on.

•

At the time of enabling CBT, no snapshots should exist on the target virtual machine. For more information, see http://kb.vmware.com/kb/1033816.

•

After you enable CBT for a virtual machine, all subsequent Full, Incremental, and Differential Backups are performed as CBT-based backups for that virtual machine. You do not have to select this option for each job.

To stop using CBT, you must disable this feature. For more information, see Disabling CBT on a virtual machine or Manually disabling CBT on a virtual machine.

Perform File Level Indexing

To generate file-level indexes for all supported volumes that are included in the backup snapshot, select this option. File-level indexing lets you restore individual files and directories from Full, Incremental, and Differential image-level backups of virtual machines. For more information on how file-level indexing affects backups, see Configuring default settings.

If you selected an existing Backup Selection Set that was created using a version of the plug-in before 11.4.5, this option reflects the setting that you chose when you created the set. Before 11.4.5, this option was selected by default. If you want to use the new default setting, which clears this selection, you must browse the plug-in once on the NetVault Backup Selections window.

To do so, complete the following steps:

Click Create Backup Job.

Next to the Selections list, click Create New.

Open the NetVault Backup Client on which the plug-in is installed.

Click VMware Plugin, and select Open from the context menu.

This process automatically updates the setting to the default setting, which clears the selection.

Click Cancel.

Enable Active Block Mapping

ABM technology provides filters to remove unused blocks during backups. Removing the unused blocks reduces the backup size and the amount of data transferred over the network. You can use ABM with CBT to back up only active and changed blocks during Incremental and Differential Backups.

ABM is supported on the NTFS file system on basic disks and EXT file systems. ABM is not supported with XFS.

ABM is disabled by default. Selecting this check box enables ABM, which allows the plug-in to back up only those sections of the virtual drives that are active. ABM scans the disk and detects inactive blocks; these blocks are then omitted during backups.

NOTE: ABM also removes deleted data. When you restore a virtual machine that was backed up using ABM, you cannot perform undelete operations for that virtual machine. Without Active Block Mapping, CBT includes the deleted blocks.

If a backup job includes any unsupported disk types, this option is ignored for those disks.

Remove snapshots from previous backups

When you run a backup job, the plug-in creates a snapshot named “BKB_SNAP” on the virtual machine to back up the selected data. Regardless of whether the backup completes successfully or fails, the plug‑in removes the snapshot on job completion. The plug-in also removes the snapshot if the job is stopped or the parent or child processes are terminated for any reason. However, if a job exits abnormally, the cleanup process may fail to remove the snapshot. To address such cases, the plug‑in provides an option to delete the snapshot when you run the job next time.

You can select the Remove snapshots from previous backups check box to remove any existing snapshots when you run the current job. Only the snapshots named “BKB_SNAP” are removed from the virtual machines. This option does not remove any other snapshots that exist on the virtual machine.

Maximum Number of Parallel Streams

By default, the plug-in generates a single data stream for a backup job, and backs up the selected virtual machines in a sequential manner. To increase throughput and reduce overall backup time for image-level backups, you can configure the plug-in to perform parallel backups of multiple virtual machines.

This setting determines the maximum number of parallel data streams that can be generated for an image-level backup job. For example, if 10 virtual machines are included in a job, and you set this parameter to four, the plug-in tries to back up four virtual machines in parallel.

The actual number of parallel streams for a job depends on the following factors:

•

The number of backup devices or streams available to the backup job. For example, if you set this parameter to 4 and only two tape drives are available or a NetVault SmartDisk can only support two concurrent streams, the plug-in only processes two virtual machines concurrently.

•

The number of virtual machines included in the job. For example, if you set this parameter to 4, and the number of virtual machines selected for backup is 3, the plug-in creates only three data streams.

For parallel backups, the plug-in generates a parent process that coordinates the overall backup and individual child processes that perform the actual task of backing up the virtual machines. The maximum child processes that can be generated for a backup job is equal to the Maximum Number of Parallel Streams configured for the job. The parent and the child processes are all created on the NetVault Backup Client on which the plug-in is running.

When a child process acquires a backup device and creates a backup stream, it is assigned a task to back up a virtual machine. After the task completes, the process is assigned the next task if there are any more virtual machines to be backed up. Each task is assigned a Task ID. A snapshot is generated only when a virtual machine is assigned to a child process.

When configuring Maximum Number of Parallel Streams, consider the following:

•

Verify that the value configured for this option does not exceed the number of backup devices or streams accessible to a job.

If the available devices are insufficient, more than one child process may try to access and write to the same device, causing significant increase in the overall backup time.

•

The load of running multiple processes on a NetVault Backup Client can have a negative impact on performance.

•

The load of backing up multiple virtual machines from the same datastore can increase the I/O activity on the datastore.

•

The load of backing up multiple virtual machines that are managed by the same ESXi Server can increase the load on the host if you are using the LAN Transport mode (nbd/nbdssl) for data transfer.

NOTE: Only a single child process is used to back up the multiple disks of a virtual machine even if more data streams are available. The child process creates a snapshot of the whole virtual machine and retains the snapshot until the job completes regardless of whether the whole virtual machine or its individual disks are backed up.

Automatic diagnose virtual machine on backup failure

To run predefined tests that can identify the cause of a virtual machine backup failure, select this check box.

For more information about the Diagnose method, see Diagnosing virtual machine issues.

You can access the Diagnostic Results dialog box from the View Logs page. The details are stored as log context objects.

Enable Restartable backups

This option allows you to restart a job that completes with some failed virtual machines. The restarted instance backs up only those virtual machines that failed previously; virtual machines that are backed up successfully are not included in the restarted instance.

When a restartable backup completes with some failed virtual machines, the plug-in generates a backup index for the completed virtual machines and sets the job status to Job Stopped. The log messages and log context show which virtual machines have failed for the job. When you restart the job later, the plug-in runs an Incremental Backup job to back up the failed virtual machines.

You can restart a job from the Job Status page. For more information about this method, see Restarting a backup job. A restarted instance does not back up virtual machines that are added to the host after the initial job is run.

NOTE: If all virtual machines fail for a job, the job status is set to Backup Failed. You cannot restart a failed backup job.

Disable distribution of backup job to other VMware Backup Proxy

If you configured your environment to use the Distributed Jobs feature, select this check box to turn off the feature for a specific job. This option is disabled by default.

Enable Job Level Transport Mode

If you are using the Distributed Jobs feature and you want to set the transport mode manually at the job level, select this option, and then select the applicable Primary Transport Mode and Fallback Transport Mode.

Click Save, and in the Create New Set dialog box, type a name for the set.

To close the dialog box, click Save.

Select or create the Schedule Set, Target Set, and Advanced Options Set.

For more information about these sets, see the Quest NetVault Backup Administrator’s Guide.


	NOTE: When performing multistream backups, do not select the Ensure backup is the first on the target media check box. If you select this check box for multistream backups, each data stream targets a separate piece of media to exist as the first backup on the media item. Thus, if a backup generates five streams, the job tries to obtain five blank or new media items. This option does not apply to disk-based storage devices.

To submit the job for scheduling, click Save & Submit.

To save the job definition without scheduling it, click Save. You can view, edit, or run this job from the Manage Job Definitions page. This job is not displayed on the Job Status page until you submit it.

You can monitor the job progress from the Job Status page and view the logs from the View Logs page.

For more information about Job Status, View Logs, and Manage Job Definitions, see the Quest NetVault Backup Administrator’s Guide.

Additional notes

•

When you select a container node (for example, Datacenter, Resource Pool, or ESXi Server), any new virtual machine that is added to the host after a job has been defined is automatically included in the backup. Similarly, when you remove a virtual machine from the host, it is automatically excluded from the backup. You do not have to modify the job definition each time a virtual machine is added to or removed from the host.

•

If a selected virtual machine is moved to a different host using Storage vMotion after a backup job has been defined, it is backed up as part of that job only if the following requirements are met:

•

A vCenter Server has been added to the plug-in, and the access to the virtual machine is being authenticated through the vCenter Server.

•

The ESXi Server Host to which the selected virtual machine has been moved to is also controlled by the same vCenter Server.

If these requirements are not met, the plug-in fails to back up the virtual machine that has been moved.

•

When backing up virtual machines that are protected using VMware vSphere Fault Tolerance (vSphere FT), note the following:

•

The vSphere FT group must be managed under a vCenter Server by VMware ESXi hosts that use version 6.0 build number 4192238 or later.

•

You can only select the primary virtual machines in an FT group for backups. The plug-in does not let you select the secondary virtual machines.

•

The plug-in displays the primary virtual machine in an FT group for selection only when they are protected using vSphere FT. If the virtual machine is protected using legacy fault tolerance, you cannot select it.

•

For container-level selections, only primary virtual machines in an FT group are backed up

•

Secondary virtual machines are excluded from the backup. If one is encountered, the plug-in generates the following log message:

Virtual machine ‘<VM_name>’ with secondary role
in its fault tolerance group will not be backed up.

•

Primary virtual machines using Legacy FT are also not backed up. If one is encountered, the plug-in generates the following log message and completes with a Warning: Cannot back up virtual machine while legacy fault tolerance is enabled.

•

If a backup job includes an FT machine and a failover occurs, the job automatically protects the new primary virtual machine the next time the job runs.

•

If a failover occurs while a backup job is running, the backup job might fail because the backup snapshot cannot be created. VADP prevents the creation of snapshots during failover of a virtual machine with fault tolerance enabled. The log displays the following message:

Task to create VM snapshot failed with reason
'The operation is not allowed in the current state.'

If this issue occurs, run the backup job again after the failover process is finished.

•

Because VMware does not support CBT for virtual machines with FT enabled, all sectors on the disks are always backed up for such a virtual machine even if Enable Change Block Tracking for VM is selected. This behavior is true for both Full and Incremental Backup jobs.

•

When you restore a virtual machine that had FT enabled, the plug-in does not configure FT for the machine after recovery. You must enable FT on the restored machine after recovery is completed. The plug-in generates the following log message and completes the restore job with a Warning: Fault tolerance was configured for the virtual machine at backup time; to continue using the feature, please re-configure it after recovery.

•

VMware does not support file-level mounting for virtual machines with FT enabled.

•

Although the plug-in does not support file-level (.vmdk) restores of virtual machines that have FT enabled, you can restore files at the guest filesystem level.

•

You can select virtual machines that are part of a Virtual Application (vApp) along with the other virtual machines. Currently, the selection tree does not provide any indicators to distinguish between such virtual machines from other virtual machines that are not part of a vApp.

If you select a vApp node, only the virtual machines contained in the vApp are backed up. The metadata for the vApp is not included in the backup.

•

If you add a new virtual machine to the Backup Selection Set — or to an ESXi Server that is included in the Backup Selection Set — after the initial Full Backup or any subsequent Incremental or Differential Backup, the plug-in does the following:

•

Creates a Full Backup of the new virtual machine if you run Incremental or Differential Backup.

•

Creates a non-CBT Full Backup, unless CBT is already enabled for the virtual machine or you have selected the Enable Change Block Tracking for VM check box for the Incremental or Differential Backup.

•

Runs subsequent Incremental Backups of the new virtual machine as Incremental if CBT is enabled and a CBT-based Full Backup has been performed for the virtual machine.

•

Runs subsequent Differential Backups of the new virtual machine as Full Backups because these backups are based on the last Full Backup created for that Backup Selection Set.

Example:

Select any one virtual machine, for example, MyVM1, and create a Backup Selection Set, for example, MySelectionSet.

Perform a CBT-enabled Full Backup using MySelectionSet.

Modify MySelectionSet, and add a virtual machine, for example, MyVM2.

Perform CBT-enabled Incremental and Differential Backup using MySelectionSet.

Perform another CBT-enabled Incremental and Differential Backup using MySelectionSet.

Result:

•

When you select Incremental Backup, the plug-in creates a Full Backup of MyVM2 in Step 4 and an Incremental Backup of that virtual machine in Step 5.

•

When you select Differential Backup, the plug-in creates a Full Backup of MyVM2 in Step 4 and Step 5 because these backups are based on the last Full Backup created in Step 2.

•

When using CBT for backups, virtual machine migration using Storage vMotion or VMware vSphere Storage DRS is not recommended. For more information, see http://kb.vmware.com/kb/2048201.

•

If you perform a Full Backup of a Thick Provisioned Lazy Zeroed disk without enabling CBT, the empty sectors are converted to actual zeros during backup. When you restore the backup, the disk type is changed to Eager Zeroed.

•

After backing up the data, the plug-in writes the backup index to the NetVault Database. If an error occurs during this step, for example, if there is a file transfer error or the server runs out of disk space, the plug-in reports the following error:

Log message: Failed to write index of backup to the database.

Log context: The index for this backup may be retrieved and added to the database by scanning the backup media.

In such cases, you can scan the backup media to recover the index. However, before importing the index, you must review the log messages to verify that no other errors were reported during the backup.

Backup selection tree icons

Table 5. Backup selection tree icons
Icon	Description
	vCenter Server
	Datacenter Server
	ESXi Server Cluster
	Closed folder
	Open folder
	ESXi Server
	ESXi Server in maintenance mode
	Inaccessible ESXi Server
	Virtual Appliance (vApp)
	Resource pool
	Virtual machine (turned on)
	Inaccessible virtual machine
	Mounted virtual machine
	Suspended virtual machine
	Turned off virtual machine
	Virtual machine (turned on, CBT enabled)
	Inaccessible virtual machine (CBT enabled)
	Mounted virtual machine (CBT enabled)
	Suspended virtual machine (CBT enabled)
	Turned off virtual machine (CBT enabled)
	Primary virtual machine (turned on) in a Fault Tolerant group
	Inaccessible primary virtual machine
	Suspended primary virtual machine
	Turned off primary virtual machine
	Secondary virtual machine in a Fault Tolerant group
	Inaccessible secondary virtual machine
	Suspended secondary virtual machine
	Turned off secondary virtual machine