Defining Filters for Content
Filters can be configured to exclude virtual machines or virtual machine disks from backups. You can define filters on a subclient (only applies to that subclient) or on a backup set (applies to all subclients under the backup set).
You can also filter a list of VMs as described in Filtering a List of VMs.
About This Task
For each subclient under a backup set, the filtering specified for the backup set is combined with the filtering for the subclient to determine which content is excluded from backups. Any filtering defined in a backup set can also be viewed in the subclients under the backup set when the Show Backupset Filters option is selected. (Backup set filters are applied even when filtering is not displayed in subclients.)
You can use wildcard characters when adding a pattern to define a rule.
- If a virtual machine is explicitly added to the content of a subclient, the virtual machine will be discovered by its GUID. If the display name changes later, the machine is still included in the subclient as long as its GUID remains the same. Any virtual machines identified in a subclient and discovered by their GUIDs will not be filtered from backups.
- For subclients that are upgraded from Commvault Version 9 and have virtual machines or disks marked using the Do Not Backup option, those items are automatically added to the filters for subclients and backup sets.
- Disk filtering is supported only for streaming backups, not for IntelliSnap or backup copies. If IntelliSnap is enabled for any subclients, disk filtering is disabled for the backup set.
- During backups, the VMX configuration file for a VM is used for VM discovery and backup processing. If you filter a datastore or datastore cluster, any VMX files and disk files that reside on a filtered datastore or cluster are not included in backups. For example:
- If the VMX file and disk files for a VM are on a filtered datastore or cluster, the VM and its disks are not backed up.
- If the VMX file resides on a datastore that is not filtered, the VM is backed up but any disk files that are on a filtered datastore are not backed up.
- If the VMX file resides on a datastore that is filtered, the VM is not included for backup. Any disk files for that VM are also not included in backups, even if they reside on a datastore that is not filtered.
With vSphere 5.5 and later, you can identify virtual machines based on vSphere tags and categories. When you browse and select a tag or category, or when you add a rule that identifies a tag or category, you can automatically discover and select all virtual machines under any VMware entities that are marked with that tag or category.
When Commvault Service Pack 8 or later is used with vSphere 6.5, tag support is included.
Note: To use tags with supported versions of vSphere from 5.5 through 6.0, you must install one of the following versions of PowerCLI on the VSA proxy:
- 6.0 Release 2 - Build no 3056836
- 6.3 Release 1 - Build no 3737840
Use a PowerCLI version that is compatible with your vSphere version.
The following tags are supported:
- Datastore Cluster
- Resource Pool
- Virtual Machine
The following tags are not supported:
- Distributed Port Group
- Distributed Switch
- Library Item
- From the CommCell Browser, navigate to Client Computers > virtualization_client > Virtual Server > VMware > backup_set.
- Right-click the backup set or subclient, and then select Properties.
- Click the Filters tab.
- In the VM Filters area, browse or define a rule to add filters for virtual machines:
- To browse for an object:
- Click Browse.
- Select a view from the list in the top left of the Browse dialog box:
- Hosts and Clusters: Select a cluster, host, datacenter, or resource pool.
- Datastores and Datastore Clusters: Select a datastore or datastore cluster.
- VMs and Templates: Select a virtual machine, datacenter, VM folder, or vApp.
- Tags and Categories: Select a tag or category to identify all virtual machines under VMware entities that are marked with the tag or category.
- To define a rule:
- Click Add.
- In the Rule Group box, select the filter type from the drop-down list and enter the appropriate information in the box on the right:
VM Name/Pattern Enter the display name of the virtual machine or a pattern using wildcards (for example, Test* to identify VMs for which the VM name begins with "Test"). You can also click ... to browse for a VM. Host Enter the host name as it appears in vCenter, the IP address of the host, or a host name pattern using wildcards. You can also click ... to browse for a host. When you filter a host, all child objects for the host (such as datastores, resource pools, and virtual machines) are automatically excluded from backups. Datastore Enter the datastore name or a pattern. You can also click ... to browse for a datastore. Guest OS Enter the exact name of the operating system or a pattern to identify an operating system group. For example, enter Microsoft* to identify any virtual machine that has a version of the Windows operating system, *windows2012r2 to filter Windows 2012 R2 machines, or *linux* to filter all Linux machines. Guest DNS Hostname Enter a hostname or a pattern to identify a hostname or domain (for example, myhost.mycompany.com to identify a specific host or *mycompany.com to identify all hosts on that domain).
Only virtual machines that have VMware Tools installed can be filtered by Guest DNS Hostname.
Power State Select the power on status of virtual machines to be filtered. You can select one of the following options:
- Powered On - to identify VMs that are powered on.
- Powered Off - to identify VMs that are powered off.
- Other - to identify VMs with a different power on status, such as Suspended.
Notes Enter a pattern to identify virtual machines based on notes text contained in vCenter annotations for the VM summary (for example, Test* to identify VMs with a note that begins with "Test"). Custom Attribute Enter a pattern to identify virtual machines based on custom attributes in vCenter annotations for the VM summary. You can enter search values for the names and values of custom attributes. For example:
- Name Contains *resize* to identify VMs where the name of a custom attribute contains the word "resize").
- Value Contains *128* to identify VMs where the value of a custom attribute contains the number "128").
Tags and Categories Select a tag or category to identify all virtual machines under VMware entities that are marked with that tag or category.
- Click + and repeat this step to include additional rules. If you define multiple rules, you can indicate whether virtual machines are selected when they match all of the rules, or when they match any of the rules. For rule groups that include Power State, Notes, or Custom Attribute rules, you can only select virtual machines that match all of the rules.
- Click OK.
The rules you defined and the objects you selected appear in the VM Filters area on the Filters tab.
- To browse for an object:
- Add filters for virtual machine disks:
- In the VM Disk Filters area, click Add.
- On the Add Disk Filter dialog, select an option from the list and provide a value:
Virtual Device Node Select a device node from the list. Datastore Click ... to browse, select a datastore, and click OK. All disks on that datastore will be filtered. VMDK Name/Pattern Enter a pattern for the names of disks to filter (for example, VMName.vmdk, *VMName.vmdk, /**/folder/VM*.vmdk, or [Datastore]*/VM*.vmdk).
Letters entered as part of a disk name pattern are case sensitive.
Hard Disk # Select the first and last numbers for the range of hard disk labels to filter. For example, hard disk 1 would map internally to scsi(0:0).
Consider the following before filtering disks based on a disk number:
- You cannot filter by disk number if the vCenter is non-English.
- When you add disks to a virtual machine, a SCSI ID is assigned to the disk automatically, and the SCSI ID can match a disk number that you have filtered. Do not use this filtering criteria if you add new disks to virtual machines frequently.
- Click OK to add the filter.
- To verify the list of virtual machines that are selected for backup, click Preview on the subclient properties Content tab. The Preview display includes an Add to Filters button that you can click to add selected virtual machines to filters.
- Click OK to save the properties.