PRO Server Command Line Tools

Your PRO Server includes a collection of command-line tools and utilities that can perform various administrative tasks. These tools are contained in the “bin” directory of your PRO Server installation. The default full path to this directory on all support platforms can be found in the Reference Guide

Scripts on Windows platforms end in ”.bat” extension. On all other platforms they end in ”.sh” extension.

The reset_admin_password tool sets the password for the “admin” user to it's default value (also “admin”). The tool requires a single parameter containing four or more characters of the master license string used with this PRO Server.

Note: Providing some or all of the master license registration key is not acceptable; the first few characters of the license string itself must be provided. See below for an example.

We begin by assuming a PRO Server configured to use the following master license:

• Registration key: CT47-J9TS-MH7K-2CCW
• License string: hMjLE/ywPvrTgKGQ+KeOWTIA8jTvwyJh4ONMy6632rB1DXVTmoztoYKxL7…

Given this configuration we can reset the password for the “admin” user on this server by way of the following process on Linux:

bmcguire@varese:$ /opt/proserver/bin/reset_admin_password.sh "hMjLE/y"
Resetting admin credentials

Attempting to load system properties from /home/bmcguire/proserver/server/conf/proserver.properties
  properties loaded
Configuring environment ...
  registering an appropriate driver
  retrieving connection specifications
  JDBC URL: jdbc:h2:/home/bmcguire/proserver/server/db/proserver;IFEXISTS=TRUE;MAX_LENGTH_INPLACE_LOB=16384;DEFAULT_LOCK_TIMEOUT=30000;WRITE_DELAY=0;LOG=2
  opening a connection
Examining master license key fragment ...
  key fragment validated
Mar 31, 2010 11:19:31 AM com.code42.crypto.SecureRandomUtil <clinit>
INFO: SecureRandom instance CREATED.
Resetting administrator credentials ...
  attempting update
  proper update detected, committing changes.
Reset completed normally

Note that we wrapped the master license string in double-quotes. Many master licenses include characters that are not alphanumeric. These characters can sometimes have specific meaning within command-line environments, so in order to cause the whole string to be passed into the tool (and to avoid having these characters interpreted as special commands) the master license string fragment should be quoted.

Finally, note that attempting to provide the registration key as an argument to the tool is not successful:

bmcguire@varese:$ /opt/proserver/bin/reset_admin_password.sh "CT47"
Resetting admin credentials

Attempting to load system properties from /home/bmcguire/proserver/server/conf/proserver.properties
  properties loaded
Configuring environment ...
  registering an appropriate driver
  retrieving connection specifications
  JDBC URL: jdbc:h2:/home/bmcguire/proserver/server/db/proserver;IFEXISTS=TRUE;MAX_LENGTH_INPLACE_LOB=16384;DEFAULT_LOCK_TIMEOUT=30000;WRITE_DELAY=0;LOG=2
  opening a connection
Examining master license key fragment ...
  key fragment invalid!
ERROR: Master License Key not valid. Reset attempt abandoned.

The restore_database tool rebuilds the embedded database used by PRO Server based on the contents of a database dump file. The 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 PRO Server as part of it's nightly process. You can find the default location for these database dumps in the Planning Guide

Note: There are a number of files in the “bin” directory with similar names. Only the restore_database tool should be used to restore a database dump from the command-line; the other scripts have a very different purpose.

Below is an example using this tool on Linux to perform a database restore:

bmcguire@varese:bmcguire@varese:$ /opt/proserver/bin/restore_database.sh ../data/dumps/proserver-db_1257447376927_2010-03-31-11-57-03.sql.gz
Shutting down PRO Server...
Starting PRO Server...

We should note a few things about this process:

• The script will automatically shut down your PRO Server (if it's running) before importing your database.
• The script will automatically start your PRO Server once the restore is completed.
• You can use relative or absolute paths to point to the database dump file to use for this restore.
• The path to the database dump file does not need to be surrounded by double quotes unless it contains spaces. This is more common on some operating systems (OS X) than on others (Linux or Solaris).
• On Windows, the script must be run from the bin directory.

The reset_https_keystore script resets the PRO Server's https keystore to the default, self-signed SSL certificate. It is designed for recovery in instances when an incorrectly configured custom keystore has been imported into the PRO Server.

Below is an example using this tool on Linux to reset the https keystore:

bmcguire@varese:bmcguire@varese:$ /opt/proserver/bin/reset_https_keystore.sh
Password:
Shutting down PRO Server...
CrashPlanPROServer unloaded cleanly.
Resetting the keystore to default settings

We should note a few things about this process:

• The script will automatically shut down your PRO Server (if it's running) before resetting the https keystore.
• The script will automatically start your PRO Server once the restore is completed.