indexeradmin.exe reference (FAST Search Server 2010 for SharePoint)
Applies to: FAST Search Server 2010
Use the indexer administration tool to remotely control one or more indexing components. Use indexeradmin to suspend new items from being indexed, to disable/enable debug logging, or to defragment the intermediate FIXML files. The indexer must be running when you use the indexeradmin tool.
Note
The indexeradmin commands are asynchronous; under heavy content load, indexeradmin commands may not take effect immediately.
Note
To use a command-line tool, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.
Syntax
<FASTSearchFolder>\bin\indexeradmin [options] <command>
Where:
- <FASTSearchFolder> is the path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch.
indexeradmin options
| Option (and short name) | Default Value | Description |
|---|---|---|
--help (-h) |
<none> |
Displays help. |
--version (-v) |
<none> |
Displays version information. |
-a |
<none> |
Runs the commands for all indexers (index columns and indexer rows) in the FAST Search Server 2010 for SharePoint farm. |
--clustername |
webcluster |
This option is not used. Do not set to another value than the default value. |
--subsystem |
indexing |
This option is not used. Do not set to another value than the default value. |
--column= |
0 |
Request information for a specific index column. Set this option without specifying a row option to run the command on all indexer servers (primary and backup) in the specified index column. To find a column identifier, use the command indexerinfo -a status or look up the column number for the indexer servers in the deployment.xml configuration file. |
--row= |
0 |
Request information for a specific indexer row. Row 0 is the primary indexer. Set this option without specifying a column option to run the command on all indexer servers of the same type (primary or backup) in the specified indexer row. To find a row identifier, use the command indexerinfo -a status or look up the row number for the indexer servers in the deployment.xml configuration file. |
indexeradmin commands
| Command | Description |
|---|---|
disabledebug |
Disables debug logging. Disabling debug logging is not persisted to the configuration file. This change will be lost when the indexer restarts. |
enabledebug |
Enables debug logging for troubleshooting. Enabling debug logging is not persisted to the configuration file. This change will be lost when the indexer restarts. |
resetindex |
Re-indexes all content from the pre-index content store (FiXML files). If indexing is suspended, resetindex will resume it. For more information, see Remarks. |
resumeindexing |
Resumes indexing on a suspended indexer. |
selfcheck |
Performs an indexer status and content consistency check. This operation can run a long time and cannot be canceled. |
suspendindexing |
Suspends indexing. When indexing is suspended, the indexer will not start any new indexing jobs. However, the indexer continues to receive items for indexing. These items are stored in FiXML files. Use this command when backing up the data\data_index folder and for conserving system resources with large document submissions. |
enabletracemode |
Enables debug tracing of indexed items. This produces a very detailed log of all indexing activities. |
disabletracemode |
Disables debug tracing of indexed items. |
Examples
To enable debug logging on all indexers (primary and backup) in column 2:
indexeradmin --column=2 enabledebug
To re-build the content index from the FiXML files in column 1:
indexeradmin --column=1 resetindex
Remarks
After item processing the crawled items are distributed to individual index columns based on a statistical routing algorithm. The items are stored in an XML-based pre-index format (FiXML files). The indexer uses the FiXML files as input to the indexing process.
The indexeradmin resetindex command re-builds the content index from the FiXML files. This is normally needed only if the content index files are corrupted or damaged.
Search is available when the resetindex command runs, but new content will not be indexed before the command is finished. Depending on the amount of items, the resetindex command may take many hours.
Note
The resetindex command is different from the SharePoint Server 2010 index reset procedure described in Reset the content index (FAST Search Server 2010 for SharePoint).
The indexeradmin resetindex command performs a local re-build of the content index within one or more indexer server.
The SharePoint Server 2010 index reset procedure will erase the content index and re-crawl all content sources.
See Also
Concepts
Plan FAST Search Server farm topology (FAST Search Server 2010 for SharePoint)
Recommendations: Redundancy and availability (FAST Search Server 2010 for SharePoint)
deployment.xml reference