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

Use this command to change index-level settings. These settings can help you customize index behavior.

Note

The default values for index-level settings are optimum and changing them can impact performance. BMC recommends that you do not change the default values unless you are instructed to by BMC Customer Support.

To understand the syntax and examples, see:

Before you begin

Ensure that the Indexer cluster and the Console Server are up and running.

Syntax

Note

Before you run the command, note the following points:

configureindexsettings -d <hostname> -p <portNumber> -u <username> -w <password> [-l <locale>] [-s] -ops <operationType> -indextype <type>

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







Type of operation that you want to perform.

Depending on the type of operation that you want to perform, the value can be list or modify. For more information about the settings, see Index-level settings.

The supported operations are explained as follows:

List operations
To...Specify the value
List details of particular settings (property names specified).

-ops list -k <keysToRead>

In the preceding syntax, <keysToRead> refers to comma-separated list of property names for which you want to list details.

List details of all the settings.

-ops list

Modification operations

Note: A change in the value of the following properties leads to an automatic restart of the Indexer cluster.

To...Specify the value

Modify details of settings and apply the changes on all the indexes present in the system or on particular indexes.

Specifying details about the index name is optional.

The value can be specified in one of the following ways:

  • Specify a list of keys (or property names) with new values.
  • Provide details of a file containing the key=value pairs with new values.

modify -k <keysToUpdate> -indexname <indexNameList>

In the preceding syntax, the following definitions apply:

  • <keysToUpdate> refers to a comma-separated list of property names for which you want to update details.

    The keys must be specified in the format, <propertyName1>=<propertyNewValue1>,<propertyName1>=<propertyNewValue1>.

    Example: -ops modify -k index.refresh_interval=5s,index.number_of_replicas=2

  • (Optional) <indexNameList> refers to a comma-separated list of index names on which you want to apply the new changes. For more information about getting details of index names, see the indexlist CLI command CLI command.
    Example: -ops modify -k index.refresh_interval=5s,index.number_of_replicas=2 indexname DATA

modify -f <fileDetails> -indexname <indexNameList>

In the preceding syntax, the following definitions apply:

  • <fileDetails> refers to the complete path to the file containing details of the properties with new values.
    The properties in the file must be added in the format, key=value. Each property must begin on a new line. The file must be saved with a .properties file extension.
  • (Optional) <indexNameList> refers to a comma-separated list of index names on which you want to apply the new changes. For more information about getting details of index names, see the indexlist CLI command CLI command.
    Example: -ops modify -k index.refresh_interval=5s,index.number_of_replicas=2 indexname DATA
-indextype

Type of index for which you want to list details. This parameter is only applicable for the list operation.

The value can be one of the following:

  • To list details of the data index type only, specify data.
  • To list details of the metrics index type only, specify metrics.
  • To list details of the metadata index type only, specify metadata.

For more information about the index types, see the indexlist CLI command CLI command.

-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.

Index-level settings

The following table provides definitions of the index-level settings that you can change by running this command.

Note

A change in the value of the following properties leads to an automatic restart of the Indexer cluster.

Index-level settingDescription
index.refresh_interval

Determines the frequency of performing a refresh so that recent changes made to the index are visible at search. The value of this setting must be specified as the number of seconds.

Refreshing is a resource intensive operation and that is why it is performed after a set interval rather than after the indexing operation. This interval is decided by the index.refresh_interval setting. You can increase indexing throughput by increasing this value. However, note that a lesser interval means lesser load on resources (less performance impact), and that means more resources can go to the indexing threads. Conversely, a greater interval means greater load on resources (more performance impact), and lesser threads resources for indexing.

Default value: 10s

Involves cluster restart: Yes

index.number_of_replicas

Determines the number of replicas (or copies) that each primary index must have.

The main reason for storing replicas is to enable redundancy. If a node holding a primary shard goes down, that work is promoted to the replica shard.

Increasing the number of replicas does not change the index capacity, but it does increase the capacity to serve search requests. If your business operations are search heavy, you can increase search performance by increasing the number of replicas. Note that for each new replica you need to provision additional hardware. You also need to provision higher storage to maintain the replicas. Thus, depending on your business needs and capacity, you need to manage the trade-off between data availability and hardware cost.

Default value: 0

Involves cluster restart: Yes

index.number_of_shards

Determines the number of primary shards that must be allocated to an index.

The key consideration while allocating the number of shards is the amount by which you expect your data to grow. There is a cost associated to each shard in terms of CPU and memory resources. Therefore, while planning for expanding data needs is good, it is important to not overallocate shards.

Note that you cannot change the shard allocation dynamically. Shard reallocation happens on the newly created shards only.

Default value: 4

Involves cluster restart: Yes

Example inputs

The following example provides the input for listing details of all the index-level settings.

configureindexsettings -u admin -w admin12345 -d localhost -p 9797 -ops list

The following example provides the input for modifying details of particular index-level settings.

configureindexsettings -u admin -w admin12345 -d localhost -p 9797 -ops modify -k index.refresh_interval=5s,index.number_of_replicas=3