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

Use this command to perform the following functions:

  • Enable redundancy for Indexers in the cluster.
  • Disable redundancy for Indexers in the cluster.
  • View the current redundancy state to understand whether redundancy for Indexers is applied or not.

For more information, see Indexer redundancy.

Best practice

BMC recommends you to not run this command while indexed data is being searched to avoid performance impact.

To understand the syntax and examples, see:

Before you begin

Ensure that the product is up and running.

Syntax

Note

Before you run the command, note the following points:

configureredundancy -d <hostname> -p <portNumber> -u <username> -w <password> -ops <operationName> -replicas <count> [-l <locale>] [-s]

  • 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

Name of the operation that you want to perform by using this command.

Depending on the kind of operation you want to perform, the value can be one of the following:

  • To enable redundancy: Specify the value, enable.
  • To disable redundancy: Specify the value, disable.
  • To view redundancy state: Specify the value, status.

Notes:

  • To be able to enable redundancy, there must be more than one Indexer in your environment.
  • When you enable redundancy, by default, the index replication factor is set to 1 for all the data that is already indexed and the data to be indexed. This means one copy of the data will be replicated on other Indexer(s). If you want to create more than one replica, then you need to specify the replicas parameter.
-replicas

(Optional) The number of index replicas that you want to create.

By default, the replication factor is set to 1. If you want to create more than one replica, then you need to specify this value.

Note that the number of replicas cannot be greater than the number of Indexers available in the cluster. The maximum number of index replicas can be n – 1 (where n is total number of data nodes).

Specifying this parameter is not needed while disabling redundancy or viewing the redundancy state.

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

Example inputs

The following example provides the input for enabling redundancy for all the Indexers in your environment, with the replication factor set to 2.

configureredundancy -u admin -w admin12345 -d win-pun-01 -p 9797 -ops enable -replicas 2

The following example provides the input for disabling redundancy for all the Indexers in your environment.

configureredundancy -u admin -w admin12345 -d win-pun-01 -p 9797 -ops disable

The following example provides the input for checking whether Indexer redundancy is applied or not.

configureredundancy -u admin -w admin12345 -d win-pun-01 -p 9797 -ops status