VX Search Logo

VX Search Server Command Line Utility

In addition to the web-based management interface, VX Search Server provides a command line utility allowing one to control one or more VX Search Servers locally or via the network. The VX Search command line utility is located in <ProductDir>/bin directory.

VX Search Server Command Line Syntax:

vxsearch -server_show_commands

Shows file search commands configured in VX Search Server.

vxsearch -server_start_command <Command Name>

Starts the specified file search command.

vxsearch -server_stop_command <Command Name>

Stops the specified file search command.

vxsearch -server_command_status <Command Name>

Shows the current status of a file search command.

vxsearch -server_command_errors <Command Name>

Shows process errors for a file search command.

vxsearch -server_delete_command <Command Name>

Deletes the specified file search command.

vxsearch -server_export_reports -reports_dir <Directory>

Exports file search reports to the specified directory.

vxsearch -server_import_reports -reports_dir <Directory>

Imports file search reports from the specified directory.

vxsearch -server_status

Shows the current VX Search Server status.

vxsearch -server_debug_log

Shows the VX Search Server debug log.

vxsearch -v

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

vxsearch -help

This command shows the command line usage information.

Options:

-host <Host Name>

Specifies the host name or an IP address of VX Search Server to connect to. If not specified, the command line utility will connect to the local host.

-port <Port Number>

Specifies the TCP/IP port to connect to. If not specified, the command line utility will connect to the default VX Search Server TCP/IP port 9123.

-user <User Name>

Specifies a user name to login to VX Search Server. If not specified, the command line utility will login using the default 'admin' user name.

-password <Password>

Specifies a password to login to VX Search Server. If not specified, the command line utility will login using the default 'admin' password.

VX Search News

8-Jun-2026

VX Search v18.2 redesigns the file search progress dialog, improves the performance of the file search operations and improves the fault tolerance of the file search operations. In addition, the new product version improves the disk activity monitor tool pane, improves the system status monitor tool pane, improves the main VX Search GUI application and fixes a number of bugs.

11-May-2026

VX Search v18.1 adds support for new file types to the built-in file classification plug-ins allowing one to search specific types of files and improves the file search statistics pie charts. In addition, the new product version adds support for new types of file search rules, improves the file search rules dialog, improves the VX Search command line utility and fixes a number of bugs.

More News