Using Command Line Utility

In addition to the VX Search GUI application, VX Search Ultimate and VX Search Server provide a command line utility allowing one to execute file search operations from an OS shell window. The VX Search command line utility is located in <ProductDir>/bin directory.

Command Line Syntax:

vxsearch -search <File Filter> -dir <Directory 1> [ ... Directory X ]

Searches files in the specified directories, disks or network shares.

vxsearch -search <File Filter> -server <hostname1;hostname2;hostnameX>

Searches files in all network shares of the specified servers or NAS storage devices.

vxsearch -search <File Filter> -network

Searches files in all servers and/or NAS storage devices detected on the network.

vxsearch -search -regex <Regular Expression> -dir <Directory 1> [ ... Directory X ]

Searches files using a regular expression.

vxsearch -search <XML Search Rules File> -dir <Directory 1> [ ... Directory X ]

Searches files in the specified directories, disks or network shares.

vxsearch -execute <Search Profile Name>

Executes the specified file search operation.

vxsearch -execute <XML Search Command File>

Executes the specified file search operation.

Parameters:

-dir <Directory>

This parameter specifies an input directory, disk or a network share for the file search operation. In order to ensure proper parsing of command line arguments, directories containing space characters should be double quoted.

Options:

-save_html_report [ File Name ]

Saves an HTML report to the specified file.

-save_text_report [ File Name ]

Saves a text report to the specified file.

-save_csv_report [ File Name ]

Saves an Excel CSV report to the specified file.

-save_xml_report [ File Name ]

Saves an XML report to the specified file.

-save_pdf_report [ File Name ]

Saves a PDF report to the specified file.

-save_report [ File Name ]

Saves search results to the VX Search native report format.

-save_to_database

Saves search results to an SQL database.

-title <Report Title>

Sets the report title.

-compress

Instructs to export a GZ compressed report.

-show_users

This option enables processing and display of files user names.

-scanners <Max Dir Scan Threads>

This option sets the maximum number of parallel directory scanning threads.

-streams <File Search Threads>

This option sets the number of parallel file search threads.

-perf <FULL | MEDIUM | LOW>

This parameter controls the speed of the storage analysis process.

FULL - Full-speed storage analysis
MEDIUM - Medium-speed storage analysis
LOW - Low-speed storage analysis

-v

Shows the product major version, minor version, revision and build date.

-help

Shows the command line usage information.