Search <book_title>...

NetBackup™ for Microsoft SQL Server Administrator's Guide

Last Published: 2025-03-18

Product(s): NetBackup & Alta Data Protection (11.0)

Query builder for credential rules reference

You can use the Query builder to create rules to automatically apply credentials to SQL Server instances that match a credential rule.

OData keywords are indicated for when you build queries for credential rules with the NetBackup APIs. The Preview feature displays the query string that contains OData keywords and operators. For example, the query to search for the host names that end with "domain.com" is: endswith(tolower(clientName), tolower('domain.com')).

Table: Query builder options for credential rules describes the fields and options for creating credential rules with the Query builder.

Table: Query builder options for credential rules

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. See Table: Keywords in the Field dropdown .
Operator	Select an operator. The available operators depend on the parameter that is selected for the Field. See Table: Operators in the Operator list.
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.

Field (keywords)

Table: Keywords in the Field dropdown describes the keywords that are available in the Field dropdown. The values for each keyword (in the Value field) are case-insensitive.

Note:

Use OData Field keywords are indicated for when you build queries for credential rules with the NetBackup APIs.

Table: Keywords in the Field dropdown

Field keyword	OData field keyword	Description
Cluster type	clusterType	The type of cluster that the SQL Server is configured in.
Edition	`sqlEdition`	The edition that is associated with the SQL Server version.
Host name	clientName	The name of the SQL Server host.
Instance name	displayName	The name of the SQL Server instance.
Microsoft SQL Server release	sqlRelease	The release version of SQL Server that is installed on the host.
Microsoft SQL Server version	sqlVersion	The version of SQL Server that is installed on the host.
NetBackup version	nbuVersion	The version of NetBackup that is installed on the host.
SP	sqlServicePack	The service pack of the SQL Server version.
State	instanceState	The state of the SQL Server instance.

Operators

Table: Operators in the Operator list describes the operators available in the Operator list. The values for each keyword (in the Value field) are case-insensitive.

Table: Operators in the Operator list

Operator	OData operator	Description
Starts with	startswith	Matches the value in the Value field when it occurs at the start of a string. For example: If the Value entry is "box", Starts with matches the string "box_car" but not "flatbox".
Ends with	endswith	Matches the value in the Value field when it occurs at the end of a string. For example: If the Value entry is "dev", Ends with matches the string "01dev" but not "01dev99", "devOP", or "Development_machine".
Contains	contains	Matches the value in the Values field wherever that value occurs in the string. For example: If the Value entry is "dev", Contains matches strings such as "01dev", "01dev99", "devOP", and "Development_machine".
Equal to	eq	Matches only the value that is specified in the Value field. For example: If the host name to search for is "SQLtest27", Equal to matches the virtual machine names such as SQLTest27 or sqltest27 or sqlTEST27, and so forth. The name SQLtest28 is not matched.
Not equal	ne	Matches any value that is not equal to the value in the Value field.