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


Use this command to list the names of particular index types or all the index types present in the system.

When data is indexed, it is stored in a particular category of index. Each category denotes an index type.

The following index types are available:

  • Data: Contains all the external data indexed.
  • Metrics: Contains the internal metrics (or logs) generated by the TrueSight IT Data Analytics product for the Collection Station and Search components. For more information, see Monitoring the product metric files.
  • Metadata: Contains details of all the existing indexes including the name, start time, and end time of the index. Every index stores records for a particular duration. When a search is run, the Search component consults this index to get details of the actual indexes where the searched data resides.

To understand the syntax and examples, see:

Syntax

Note

Before you run the command, note the following points:

 

indexlist -d <hostname> -p <portNumber> -u <username> -w <password> -indextype <type> [-l <locale>] [-s] [-v]

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

Type of index for which you need details.

You can specify one of the following values:

  • To get details of the data index type only, specify data.
  • To get details of the metrics index type only, specify metrics.
  • To get details of the metadata index type only, specify metadata.
  • To get details of all the index types available, specify, all.
-d
Host name of the Console Server
-p
Port number of the Console Server.
-u
User name to use to connect with the Console Server.
-v
(Optional) Version of the IT Data Analytics product.
-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.

-s
(Optional) Indicates an HTTPS connection.

Example inputs

The following example provides the input for listing details of the "data" index type.

indexlist -u admin -w admin12345 -d localhost -p 9797 -indextype data

The following example provides the input for listing details of all the index types available.

indexlist -u admin -w admin12345 -d localhost -p 9797 -indextype all