manageindexblock CLI command


Use this command to add or delete index blocks.

Note

Before running the command, ensure that the following components are up and running:

  • Configuration Database
  • Console Server
  • Indexer (all instances)

After running this command, ensure that all the product components are up and running. To understand the status of each of the components, navigate to the Administration > Components page. For more information, see Viewing component status and associated properties.


Syntax

Note

Before you run the command, note the following points:

manageindexblock -indexBlockName <indexblockname> -operation <create or delete> -retentiondays <retention days> -archive <archive status> -d <hostname> -p <portNumber> -u <username> -w <password> [-l <locale>] [-s] [-y]
  • 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 
-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.
-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.

-indexBlockName

Name of the index block that you are creating.

Note: The name of the index block cannot be left blank.

It can take the values of alphabets, numerics and blank spaces. The name of the index block cannot be more than a 100 characters long.

-operation

The operation that you want to perform.

You can choose to create a new index block or delete an existing one. It takes the values of:

  • create
  • delete

Note: An index block, which is associated with a data collector or a collection profile, does not get deleted if you use the delete operation. To be able to delete an index block, it must not be associated with any data collector or collection profile. You can re-associate the data collectors or collection profiles with some other index block and then delete the earlier index block.

-retentiondays

The number of retention days that you want to associate with the index block that you are creating.

Note: The maximum number of retention days that you can specify should not be greater than the maximum limit set in olasearchserviceconfig.properties file located in the %BMC_ITDA_HOME%/conf/server folder.

-archive

The archive status that you want to set for the index block that you are creating.

It takes the following values:

  • true
  • false
-y

Shows a preview of the collections profiles and data collectors associated with an Index block.

It takes the following value:

  • true
Example inputs
The following example provides the input for creating an index block:

manageindexblock -u admin -w admin12345 -d localhost -p 9797 -operation create -indexblockname abc -retentiondays 8 -archive true

The following example provides the input for previewing an index block:

manageindexblock -u admin -w admin12345 -d localhost -p 9797 -operation delete -indexblockname abc -y true

The following example provides the input for deleting an index block:

manageindexblock -u admin -w admin12345 -d localhost -p 9797 -operation delete -indexblockname abc

Was this page helpful? Yes No Submitting... Thank you

Comments