indexlist CLI command

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:

Related topics

configureredundancy-CLI-command

configureclustersettings-CLI-command

configureindexsettings-CLI-command

configuremasters-CLI-command

indexertemplates-CLI-command

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:

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