Search string syntax

Use the search string syntax that is explained in the following sections to find specific entities such as systems in the TrueSight console.

The search string is not case sensitive and can contain single terms (including wildcards) and phrases (delimited by double quotes), and can optionally be combined by using boolean operators.

Using wildcards

Wildcards allow you to search for similar terms using a single string.

Two types of wildcards are available:

Single character wildcards (?): Indicate one variable character; for example, to search for "text" or "test" you can use the search string te?t.
Multiple character wildcards (*): Indicate zero or more variable characters; for example, to search for "test", "tests", or "testing" you can use the search string test*.

Using boolean operators

Boolean operators allow you to combine terms and phrases in a search using logical operators.

The following table lists the supported operators:

Operator	Description
AND	Links two terms and finds a matching result if both terms exist in the object's properties.
+	Requires that the term after the "+" symbol exist in the object's properties.
OR	Links two terms and finds a matching result if either of the terms exist in the object's properties; results containing both terms will be displayed at the top of the list.
NOT	Links two terms and excludes results that contain the term after NOT in the object's properties.
-	Excludes results that contain the term after the "-" symbol.

Note

Boolean operators must be specified using capital letters (upper case) in the search string.

Additional information

If no operator is specified between two terms, the AND operator is used by default.

Grouping search terms and phrases

You can use parentheses to group clauses and form sub-queries. For example:

(database* OR "web service") AND billing

Restricting the search using fields

You can restrict the search to specific fields using the syntax:

<field>:<value>

where <field> is an optional filter used to restrict search results. The available fields, including description and examples, are listed in the following table. For most fields, aliases that are easier and more intuitive to remember are also available; e.g. scenario instead of tc.

Field name	Description	Aliases for the field name	Example syntax
`sys`	System whose TrueSight Capacity Optimization name matches the string.	`system`, `server`	`sys:co*` `server:nepsrv10` `system:billing_01`
`resname`	Resource (metric) whose name matches the string.	`res`, `resource`, `metric`	`resname:CPU_UTIL` `metric:CPU` `resource:MEM`
`metricname`	Resource (metric) whose descriptive name matches the string.	-	`metricname:(CPU Utilization)`
`subobject`	Subresource (subobject) whose name matches the string.	`subresource`, `subo`, `subres`, `subobj`, `subobjnm`	`subres:oracle`
`location`	Location whose name matches the string.	`loc`, `where`	`location:milano`
`enttype`	Entity type whose name matches the string.	`subtype`	`enttype:cluster`
`relatedto`	Show child entities of the selected one by name.	-	`relatedto:CLM-CLUSTER_01`
`hostname`	Name of the virtual host that is running the VM, this field is valid only for virtual machines.	-	`hostname:(myhost123)`
`clustername`	Name of the virtual cluster that is running the VM, this field is valid only for virtual machines.	-	`clustername:(mycluster123)`
`tag`	Tag whose name matches the string.	-	`tag:Linux`
`type`	Object of the specified type: System, sys or server Workload or wkld App or domain Report Model Tc or scenario	-	`type:workload`
`status`	Restrict results of the search based on the status of the entity.For example: newly - restrict results to Newly discovered systems (or business drivers) unassigned - restrict results to Unassigned systems (or business drivers) shared - restrict results to Shared systems common - restrict results to common business drivers	-	`status:newly` `status:unassigned` `status:shared` `status:common`

The following table lists advanced field options that allow you to search for unique IDs; this can be useful if you already know the specific ID of the object you are looking for.

Field name	Description	Aliases for the field name	Example syntax
`sysid`	System whose unique ID matches the string.	`systemid`, `serverid`	`sysid:123`
`seriesid`	Metric series whose unique ID matches the string; the string must begin with either SOB or WOB, to identify a system (or, respectively, business driver) metric.	-	`seriesid:SOB123`
`enttypeid`	Entity type whose unique ID matches the string.	`subtypeid`	`subtypeid:123`
`relatedtoid`	Show child entities of the selected one by ID.	-	`relatedtoid:SYS123`
`hostid`	Unique ID of the virtual host that is running the VM, this field is valid only for virtual machines.	-	`hostid:(SYS123)`
`clusterid`	Unique ID of the virtual cluster that is running the VM, this field is valid only for virtual machines.	-	`clusterid:(SYS123)`
`tagid`	Tag whose unique ID matches the string.	-	`tagid:123`

The following table lists advanced field options that allow you to specify numerical ranges; this can be useful to search for systems based on their hardware characteristics.

Field name	Description	Aliases for the field name	Example syntax
`cpumhz`	CPU clock rate (MHz)	-	`cpumhz:>2000`
`cpunum`	Number of CPUs	-	`cpunum:>=3` `cpunum:4`
`disksize`	Size of the physical disk (bytes)	-	`disksize:>1T`
`ldisksize`	Size of the virtual disk (bytes)	-	`ldisksize:<=50G`
`totalmem`	Total memory (bytes)	`totalrealmem`	`totalmem:>2G`

The fields disksize, ldisksize, and totalmem are expressed in bytes; you can append a letter to numerical values to specify a different unit: K (kilobyte), M (megabyte), G (gigabyte), T (terabyte), P (petabyte).

Escaping special characters

If you need to use special characters as part of the search string, they must be properly escaped using the \ character. For example, to search for a system called "Database (2)", you must escape the string as follows:

Database \(2\)

Special characters that need to be escaped are:

+ - && \|\| \! ( ) { } \[ \] ^ " ~ * ? : \