Search <book_title>...

NetBackup™ for Hyper-V Administrator's Guide

Last Published: 2024-09-30

Product(s): NetBackup (10.5)

Query Builder field reference

You can use the Query Builder to enter rules for the automatic selection of virtual machines for backup.

Table: Query Builder drop-down options: Join, Field, Operator, Value describes the drop-down fields and options for creating rules in the Query Builder.

Table: Query Builder drop-down options: Join, Field, Operator, Value

Query Builder drop-down fields	Description
Join	Selects a connector to join rules. For the first rule, choices are blank (none) or NOT. After you add a rule, the available connectors are AND, AND NOT, OR, OR NOT.
Field	Selects a parameter on which to build the rule. See Table: For server type Hyper-V Standalone/Cluster: Keywords in the Field drop-down .
Operator	Selects an operator. See Table: Operators in the Operator drop-down.
Value(s)	Specifies value(s) for the Field parameter. The value(s) you enter must be enclosed in single quotes or double quotes. You can specify multiple comma-separated values. See Table: Characters you can enter for Value.
Browse	Allows browsing for values, depending on the selections that are made in the other drop-down fields.
Add	Adds the current drop-down selections to the Query pane as a new rule.
	Resets the query fields to the default values.

Field (keywords)

The following tables describe the keywords available in the Field drop-down. The tables also indicate whether the values for each keyword (in the Values field) are case-sensitive.

Note that the Field keyword does not determine by itself the inclusion or exclusion of virtual machines. Selection of virtual machines depends on the rule you construct: the combination of Join, Field, Operator, and Value(s).

The available keywords depend on the Server Type that is selected:

For a description of the Hyper-V Standalone/Cluster keywords, see Table: For server type Hyper-V Standalone/Cluster: Keywords in the Field drop-down .
For a description of the System Center Virtual Machine Manager keywords, see Table: For server type System Center Virtual Machine Manager: Keywords in the Field drop-down .

Table: For server type Hyper-V Standalone/Cluster: Keywords in the Field drop-down

Field keyword	Data type	Description
ConfigurationVersion	Numeric	The configuration version of the virtual machine.
Displayname	Alphanumeric string	The virtual machine's display name. Values are case-sensitive.
HypervServer	Alphanumeric string	The name of the Hyper-V server. Values are not case-sensitive.
IsClustered	Boolean	TRUE if the virtual machine resides in a Hyper-V server that is in a cluster.
Notes	Alphanumeric string	A note that was recorded about the virtual machine, in the virtual machine's Summary tab in Hyper-V Manager. Values are case-sensitive.
Powerstate	Alphabetic	The state of the virtual machine. Values are `poweredOff`, `poweredOn`, `suspended`, `starting`, `offCritical`.

Table: For server type System Center Virtual Machine Manager: Keywords in the Field drop-down

Field keyword	Data type	Description
BackupEnabled	Boolean	TRUE if the BackupEnabled property is enabled in Integration Services.
Cloud	Alphanumeric string	The name of the SCVMM cloud that the VM is a part of. Values are not case-sensitive.
CloudVMRoleName	Alphanumeric string	The name of the VM role for the SCVMM cloud. Values are not case-sensitive.
ComputerName	Alphanumeric string	The network host name of the VM. Values are not case-sensitive.
CostCenter	Alphanumeric string	The name of the VM's cost center. Values are not case-sensitive.
Description	Alphanumeric string	The VM's description in SCVMM. This field is similar to the VM's Notes field in Hyper-V. Values are case-sensitive. Note: If the VM's description field contains a newline character, the Query Builder's folder icon for browsing may not return the correct values. See Query rules for virtual machine Notes that contain a newline character.
DRState	Alphanumeric string	The disaster recovery state of the VM. Values are Disabled, Enabled.
Generation	Numeric string	The numeric Generation (or type) of the VM that the SCVMM server manages.
HasPassThroughDisk	Boolean	TRUE if the VM has a pass-through disk configured.
HasSharedStorage	Boolean	TRUE if the VM is in a cluster that has shared storage configured.
HasVirtualFibreChannelAdapters	Boolean	TRUE if the VM has virtual Fibre Channel adapters. These adapters enable Hyper-V VMs to have direct access to Fibre Channel SAN array resources.
HostGroupPath	Alphanumeric string	The complete host group path to the VM. Values are not case-sensitive.
IsDREnabled	Boolean	TRUE if Microsoft Azure Site Recovery Provider (formerly Hyper-V Recovery Manager) manages the VM's disaster recovery.
IsFaultTolerant	Boolean	TRUE if the VM is marked for fault tolerance (if it can run without interruption in the case of a host failure).
IsHighlyAvailable	Boolean	TRUE if the virtual machine resides in a Hyper-V server that is in a CSV cluster.
IsPrimaryVM	Boolean	TRUE if the VM is a primary VM that is configured to be replicated to a secondary VMM site.
IsRecoveryVM	Boolean	TRUE if the VM is a replicated copy (of the primary VM) at a secondary Virtual Machine Manager (VMM) site.
IsTestReplicaVM	Boolean	TRUE if the VM is a replicated copy that is designated in the Microsoft Azure Site Recovery Provider (formerly Hyper-V Recovery Manager) for failover test. Test failover is initiated on a replica VM to test the virtualized workload without interrupting the production site or ongoing replication. You can exclude such VMs from the backup by creating queries such as: IsTestReplicaVM Equal 'FALSE'
IsUndergoingLiveMigration	Boolean	TRUE if the VM is in migration from one Hyper-V server to another by means of the Hyper-V live migration feature.
Name	Alphanumeric string	The VM's display name in SCVMM. Values are case-sensitive.
OperatingSystem	Alphanumeric string	The VM's guest operating system. Values are not case-sensitive.
Owner	Alphanumeric string	The VM owner's name. Values are not case-sensitive.
RecoveryPointObjective	Numeric	The recovery point objective (RPO) value for this VM. RPO is the maximum acceptable data loss as measured in time. In backup storage, RPO is the maximum age of the data that is required to resume normal operations if a failure occurs. For example, if the RPO is set to 30 minutes, then a backup of the system is required every 30 minutes.
Tag	Alphanumeric string	The name of the tag. A tag is a string for logical grouping of VMs in NetBackup. Values are not case-sensitive.
TotalSize	Numeric	The total size on disk (in bytes) of all the VM's VHDs.
UserRole	Alphanumeric string	The user role the VM is a part of, such as Administrator, Fabric Administrator, or Tenant Administrator. Values are not case-sensitive.
VirtualMachineState	Alphanumeric string	The power state of the virtual machine. Values are not case-sensitive. Hyper-V has many possible values for the VM state, such as PowerOff and Running.
VMConfigurationVersion	Numeric	The configuration version of the virtual machine. Note the following: This option works only with SCVMM 2016 and later. In SCVMM 2012, the VM's configuration version is not available, so NetBackup is unable to retrieve the configuration version. If the NetBackup primary server protects SCVMM 2016 as well as SCVMM 2012, you can use VMConfigurationVersion with the IsSet operator. For example: Name Contains "Production" AND VMConfigurationVersion IsSet AND VMConfigurationVersion Greater "5.0" In this example, no VMs in SCVMM 2012 are selected, because the VMConfigurationVersion IsSet rule returns "false." On SCVMM 2016, VMConfigurationVersion IsSet returns "true": The query can select any VM that contains "Production" in its name and is at a configuration version later than 5.0.
VMHost	Alphanumeric string	The name of the Hyper-V host for this VM. Values are not case-sensitive.
VMResource	Alphanumeric string	The resource for a highly available VM. Values are not case-sensitive.
VMResourceGroup	Alphanumeric string	The resource group for a highly available VM. Values are not case-sensitive.

Operators

Table: Operators in the Operator drop-down describes the operators available in the Operator drop-down.

Table: Operators in the Operator drop-down

Operator	Description
AnyOf	Matches any of the specified values in the Value(s) field. For example: If the display names in the Value(s) field are "`vm01`","`vm02`","`vm03`", AnyOf matches any VM that has one of those names. If the names of your VMs are not identical to any of the specified values, no match occurs. A VM that is named "`vm01A`" is not a match.
Contains	Matches the value in the Value(s) field wherever that value occurs in the string. For example: If the Value(s) entry is "`dev`", Contains matches strings such as "`01dev`", "`01dev99`", "`devOP`", and "`Development_machine`".
EndsWith	Matches the value in the Value(s) field when it occurs at the end of a string. For example: If the Value(s) entry is "`dev`", EndsWith matches the string "`01dev`" but not "`01dev99`", "`devOP`", or "`Development_machine`".
Equal	Matches only the value that is specified in the Value(s) field. For example: If the display name to search for is "`VMtest27`", Equal matches virtual machine names such as "`VMTest27`" or "`vmtest27`" or "`vmTEST27`", and so forth. The name "`VMtest28`" is not matched.
Greater	Matches any value that is greater than the specified Value(s), according to the ASCII collating sequence.
GreaterEqual	Matches any value that is greater than or equal to the specified Value(s), according to the ASCII collating sequence.
IsSet	Determines whether a value is returned for the Field keyword. Use IsSet with another rule as a condition, to ensure that the query selects the appropriate virtual machines. Note that you do not make an entry under Value(s) for a rule that uses IsSet. See The IsSet operator in queries. See Effect of Primary VM identifier parameter on Selection column in Test Query results. See Test Query: Failed virtual machines.
Less	Matches any value that is less than the specified Value(s), according to the ASCII collating sequence.
LessEqual	Matches any value that is less than or equal to the specified Value(s), according to the ASCII collating sequence.
NotEqual	Matches any value that is not equal to the value in the Value(s) field.
StartsWith	Matches the value in the Value(s) field when it occurs at the start of a string. For example: If the Value(s) entry is "`box`", StartsWith matches the string "`box_car`" but not "`flat_box`".

Value

Table: Characters you can enter for Value describes the characters that can be entered in the Value field. The Field keyword determines case sensitivity.

Note:

The character string you enter in the Value field must be enclosed in single quotes or double quotes.

Table: Characters you can enter for Value

Character types	String characters allowed
Alphanumerics	A to Z, a to z, 0 to 9 (decimal), and the following special characters: , ~ ! @ $ % ^ & * ( ) ` - _ = + [ ] { } \| \ : ; , . < > / ? Note: If the policy's Primary VM identifier option is set to VM display name, only the following characters are supported in the virtual machine's display name: A to Z, a to z, 0 to 9, hyphen (-), period (.), underscore (_), plus sign (+), left and right parentheses (), spaces.
Wildcards	* (asterisk) matches everything. For example: "`prod`" matches the string "`prod`" preceded or followed by any characters. ? (question mark) matches any single character. For example: "`prod??`" matches the string "`prod`" followed by any two characters.
Escape character	\ (backslash) escapes the wildcard or meta-character that follows it. For example: To search for a string that contains an asterisk (such as test), enter "`test\`"
Quotation marks	Note: The characters you enter in Value(s) must be enclosed in single or double quotes. To search for a string that contains quotation marks, either escape each quote (\") or enclose the entire string in the opposite type of quotes. For example: To search for a string that includes double quotes (such as `"name"`), enter `'"name"'` (enclosing it in single quotes) or `"\"name\""`.