Examples for the NetBackup Query Builder
This topic applies to policy configuration for NetBackup for VMware. You can use the Query Builder to enter rules for the automatic selection of VMware virtual machines for backup.
The following table provides example query rules.
To use the Query Builder, you must click on the Clients tab.
Click to see the query rule in Advanced Mode. Only Advanced Mode supports the use of parentheses for grouping sets of rules.
See Using the Query Builder in Advanced Mode.
Note:
You can configure and manage VMware policies with the NetBackup web UI. In the web UI, the advanced mode of the Query Builder uses OData keywords and operators. Otherwise, the Query Builder functions the same way as in the NetBackup Administration Console.
Another topic is available on the difference between AND and OR in a query.
Table: Query Builder examples
VIP Example query | OData example query * | Query result when backup job executes |
|---|---|---|
No query rules specified (Query pane is empty) | 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" | contains(displayName, '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. |
powerstate Equal "poweredOn" | powerState eq 'poweredOn' | Any virtual machine that is turned on is added to the backup list. |
VMGuestOS Equal "windows7Guest" | vmGuestOs eq 'windows7Guest' | All virtual machines with a guest OS of Windows 7 are added to the backup list. |
DisplayName AnyOf "grayfox7","grayfox9" | displayName in ('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" AND Datastore Equal "Storage_1" AND VMGuestOS Equal "rhel4Guest" | powerState eq 'poweredOn' and datastoreName eq 'Storage_1' and vmGuestOs eq 'rhel4Guest' | In datastore Storage_1: any virtual machine that is turned on and has a guest OS of Red Hat Linux 4 is added to the backup list. |
vCenter Equal "vCenterServer_1" AND ESXserver Contains "prod" | vCenter eq 'vCenterServer_1' and contains(host, 'prod') | In the vCenter server vCenterServer_1, virtual machines that are in ESX servers with names containing "prod" are added to the backup list. |
Cluster Equal "VMcluster_1" AND ESXserver AnyOf "ESX_1","ESX_2","ESX_3" AND VMHostName Contains "Finance" | cluster eq 'VMcluster_1' and host in ('ESX_1', 'ESX_2', 'ESX_3') and contains(hostName, 'Finance') | In cluster VMcluster_1, all virtual machines with the host names that contain "Finance", in ESX servers ESX_1, ESX_2, ESX_3, are added to the backup list. |
VMFolder StartsWith "Prod" OR VMFolder NotEqual "VM_test" | startswith(vmFolder, 'Prod') or vmFolder ne 'VM_test' | For any folder whose name starts with "Prod" or whose name is not "VM_test", add its virtual machines to the backup list. |
Examples with IsSet | ||
Datacenter Contains "prod" AND Tag Equal "Finance" | contains(datacenter, 'prod') and tagName eq 'Finance' | This query selects any virtual machine where the Datacenter contains "prod" and the user-specified tag is "Finance". |
Datacenter Equal "prod" AND NOT Tag Equal "Test" | datacenter eq 'prod' and not (tagName eq 'test') | Selects virtual machines where Datacenter is "prod" but excludes any virtual machines that have the user-specified tag "Test". |
* Use OData operators only when you build queries with the NetBackup web UI's advanced mode under the Query Builder or with NetBackup APIs. | ||
More Information