Query builder reference for KVM virtual machines
You can use the Query builder to enter rules for the automatic selection of KVM virtual machines for backup.
: The advanced mode of the Query builder uses OData keywords and operators.
Table: Query builder options for KVM virtual machines describes the fields and options for creating credential rules with the Query builder.
Table: Query builder options for KVM virtual machines
Query Builder fields | Description |
|---|---|
and or | When you add two or more conditions, you can select a connector to join the rules. |
Field | Select a parameter on which to build the rule. |
Operator | Select an operator. The available operators depend on the parameter that is selected for the Field. |
Value | Specifies a Value for the Field parameter. The Value field can be a list of possible values or a manual entry, depending on the selections that are made in the other fields. See Value. |
Table: Keywords in the list describes the keywords that are available in the Field dropdown. The values for each keyword (in the Value field) are case-sensitive.
Note:
Use OData Field keywords are indicated for when you build queries for credential rules with the NetBackup APIs.
Table: Keywords in the list
Field keyword | OData field keyword | Description |
|---|---|---|
description | description | The description of the virtual machine. |
displayName |
| The virtual machine's display name. |
kvmHostName | kvmHostName | The name of the KVM host. |
powerState | powerState | The power state of the virtual machine. |
title | title | The title from the metadata for the virtual machine. |
uuid | uuid | The UUID of the virtual machine. |
Table: Operators in the list describes the operators available in the list. The table also indicates whether the values for each keyword (in the field) are case-sensitive.
Table: Operators in the list
Operator | OData operator | Description |
|---|---|---|
Contains | contains | Matches the value in the field wherever that value occurs in the string. Values are case-sensitive. For example: If the entry is 'dev', matches strings such as '01dev', '01dev99', and 'devOP'. The name 'Development_machine' is not matched. |
EndsWith | endswith | Matches the value in the field when it occurs at the end of a string. For example: If the Value entry is 'dev', matches the string '01dev' but not '01dev99', 'devOP', or 'development_machine'. |
Equal | equal | Matches only the value that is specified in the field. Values are case-sensitive. For example: If the display name to search for is 'VMtest27', matches the virtual machine name VMtest27. The names VMTest27 or vmtest27 or vmTEST27 are not matched. |
Greater | greater | Matches any value that is greater than the specified , according to the UTF-8 collating sequence. |
GreaterEqual | greaterEqual | Matches any value that is greater than or equal to the value in the field, according to the UTF-8 collating sequence. |
In | in | Matches any of the specified values in the field. For example: If the hosts in the field are 'kvm01','kvm02,'kvm03', matches any KVM host that has one of those names. If the names of your KVM hosts are not identical to any of the specified values, no match occurs. A host named KVM01A is not a match. |
Less | less | Matches any value that is less than the specified , according to the UTF-8 collating sequence. |
LessEqual | lessEqual | Matches any value that is less than or equal to the specified , according to the UTF-8 collating sequence. |
NotEqual | ne | Matches any value that is not equal to the value in the field. |
StartsWith | startswith | Matches the value in the field when it occurs at the start of a string. For example: If the entry is 'box', matches the string 'box_car' but not 'flatbox'. |
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.
Table: Characters you can enter for Value
Character types | String characters allowed |
|---|---|
Alphanumerics | A to Z, a to z, 0 to 9, - (minus sign), and special characters. Note: Decimal numbers only. |
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 must be enclosed in single quotes. To search for a string that contains quotation marks, escape each quote (\'). For example: To search for a string that includes single quotes (such as 'name'), enter '\'name\'' |