Examples for the NetBackup Query Builder
The following table provides example query rules.
To use the Query Builder, you must click on the Client tab.
Another topic is available on the difference between AND and OR in a query.
Since the available Query Builder keywords depend on the Server Type that is selected on the policy Clients tab, the following examples are in two groups:
Table: Query Builder examples for server type Hyper-V Standalone/Cluster provides examples for server type Hyper-V Standalone/Cluster.
Table: Query Builder examples for server type System Center Virtual Machine Manager provides examples for server type System Center Virtual Machine Manager.
Table: Query Builder examples for server type Hyper-V Standalone/Cluster
Example query | Query result when backup job runs |
|---|---|
No query rules specified (Query pane is empty) | All virtual machines are added to the backup list. Exceptions are those that do not have a host name, or that have invalid characters in the display name. See Effect of Primary VM identifier parameter on Selection column in Test Query results. |
Displayname Contains "prod" | All virtual machines with the display names that contain the string "prod" are added to the backup list. See Effect of Primary VM identifier parameter on Selection column in Test Query results. |
Displayname AnyOf "grayfox7","grayfox9" | The virtual machines named "grayfox7"and "grayfox9" are added to the backup list. Note that each value must be enclosed in its own quotes, with a comma in between. |
powerstate Equal "poweredOn" | Any virtual machine that is turned on is added to the backup list. |
powerstate Equal "poweredOn" AND HypervServer Equal "HV_serv1" | Any virtual machine that is turned on and resides on Hyper-V server |
IsClustered Equal TRUE | Any virtual machine that is in a clustered Hyper-V server is added to the backup list. |
Displayname Contains "pre-prod" AND IsClustered Equal FALSE | Any virtual machine with a display name containing "pre-prod" and that is not in a clustered Hyper-V server is added to the backup list. |
IsClustered Equal TRUE AND Notes Contains "pre-prod" | Adds to the backup list any virtual machine in a clustered Hyper-V server if the virtual machine has "pre-prod" in its Notes field. |
Displayname StartsWith "prod" OR Notes Contains "prod" | Adds to the backup list any virtual machine with a display name starting with "prod" or with Notes that contain "prod." |
ConfigurationVersion Greater "5" | Adds to the backup list any virtual machine that has a VM configuration version greater than 5. |
Table: Query Builder examples for server type System Center Virtual Machine Manager
Example query | Query result when backup job runs |
|---|---|
Name StartsWith "prod" | Adds to the backup list any VMs that have a display name that starts with "prod". Note: For VMs that reside under SCVMM, a Hyper-V Intelligent policy can back up VMs by their host name even if they are powered off. In this example: even if the policy's Primary VM identifier is set to VM hostname, VMs are added to the backup list whether they are powered on or powered off. |
ComputerName Contains "VM" | Adds to the backup list any VMs that have a network host name that contains "VM". See the note in this table for the example Name StartsWith "prod". |
VMHost AnyOf "hv1","hv2" AND Description Contains "pre-prod" | Adds to the backup list any VMs that reside on Hyper-V servers "hv1" or "hv2" if the VM has "pre-prod" in its Description field. The SCVMM Description field is similar to the VM's Notes field in Hyper-V. |
Generation Equal "2" | Adds to the backup list any VMs of Generation 2. |
IsUndergoingLiveMigration Equal FALSE | Adds to the backup list any VM that is not in live migration. |
VirtualMachineState Equal "Running" | Adds to the backup list any VM that is running. |
Cloud Contains "cloud9" AND HasSharedStorage Equal TRUE | Adds to the backup list any VM that meets the following: the VM is part of an SCVMM cloud that contains cloud9 in its name, if the VM is in a cluster that has shared storage. |
IsHighlyAvailable Equal TRUE AND IsFaultTolerant Equal FALSE | Adds to the backup list any VM that resides in a CSV cluster if the VM is not marked for fault tolerance. |
VMConfigurationVersion Greater "5" | Adds to the backup list any virtual machine that has a VM configuration version greater than 5. |
Click to see the query rule in Advanced Mode. Only Advanced Mode supports the use of parentheses for grouping sets of rules.