About command-line tools (FAST Search Server 2010 for SharePoint)

 

Applies to: FAST Search Server 2010

Microsoft FAST Search Server 2010 for SharePoint provides command-line tools for many system administration tasks.

Using FAST Search for SharePoint command-line tools

Many FAST Search Server 2010 for SharePoint operations are run and controlled with command-line tools, instead of from a Central Administration page. Typical tasks include monitoring system performance, running and controlling the FAST Search Web crawler, using connectors to extract documents, and controlling the FAST Search Server 2010 for SharePoint indexers.

Note

To use the command-line tools, 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.

Categories of command-line tools

FAST Search Server 2010 for SharePoint command-line tools cover these operational areas.

Operational Area	Command-Line Tool	Task
General administration	infotool.exe	Create a zipped system report that includes log files, configuration files, and performance data. Use for system diagnostic work.
	rc.exe	Collect monitoring data from FAST Search Server 2010 for SharePoint components, such as the content distributor, document processors, indexing dispatcher, and indexers.
	nctrl.exe	Manage the node controller; perform operations such as start, remove, and resume for all FAST Search Server 2010 for SharePoint components.
	psctrl.exe	Change the settings, retrieve statistics, and view the status of a processor server.
	nameserver_client.exe	Retrieve a set of entries from the FAST Search Server 2010 for SharePoint nameserver, representing middleware server objects. Use for debugging only.
Monitoring service	monitoringserviceconfig.exe	Install, reconfigure, or uninstall WMI classes and performance counters published by the FAST Search Server 2010 for SharePoint monitoring service.
FAST Search Web crawler	crawler.exe	Start a single node or multiple node FAST Search Web crawler. This is a server process that will rarely be run from a command line.
	crawleradmin.exe	Configure, control, and monitor crawl collections. Add, update, or delete crawl collections. Suspend or resume content feeding.
	crawlerdbtool.exe	View entries in the FAST Search Web crawler databases. View information about URIs that were crawled.
	crawlerconsistency.exe	Verify and repair the consistency of the FAST Search Web crawler document and metadata structures on disk.
	beadmin.exe	Control and monitor the browser engine. View processing statistics. Process individual URIs.
	postprocess.exe	Manually refeed items to content indexing for one or more crawl collections.
	ppdup.exe	Start a duplicate server to provide a centralized duplicate detection function for each node scheduler/postprocess host.
Connectors	jdbcconnector.bat	Extract items from JDBC sources that will be indexed in FAST Search Server 2010 for SharePoint
	lotusnotesconnector.bat	Extract items from Lotus Notes sources that will be indexed in FAST Search Server 2010 for SharePoint.
	lotusnotessecurity.bat	Extract user and group information from Lotus Domino directories that will be used for security in search results.
	connectorpwgen.bat	Encrypt passwords used by the FAST Search database connector and the FAST Search Lotus Notes connectors.
Indexing and item processing	doclog.exe	Retrieve status and logs of recently processed items.
	indexeradmin.exe	Remotely control one or more indexers. Suspend new items from being indexed. Enable debug logging. Defragment the intermediate FIXML files.
	indexerinfo.exe	Retrieve information about the indexer (the number of documents indexed, the status of the indexing process).
	docpush.exe	Feed one item into a FAST Search Server 2010 for SharePoint installation.
	pm.exe	Diagnose problems related to item feeding and indexing. pm processes logs and reports problems from components such as the FAST Search connector Content Search Service Application, the content distributor, the indexing dispatcher, and command-line clients such as docpush.
Search	searchinfo.exe	Retrieve information about the search nodes.
Analytical tools	waadmin.exe	The WebAnalyzer analyzes data to improve the relevance of search results by counting and analyzing links. Use waadmin.exe to configure the WebAnalyzer, schedule the hyperlink analysis, and retrieve status information.
	spreladmin.exe	SPRel is a clickthrough log analysis engine that improves search results relevancy by analyzing the entries that users click on in search result sets. Use spreladmin.exe to configure SPRel, to schedule the clickthrough log analyses, and to retrieve status information.