Page tree

Use this command to create saved searches.

To understand the syntax and examples, see:

Syntax

Note

Prefix this command with the following, as appropriate:

  • For Windows: itda.bat
  • For Linux: ./itda.sh
create -d <hostname> -u <username> [-v] [-s] -w <password> -p <portNumber> -e savedsearch 
–a queryName=<Saved Search Name>, queryString=<Query String>,
description=<Saved Search Description>, startTime=<Search Start Time>,
endTime=<Search End Time>, absoluteTime=<Boolean value>,
relativeMinutes=<Relative time>, share=<Boolean value>
  • Angle brackets (< >) indicate a variable value that needs to be user defined.
  • Square brackets ([ ]) indicate optional parameters.

The following table describes the parameters used in the syntax:

ParameterDescription
-a

Attributes of the entity that you want to create.

This parameter must be in the format key=value.

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 about a saved search:

  • queryName=<Saved Search Name>

    where <Saved Search Name> refers to the name you want to use to create the saved search.

  • queryString=<Query String>
    where <Query String> refers to the saved search query string.
  • description=<Saved Search Description>
    where <Saved Search Description> refers to the optional description that you might want to provide for the saved search.
  • startTime=<Search Start Time>
    where <Search Start Time> refers to the saved search start time (in the Java long time format).
  • endTime=<Search End Time>
    where <Search End Time> refers to the saved search end time (in the Java long time format).
  • absoluteTime=<Boolean value>
    where <Boolean value> refers to the value true or false depending on whether or not the saved search time is an absolute value (custom time).
  • relativeMinutes=<Relative time>
    where <Relative time> refers to the relative time (in minutes) that you are using for the saved search. You can use 15 (Last 15 minutes), 60 (Last 60 minutes), 1440 (Last 24 hours), and 10080 (Last 7 days).
  • share=<Boolean value>
    where <Boolean value> refers to the value true or false depending on whether or not the saved search must be public.
-d
Host name of the Console Server
-e

The entity that you want to create. Enter savedsearch.

-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
-v
(Optional) Version of the IT Data Analytics product
-s
(Optional) Indicates an HTTPS connection

Example input

The following example provides the input for creating a saved search:

create -d localhost -u admin -w admin -p 9797 -e savedsearch -a
queryName="Star Query",queryString="*", description="Query with
*",startTime=1376654400000,endTime=1377268200000, absoluteTime=false,
relativeMinutes=10080,
share=false

Related topic

Managing saved searches