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:
Ensure that the Indexer cluster and the Console Server are up and running.
Note
Prefix this command with the following, as appropriate:
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:
Parameter | Description | |
---|---|---|
-ops | Type of operation that you want to perform. Depending on the type of operation that you want to perform, the value can be The supported operations are explained as follows: | |
List operations | ||
To... | Specify the value | |
List details of particular settings (property names specified). |
In the preceding syntax, | |
List details of all the settings. |
| |
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:
|
In the preceding syntax, the following definitions apply:
| |
In the preceding syntax, the following definitions apply:
| ||
-indextype | Type of index for which you want to list details. This parameter is only applicable for the The value can be one of the following:
For more information about the index types, see the indexlist 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:
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, | |
-s | (Optional) Indicates an HTTPS connection. |
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 setting | Description |
---|---|
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 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 |
| 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 |
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