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:
Before you run the command, note the following points:
- Set up the CLI. For more information, see Managing the product from the command line interface.
- Prefix this command with the following, as appropriate:
- For Windows: itda.bat
- For Linux: ./itda.sh
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:
Type of index for which you need details.
You can specify one of the following values:
|Host name of the Console Server.|
|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) Indicates the locale in which you want to display messages when the command is run.
You can set one of the following locales:
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:
Example: If you want to set the locale as Simplified Chinese, you need to specify,
|(Optional) Indicates an HTTPS connection.|
The following example provides the input for listing details of the "data" index type.
The following example provides the input for listing details of all the index types available.