indexertemplates CLI command

Use this command to list or update Indexer templates.

Note

BMC recommends that you do not update the templates unless you are instructed to by BMC Customer Support.

When an index is created a suitable template is automatically applied to that index. Based on the kind of data contained in the index, a matching template is applied. The template determine how the indexed data will be analyzed and interpreted by the product.

Data indexed based on a data pattern contains fields stored with particular field types. These field types are stored in the dynamic template.  Based on the field types, the product will determine if those fields need to be interpreted as aplhanumeric (STRING) or numeric (INTEGER, LONG, and so on). Similarly, other templates are applied on particular kinds of data and based on the template applied, that data is analyzed and interpreted.  

Related topics

configureredundancy-CLI-command

configureclustersettings-CLI-command

configureindexsettings-CLI-command

configuremasters-CLI-command

indexlist-CLI-command

The following kinds of templates are available:

  • Dynamic template (named dynamic_template_1): Applied to both data index types and metrics index types.
  • Metadata template (named itda_metadata): Applied to the metadata index type.
  • Configuration template (named itda_config): Applied to an index containing status about the last ten polls for data collectors. 

These templates are located at %BMC_ITDA_HOME%\conf\server\indexertemplates\.

For more information about the index types, see indexlist-CLI-command CLI command.To understand the syntax and examples, see:

Syntax

Note

Before you run the command, note the following points:

 

indexertemplates -d <hostname> -p <portNumber> -u <username> -w <password> -ops <operationName> -f <fileDetails> -tname <templateName> [-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 all the templates on a Windows machine.

 

indexertemplates -u admin -w admin12345 -p 9797 -d localhost -ops list -f C:\template.json -tname all

The following example provides the input for updating the property, "index.codec": "best_compression" in the "dynamic_template_1" template.

Note: Before performing the update, you need to first add "index.codec": "best_compression" in the template and save the template.

indexertemplates -u admin -w admin12345 -p 9797 -d localhost -ops update -tname dynamic_template_1