Page tree

Use this command to get entity details of a saved search depending on the filter attribute provided. This command gets details only by name and ID.

To understand the syntax and examples, see:



Prefix this command with the following, as appropriate:

  • For Windows: itda.bat
  • For Linux: ./

getDetail -a <Key1>="<Value 1>" -d <hostName> -e <entityName> 
-p <portNumber> -u <userName> [-v] [-s] -w <password>
  • Angle brackets (< >) indicate a variable value that needs to be user defined.

  • Square brackets ([ ]) indicate optional parameters.

  • Double quotes (") indicate a space-separated value for a parameter.

The following table describes the parameters used in the syntax:


Attributes of the entity for which you want to get details

Note: An attribute is a unit of information about the entity.

This option must be in the format key=value.

You can provide the following attribute to get details of a saved search:


where <savedSearch> refers to the name of the saved search for which you want to get details.

Host name of the Console Server
The name of the entity (saved search) that you want to create.
Port number of the Console Server
User name to use to connect with the Console Server
Password corresponding to the user name to use to connect with the Console Server
(Optional) Version of the IT Data Analytics product
(Optional) Indicates an HTTPS connection

Example input

The following example provides the input for getting details of a saved search:

getDetail -a queryName="Test search 1" -d localhost -e savedsearch -p 9797 -u admin -w admin

Related topic

 Managing saved searches