Page tree
Skip to end of metadata
Go to start of metadata

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:

Related topics

Syntax

Note

Before you run the command, note the following points:

getDetail -a <Key1>="<Value 1>" -d <hostName> -e <entityName> -p <portNumber> -u <userName> [-v] [-s] -w <password> [-l <locale>]

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

ParameterDescription
-a

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:

queryName=<savedSearch>

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

-d
Host name of the Console Server
-e
The name of the entity (saved search) that you want to create.
-p
Port number of the Console Server.
-u
User name to use to connect with the Console Server.
-w
Password corresponding to the user name to use to connect with the Console Server.
-l

(Optional) Indicates the locale in which you want to display messages when the command is run.

You can set one of the following locales:

  • English
  • Simplified Chinese
  • German
  • French

By default, the messages are displayed in the locale of the system on which the CLI is run.

The value can be set to one of the following depending on the locale you choose:

  • English: en
  • Simplified Chinese: chs
  • German: de
  • French: fr

Example: If you want to set the locale as Simplified Chinese, you need to specify, l=chs.

-v
(Optional) Version of the IT Data Analytics product.
-s
(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 admin12345

3 Comments

  1.  



    1.  

      1.