Skip to main content
Code42 Support

Enterprise Server Command Line Tools

Applies to:
  • CrashPlan PROe

Overview

All enterprise server installations contain a collection of command line tools and utilities that can perform various administrative tasks. This reference guide details the tools and utilities available to you.

Location

These tools are contained in the bin directory of your enterprise server installation:

  • Linux/opt/proserver/bin
    ​Applies to enterprise servers installed as root on Ubuntu
  • WindowsC:\Program Files\CrashPlan PROe Server\bin
  • OS X/Applications/PROServer.app/Contents/Resources/Java/bin/

On Linux, OS X, and Solaris, these tools are shell scripts. On Windows, they are batch scripts. You must run all scripts from the bin directory as the user that owns the enterprise server process. On Windows, this means running the scripts from a command prompt with administrator permissions.

Reset Admin Credentials

The reset_admin_credentials tool resets the username and password for the local administrator account to their default values:

  • Username: admin
  • Password: admin

Usage

reset_admin_credentials [mlk fragment]

For security reasons, the reset_admin_credentials tool requires a single parameter containing the first four or more characters of the master license key used during the initial installation of your enterprise server. If your master license key has changed, you must use the original master license key to reset credentials.

You must run the command as the user that owns the enterprise server process. On Windows, you must run it from a command prompt with administrator permissions.

Example

This example command was run on an OS X enterprise server from /Applications/PROServer.app/Contents/Resources/Java/bin:

sudo ./reset_admin_credentials.sh InGIx

user:bin user$ sudo ./reset_admin_credentials.sh InGIx
Password:
Shutting down PROe Server...
CrashPlanPROServer unloaded cleanly.
Resetting admin credentials

Attempting to load config from /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.groovy, /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.mac.groovy, /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.properties
  config loaded
[06.26.12 11:00:22.418 INFO    main                 root                                    ] logPath: /Library/Logs/PROServer
Configuring environment ...
  registering an appropriate driver
  retrieving connection specifications
  JDBC URL: jdbc:h2:/Library/Application Support/CrashPlan/PROServer//db/proserver;IFEXISTS=TRUE;DEFAULT_LOCK_TIMEOUT=30000;WRITE_DELAY=0;ACCESS_MODE_DATA=rwd;DB_CLOSE_ON_EXIT=FALSE
  retrieving connection credentials
  opening a connection
Examining master license key fragment ...
  key fragment validated
Resetting administrator credentials ...
  attempting update
  proper update detected, committing changes.
Reset completed normally
Starting PROe Server...
  71166 ??         0:16.09 /usr/bin/java -Dapp=CrashPlanPROServer -Dprogram.name=CPServer -Xss128k -XX:PermSize=256m -Xms256m -Xmx1024m -XX:+UseAdaptiveGCBoundary -XX:+DisableExplicitGC -Djava.awt.headless=true -Djava.net.preferIPv4Stack=true -Dsun.net.inetaddr.ttl=300 -Dnetworkaddress.cache.ttl=300 -Dsun.net.inetaddr.negative.ttl=0 -Dnetworkaddress.cache.negative.ttl=0 -Ddrools.compiler=JANINO -Dfile.encoding=UTF-8 -server -classpath lib/com.backup42.app.jar com.code42.core.impl.Core -prop conf/conf_proe.properties -config conf/conf_proe.groovy -config conf/conf_proe.mac.groovy

Restore Database

The restore_database tool rebuilds the embedded database used by enterprise server based on the contents of a database dump file. The tool is designed to assist with recovery following system or hardware failure or for moving a enterprise server installation from one machine to another.

Usage

restore_database [path]

The restore_database tool requires a single parameter containing the full path to the database dump file to use for this restore. Database dumps are generated automatically by your enterprise server as part of its nightly process.

Note: There are files in the enterprise server's bin directory with similar names. Only restore_database should be used to restore a database dump from the command line; other scripts have very different purposes.

Example

This example command was run on a Mac enterprise server from /Applications/PROServer.app/Contents/Resources/Java/bin. The specified database dump is from the Store Point located at /backups/CrashPlanArchive_m66019504823x001.

sudo ./restore_database.sh /backups/CrashPlanArchive_m66019504823x001/dbDumps/proserver-db_1332824401321_2012-06-26_121011.sql.gz

Output

user:bin user$ sudo ./restore_database.sh /backups/CrashPlanArchive_m66019504823x001/dbDumps/proserver-db_1332824401321_2012-06-26_121011.sql.gz
Password:
Shutting down PROe Server...
CrashPlanPROServer unloaded cleanly.
Attempting to load config from /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.groovy, /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.mac.groovy, /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.properties
  config loaded
[06.26.12 12:11:14.313 INFO    main                 root                                    ] logPath: /Library/Logs/PROServer
Unwrapping database dump file
Re-generating database from dump file
Moving current database into backup database
Moving generated database into current database
Cleaning up: removing unwrapped file
Restore complete!
Starting PROe Server...
  71431 ??         0:19.35 /usr/bin/java -Dapp=CrashPlanPROServer -Dprogram.name=CPServer -Xss128k -XX:PermSize=256m -Xms256m -Xmx1024m -XX:+UseAdaptiveGCBoundary -XX:+DisableExplicitGC -Djava.awt.headless=true -Djava.net.preferIPv4Stack=true -Dsun.net.inetaddr.ttl=300 -Dnetworkaddress.cache.ttl=300 -Dsun.net.inetaddr.negative.ttl=0 -Dnetworkaddress.cache.negative.ttl=0 -Ddrools.compiler=JANINO -Dfile.encoding=UTF-8 -server -classpath lib/com.backup42.app.jar com.code42.core.impl.Core -prop conf/conf_proe.properties -config conf/conf_proe.groovy -config conf/conf_proe.mac.groovy

Reset HTTPS Keystore

The reset_https_keystore tool sets your enterprise server's SSL certificate back to the self-signed certificate included in the base enterprise server installation. The most common use case for this tool is when a enterprise server's HTTPS keystore has been configured incorrectly and the enterprise server service does not start.

Usage

reset_https_keystore

There are no arguments associated with the reset_https_keystore tool.

Example

This example command was run on a Mac enterprise server from /Applications/PROServer.app/Contents/Resources/Java/bin.

sudo ./reset_https_keystore.sh

Output

user:bin user$ sudo ./reset_https_keystore.sh
Password:
Shutting down PROe Server...
CrashPlanPROServer unloaded cleanly.
Resetting the keystore to default settings

Attempting to load config from /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.groovy, /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.mac.groovy, /Applications/PROServer.app/Contents/Resources/Java//conf/conf_proe.properties
  config loaded
[06.26.12 14:07:22.377 INFO    main                 root                                    ] logPath: /Library/Logs/PROServer
Configuring environment ...
  registering an appropriate driver
  retrieving connection specifications
  JDBC URL: jdbc:h2:/Library/Application Support/CrashPlan/PROServer//db/proserver;IFEXISTS=TRUE;DEFAULT_LOCK_TIMEOUT=30000;WRITE_DELAY=0;ACCESS_MODE_DATA=rwd;DB_CLOSE_ON_EXIT=FALSE
  opening a connection
Resetting keystore settings ...
Reset completed normally
Starting PROe Server...
  71706 ??         0:20.12 /usr/bin/java -Dapp=CrashPlanPROServer -Dprogram.name=CPServer -Xss128k -XX:PermSize=256m -Xms256m -Xmx1024m -XX:+UseAdaptiveGCBoundary -XX:+DisableExplicitGC -Djava.awt.headless=true -Djava.net.preferIPv4Stack=true -Dsun.net.inetaddr.ttl=300 -Dnetworkaddress.cache.ttl=300 -Dsun.net.inetaddr.negative.ttl=0 -Dnetworkaddress.cache.negative.ttl=0 -Ddrools.compiler=JANINO -Dfile.encoding=UTF-8 -server -classpath lib/com.backup42.app.jar com.code42.core.impl.Core -prop conf/conf_proe.properties -config conf/conf_proe.groovy -config conf/conf_proe.mac.groovy