Administration Tool

Run the script that starts the Administration Tool to do common administration tasks.

You can use the Administration Tool to do the following tasks:
  • Check the status of collections, such as finding out how many documents are present
  • Delete orphan collections
  • Report the version of the server
  • Report all of the collections that reside on the text search server
  • Configure trace settings
  • Print trace settings

For most tasks, the text search server must be running when you use the Administration Tool. However, when the server is not running, you can still run the commands for reporting the version of the server and printing the help message.

Commands

The command that you issue to run the Administration Tool depends on the task that you want to do and whether the text search server is installed on a Linux®, zLinux, or Windows server.

Table 1. Commands to run the Administration Tool
On a Linux or zLinux server On a Windows server 
adminTool.sh admin_command 
-configPath [-locale] 
[-collectionName] [-trace]
 
adminTool.bat admin_command 
-configPath [-locale] 
[-collectionName] [-trace]

admin_command options

delete
Specifies that you want to delete the orphaned collection.
status
Checks the status of all of the collections.
version
Prints the version of the server.
configureTrace
Configures the trace settings for the text search server. You can turn the trace on or off.
printTrace
Prints the trace settings for the text search server.
help
Prints the usage information for this tool.

Parameters

-configPath
Specifies the fully qualified path to the configuration directory, such as /opt/ibm/search/config. If this value contains blanks, you must enclose the value in quotation marks. This parameter is mandatory.
-locale
Specifies the five-character locale code, such as en_US for English or de_DE for German. This parameter is optional. If you do not specify a value, the value for the server locale is used.
-collectionName
Specifies the name of the collection that you want to delete or obtain information about.
-trace
Specifies the trace value. Supported values are on or off. The default value is off.

Example

On a Linux server, use the following command to delete the collection that is named "Default":
adminTool.sh delete -configPath /opt/ibm/search/config -collectionName Default