Server parameters: General settings

You view and set parameters for an IBM® Content Search Services server by using the command-line configuration tool.

IMPORTANT Do not alter server parameter values unless instructed to do so by a support representative from IBM Customer Support.

Authentication token
A value that the server expects server clients to include as part of an index or search request for client authentication purposes. The server rejects requests that do not include the expected token.

You must specify the authentication token when registering a server with Content Engine.

To view the value:

configTool printToken –configPath path

To generate a new token value:

  1. Generate the token with a seed:

    configTool generateToken –configPath path -seed abcd

  2. Working with server properties. Update the server registration. The value of the Authentication Token registration property must match the value of the server parameter.

For more information about this tool or the meaning of the variables that are used in the command syntax, see Configuration tool usage.

Logging level
The level of logging activity for the server. Valid values are FINE, FINER, FINEST, INFO, OFF, SEVERE, and WARNING. The default level is INFO. By default, log files are created in the <server-home>/log directory.

To set the parameter value:

configTool configureParams –configPath path –logLevel logging-level

For more information about this tool or the meaning of the variables that are used in the command syntax, see Configuration tool usage.

Maximum heap size
The maximum heap size for the server. Set the heap size according to JVM heap size specifications. For example, the maximum heap size that can be allocated to a 32-bit Java virtual machine is 1.8 GB. The default value is 1500 M.

To set the parameter value:

configTool configureParams –configPath path –startupHeapSize maximum-heap-size

For more information about this tool or the meaning of the variables that are used in the command syntax, see Configuration tool usage.

Plugin directory path
The location of the plugins directory. This directory contains plug-in-related files such as JAR files and resources. The default directory is <server-home>/plugins.

To set the parameter value:

configTool configureParams –configPath path –pluginsPath plugin-directory-path

For more information about this tool or the meaning of the variables that are used in the command syntax, see Configuration tool usage.

Port
The port number for server.

To view the parameter value:

configTool printAdminHTTPPort –configPath path

To set the parameter value:

configTool configureHTTPListener –configPath path –adminHTTPPort http-administration-port

For more information about this tool or the meaning of the variables that are used in the command syntax, see Configuration tool usage.

Temp directory path
The full-file specification for the directory that contains temporary files.

To set the parameter value:

configTool configureParams –configPath path –tempDirPath temp-directory-path

For more information about this tool or the meaning of the variables that are used in the command syntax, see Configuration tool usage.