Search syntax

The search string is case insensitive and can be composed using single terms (including wildcards) or phrases (delimited by double quotes), optionally combined using boolean operators. For example:

database* AND "web service" -test

You can also restrict the search to specific fields (e.g. only systems) using the following syntax: <field>:<value>. For example:

system:vmw* OR system:web*

Ensure that you enclose the complete search string within quotes to get accurate results. For example, if the search string is sys:TEST1, the search results return both TEST1 and TEST10. To search only for TEST1, use this syntax sys:"TEST1"


The following topics provide an overview of the search syntax:

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:nep*
server:nepsrv10
system:billing_01

wkld

Business driver whose name matches the string.

workload

wkld:backend
workload:web*

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

app

Domain whose name matches the string.

domain, application

app:sap
domain:test

analysis

Analysis whose name matches the string.

plot

plot:Performance*

report

Report whose name matches the string.

rep

report:voip

tc

Test condition (model scenario) whose name matches the string.

scenario

tc:baseline
scenario:MyScenario

model

Model whose name matches the string.

-

model:cons*

doc

Document whose name matches the string.

-

doc:Cost*

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

wkldid

Business driver whose unique ID matches the string.

workloadid

wkldid: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

appid

Domain whose unique ID matches the string.

domainid, applicationid

appid:123

analysisid

Analysis whose unique ID matches the string.

plotid

plotid:123

reportid

Report whose unique ID matches the string.

repid

reportid:123

tcid

Testcondition (model scenario) whose unique ID matches the string.

scenarioid

tcid:123

modelid

Model whose unique ID matches the string.

-

modelid:123

docid

Document whose unique ID matches the string.

-

docid:123

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


Allowed operators are: >>=<<== (can be omitted).

The fields disksizeldisksize, 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:

+ - && \|\| \! ( ) { } \[ \] ^ " ~ * ? : \ 
Was this page helpful? Yes No Submitting... Thank you

Comments