DiskPulse Server Command Line Utility

DiskPulse Server provides a command line utility allowing one to control one or more servers locally or through the network using batch files and shell scripts. The DiskPulse command line utility is located in the '<ProductDir>\bin' directory.

DiskPulse Command Line Utility Server Commands:

diskpulse -server_show_commands

This command shows disk change monitoring commands configured in the DiskPulse server.

diskpulse -server_execute_command <Monitoring Command Name>

This command synchronously executes the specified disk change monitoring command.

diskpulse -server_start_command <Monitoring Command Name>

This command starts the specified disk change monitoring command and exists.

diskpulse -server_pause_command <Monitoring Command Name>

This command pauses an active disk change monitoring command.

diskpulse -server_reset_command <Monitoring Command Name>

This command resets and clears detected file system changes from an active disk change monitoring command.

diskpulse -server_stop_command <Monitoring Command Name>

This command stops an active disk change monitoring command.

diskpulse -server_show_changes <Monitoring Command Name>

This command shows file system changes detected by a disk change monitoring command.

diskpulse -server_save_report <Command Name> -format <Report Format>

This command saves file system changes detected by a disk change monitoring command to a report file according to the specified report format, which may be set to one of the following values: HTML, TEXT, CSV, XML, PDF and FLR (the native DiskPulse report format). In addition, the command line utility provides the '-report' command line option, which may be used to specify a file name or a directory name to save the report to. If no file name or directory name is specified, the report will be saved in the user's home directory with an automatically generated file name including the current date and time.

diskpulse -server_save_to_database <Command Name>

This command saves detected changes to the SQL database configured on the 'Options' dialog.

diskpulse -server_command_status <Command Name>

This command shows the status of the specified disk change monitoring command.

diskpulse -server_ status

This command shows the DiskPulse Server debug status.

diskpulse -server_show_debug_log

This command shows the DiskPulse Server debug message log.

diskpulse -server_clear_debug_log

This command clears the DiskPulse Server debug message log.

diskpulse -server_set_user <User Name>

This command sets the DiskPulse Server user name. In order to reset a forgotten user name, execute the command locally on the same host where the DiskPulse server is installed on.

diskpulse -server_set_password <Password>

This command sets the DiskPulse Server password. In order to reset a forgotten password, execute the command locally on the same host where the DiskPulse server is installed on.

diskpulse -server_set_port <Server Control Port>

This command sets the DiskPulse server control port (default is 9120). After executing this command, the DiskPulse service should be restarted. In order to be able to connect to the server through the network the server control port should be open in the server's firewall.

diskpulse -server_export_config <Configuration File Name>

This command exports the DiskPulse Server configuration to the specified file.

diskpulse -server_import_config <Configuration File Name>

This command imports the DiskPulse Server configuration from the specified file.

diskpulse -server_register_online -customer <Customer Name> -key <Unlock Key> -servers <Server1;Server2;ServerX>

This command performs the online product registration procedure for one or more DiskPulse servers via the network. The command should be executed on a host directly connected to the Internet. Internet access for the registered DiskPulse servers is not required.

diskpulse -server_export_product_id -directory <Directory> -customer <Customer> -key <Unlock Key> -servers <Server1;Server2;ServerX>

This command exports product ID files from one or more DiskPulse Servers to the specified directory.

diskpulse -server_import_unlock_file -directory <Directory>

This command performs the manual product registration procedure via the network using unlock files located in the specified directory.

Command Line Options:

-host <Host Name>

Sets the host name of the DiskPulse server to connect to (default is localhost).

-port <Port Number>

Sets the DiskPulse server control port number to connect to (default is 9120).

-user <User Name>

Sets the DiskPulse server user name to login with (default is 'admin').

-password <Password>

Sets the DiskPulse server password to login with (default is 'admin').