rc.exe reference
Applies to: FAST Search Server 2010
Use the rc tool to collect monitoring data from different parts of a Microsoft FAST Search Server 2010 for SharePoint installation.
The rc tool uses the name service to find all registered component interfaces that satisfy your specified search criteria (data filters).
The rc tool only collects data from running processes.
All FAST Search Server 2010 for SharePoint back-end components can be monitored by using rc. They include the content distributor, document processors, the indexing dispatcher, and indexers.
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\rc [global options] [command options] [<path1> ... <pathN>]
Parameters
| Parameter | Description |
|---|---|
<path1> ... <pathN> |
These parameters specify where (within the name server) the component interfaces (for data collection) are registered. The rc tool will search within these paths. |
<FASTSearchFolder> |
The path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch. |
rc global options
| Global option | Value | Description |
|---|---|---|
-n |
<host:port> |
Connects to the name server at <host:port>. |
rc command options
| Command option | Value | Description |
|---|---|---|
-h |
<none> |
Displays help information. |
-v |
<none> |
Displays version information. |
-r |
<none> |
Traverses the name service for paths to components in a FAST Search Server 2010 for SharePoint back-end that supports rc monitoring. When using this option, <path1> ... <pathN> parameters are interpreted as substrings which are matched against the paths inferred from the name servers. Further commands are only applied to matching paths. Use to filter commands by specific components or subsystems. |
-f |
<type> |
Filters the output by a given type. Valid types are as follows:
Use this option multiple times on the same command line when more than one type is desired. Example: -f int -f float If this option is not supplied, all types are given as output. |
-a |
<none> |
Lists entries of type scope or alloc where the current value is greater than 0. |
-t |
<seconds> |
Specifies a time-out period (in seconds) for rc to wait for a response from the components. rc uses the <path1> ... <pathN> parameters and the name server to look up the physical address of the components. Use 0 (zero) to disable the time-out. |
-s |
<number> |
Specifies the number of times the command should be run. Use the -i option to specify the time to wait between command repetitions. Default: 1. |
-i |
<seconds> |
Specifies the number of seconds to wait before the command is repeated (as set in the -s option). |
-d |
<module:num> |
Sets the debug level on a <module> at the component interface to <num>. Note This changes the log output from the components. |
-V |
<none> |
Prints distinct version strings for paths and then exits. |
Examples
To list all component interfaces with active scopes:
<FASTSearchFolder>\bin\rc -r -a -f scope
To list all processing component interfaces:
<FASTSearchFolder>\bin\rc -r esp/subsystems/processing
To list all floating-point numbers and integers for the content distributor:
<FASTSearchFolder>\bin\rc -f float -f int esp/subsystems/processing/dispatcher/0
To list all unique versions for all component interfaces:
<FASTSearchFolder>\bin\rc -r -V
To list all component interfaces and allocations with active scopes on the remote name server at host <host> and port <port>:
<FASTSearchFolder>\bin\rc -r -a -n <host>:<port>