infotool.exe reference
Applies to: FAST Search Server 2010
Use infotool to create a zipped system report that includes system and performance information in addition to log and configuration files.
The infotool report is used for:
Troubleshooting a problem with Microsoft Support - Generate a report before contacting support staff.
Backing up a system for reproduction purposes - Microsoft FAST Search Server 2010 for SharePoint includes functionality to back up configuration files and database content that can be restored to a new system. When backing up a scenario, run infotool with the backup pipeline option to include a backup in the report file
Run infotool without any parameters to create a default report stored in <FASTSearchFolder>\var\log\infotool\infotool_date-time.
If your installation includes sensitive content, run infotool with the declassify pipeline option to remove secure content from the report.
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\infotool [options]
Parameters
| Parameter | Description |
|---|---|
<FASTSearchFolder> |
The path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch. |
infotool options
| Option | Value | Description |
|---|---|---|
-h |
Displays help information. |
|
-v |
Displays version information. |
|
-t |
Tests a pipeline configuration (specified with the -p option) for semantic errors. Used for debugging. |
|
-p |
default|declassify|backup |
Specifies the pipeline to run from InfotoolConfig.xml. Default: default. |
-c |
Clocks the running time of each collector. |
|
-d |
Enables debug logging to provide more detailed information. |
|
-r |
Routes the output to a specified file. If the path is not absolute, the base directory is <FASTSearchFolder>\var\log\infotool. |
Examples
Default run
To run infotool with the default pipeline:
<FASTSearchFolder>\bin\infotool
This command routes output to <FASTSearchFolder>\var\log\infotool\infotool_date-time\infotool_default.zip.
Declassify option
To remove sensitive or secure information from infotool's report, use the declassify pipeline.
First, record the strings that should be removed from log and configuration files that are included in the infotool report in the file <FASTSearchFolder>\etc\infotool\Declassifier.xml as follows:
<declassifier>
<strip>hostname_to_be_removed</strip>
</declassifier>
Replace hostname_to_be_removed with the host reference to delete from the infotool output. Add multiple <strip> elements to remove additional secure content.
Then run:
<FASTSearchFolder>\bin\infotool -p declassify
to compile the output in <FASTSearchFolder>\var\log\infotool\infotool_date-time\infotool_declassify.zip. This .zip file references all deleted strings (defined in Declassifier.xml) as: REMOVED_[number]].
Note
The declassify pipeline does not remove sensitive content from the infotool.log file, which is copied into the infotool_declassify.zip file. Manually check the log and configuration files in the .zip file for sensitive content before sharing the file in a non-secure environment.
Backup option
The infotool backup option includes a backup in the report file that provides support when reproducing an environment. Infotool does not provide restore functionality.
To run infotool with the backup pipeline:
<FASTSearchFolder>\bin\infotool -p backup
which routes output to <FASTSearchFolder>\var\log\infotool\infotool_date-time\infotool_backup.zip. This .zip file includes a backup folder that contains output from the backup Windows PowerShell script in <FASTSearchFolder>\bin\backup.ps1. It is not possible to declassify the contents of the backup pipeline without causing problems with content restoration.
Remarks
The default and backup pipelines collect firewall rules from both the localhost and nodes in the deployment.xml configuration file, if available by netsh. To include these rules in your report, you must run infotool as an administrator.
The backup pipeline only includes backup contents for single-node installations of FAST Search Server 2010 for SharePoint. For farm installations, you must run the backup.ps1 script manually to include backup contents.