This site hosts the documentation for CrashPlan PROe version 3.8.2010.
Looking for documentation on PROe version 3, released in April of 2012? Please visit our current documentation.
Looking for documentation on PROe version 3, released in April of 2012? Please visit our current documentation.
Table of Contents
PRO Client Commands
Overview
You can issue specific commands to the client computer using the PRO Client's command line. You'll use these commands most often when troubleshooting.
Accessing the Command Line
- Open PRO Client and double-click on the logo in the upper right corner.
A text input area appears at the bottom of the application window.
- In the input area, enter the command and press enter.
The text input area closes.
Command Reference
Use commas to separate multiple commands on a line.
| Command | Effect |
|---|---|
| dump all | Print the client's state and configuration to the logs for easy reading. If possible, always issue this command before sending the logs to support. |
| pause | Pause outgoing backups for 60 minutes. Add number of minutes to pause for a different period: E.g. pause 30 pauses for 30 minutes. |
| pause.system | Pause all incoming and outgoing backups. (also accepts a 'minutes' argument) |
| resume | Resume a paused backup. |
| backup.scan | Scan the file selection for changes. |
| exit | Exit the UI and turn off the background CrashPlan backup service. |
| restart | Exit the UI and restart the background backup service. |
| deauthorize | Log out the current user. Generally used to switch to a different user account. |
| guid | Force the client to generate a new GUID for itself. For releases prior to 3.8.2010: Always link with the restart command. |
| guid <GUID> | Force the client to switch to the provided GUID. For releases prior to 3.8.2010: Always link with the restart command. |
| backup.replace <DEST-GUID> | Recreates the client-side cache with data from the destination |
Invoking Commands from a Script
PRO Client commands may be invoked from an external process using some Java code included with the standard distribution. As a convenience, we also include a simple shell script named cli.sh which can be used to invoke a command. A sample invocation of cli.sh might look like the following:
./cli.sh pause
If the command requires one or more arguments then both the service name and the parameters must be wrapped in single or double quotes:
./cli.sh "pause 3"
Installation Instructions for cli.sh
- Download the file from cli.sh. The shell script is bundled in a gzipped tarball.
- Extract the shell script from the download.
- Install the script in the “bin” directory of your PRO Client distribution. Filesystem layout is here.
- Make sure the script has executable permissions
Note: cli.sh and the external invocation of manual commands are not supported