Skip to main content
Code42 Support

Administration Console Command-Line Interface Reference

Applies to:
  • CrashPlan PROe


You can interact with your Code42 environment through a command-line interface (CLI) as well as the regular graphical interface of the administration console. This article describes the CLI commands available and their uses.

To access the command-line interface, double click the logo in the header of the console.

Before You Begin

If you have any questions about command usage or best practices, contact our Customer Champions​ for CrashPlan PROe support or CrashPlan PRO support.

Use Caution When Modifying Your Code42 Environment
Some of these commands have the potential to interfere with backups, disconnect devices, or potentially destroy data. Some commands cannot be undone.
Because of this destructive potential, take care when modifying your Code42 environment on the command line.

Reading This Article

This article uses several standard conventions to describe command parameters and options.

Arrow Brackets

Text in arrow brackets should be replaced with text specific to your environment. Do not include the arrow brackets in your command.

Example instruction: command <exampleEmail>

Correct commands:

Square Brackets

Text in square brackets indicates an optional command. Do not include the square brackets in your command.

Example instruction: command [option]

Correct commands:
command option

Curly Braces

Text in curly braces separated by pipes indicates mutually exclusive arguments. Do not include the curly braces in your command.

Example instruction: command {abc | def | ghi}

Incorrect command:
command abc def

Correct commands:
command abc
command ghi

Accessing The Command-Line Interface

To interact with your Code42 environment through the command-line interface, open the CLI from the administration console.

  1. Sign in to your administration console in a web browser.
  2. Double-click the logo in the upper left corner of the administration console.
    The command-line interface appears in the administration console.
  3. Enter commands at the top of the command-line interface.
  4. Review the output below.



Send each org manager an alert email listing computers that have been offline or have incomplete backups.



Send each org manager one email report of the backup status for each of their organizations.


CrashPlan PRO only

Print an alert message at the top of the Backup page on all currently connected clients.
alertConnected <title> <message>

Argument Function
<title> Title of the alert message
<message> Body text of the alert message

alertConnected "Testing" "This is a test message" would display for all clients currently connected:
AlertConnected example


Reindex and optimize database tables. This process is run automatically as part of the daily services.


Print the current configuration information to the application log.


Create a new statistics record for organizations, users, and store points, and move the previous entries into the history record. This service runs automatically at the time specified under Settings > Server (default: 2:01 am).


Print the current data balancing information (sources, targets, and matchups) to the application log.

Immediately perform data balancing operations.


Send a command, enclosed in quotation marks, to a client. If the client is not currently online, the command will fail and no action will be taken.
clientCommand "<command>" <guid>

cc "<command>" <guid>

Argument Function
<command> Command to pass to the client device
<guid> GUID of the client device

clientcommand "java option Xmx 1024m" 123456789012345678


Return user ID, name, address, and other information fields for a specific computer.
computer <guid> [deauth]

Argument Function
<guid> GUID of the client device
[deauth] (Optional) Returns deauthorization information. Only applicable for GUIDs that have been deauthorized.


Cryptographic utility.

crypto {status | encrypt <string> | decrypt <string> | hash <string> | hash512 <string> | keystore enable <password> <retype password> | keystore unlock <password>}

Argument Function
status Returns the current state of the secure keystore mode.
encrypt <string> Encrypt a given string using Blowfish. Encrypt requires secure keystore mode to be enabled.
decrypt <string> Decrypt a given Blowfish-encrypted string. Decrypt requires secure keystore mode to be enabled.
hash <string> Hash a given string in a secure, unique, irreversible way. The string is encoded with Base64. The salt is discarded since the hash is irreversible and non-testable. The argument hash uses the SHA-1 function, which is less secure than hash512 but creates a smaller hash result.
hash512 <string> Hash a given string in a secure, unique, irreversible way. The string is encoded with Base64. The salt is discarded since the hash is irreversible and non-testable. The argument hash512 uses the SHA-512 function, which is more secure than hash but creates a larger hash result.
keystore enable <password> <retype password>

Warning: Secure keystore mode will require a password to be entered by the administrator on every server startup.
Warning: Secure keystore mode cannot be disabled.

Enable secure keystore mode: all archive, transport, and encryption keys will be encrypted. Secure keystore mode can only be enabled if there are no computers in the deployment.

keystore unlock <password> Unlock the keystore to allow administrator access. This is a temporary option required on each server startup, used once keystore enable has been used to activate secure keystore mode. Keystore unlock does not reverse the effects of keystore enable.

Manually initiate all services that run daily, and update usage statistics displayed by the administration console. Services include:

  • BulkStatsBroadcast
  • LicenseNotificationService
  • UsageUpdaterService
  • ConnectionAlerter
  • DatabaseDump
  • StorageNodeSyncJob
  • ProviderSyncJob
  • ArchiveRecordService
  • BackupReporter
  • AnalyzeDatabase
  • RepositoryDiskVacuumer



Compare the local user directory with an external user directory, such as LDAP, and update the local directory if needed. Your Code42 environment can only read from the external directory, never write to it.
directory.sync [simulate]

Argument Function
[simulate] (Optional) Return directory information without updating the local directory.


Disconnect all devices, or a single device if given a GUID, from all cloud (non-provider) destinations. Does not deauthorize the device.
disconnect [<guid>]

Argument Function
[<guid>] (Optional) GUID of the device you want to disconnect from all cloud destinations. If guid is not specified, disconnect disconnects all devices from all cloud destinations.


Check the available space on each store point for this enterprise server, and send an email at the thresholds defined in Settings > Server > Alerts.


Send (or "dump") system properties, backup properties, stack traces, disk, and network information to the log file.
dump {all | app | env | backup | manifest | memory | netstat | ifconfig | peer | threads | vss | disk | files}

Argument Function
all Dump all system properties
app Dump application information
env Dump environment information
backup Dump backup information
manifest Dump manifest information
memory Dump memory information
netstat Dump network statistics information
ifconfig Dump IP configuration information
peer Dump peering information
threads Dump threading information
vss Dump Volume Shadow Service information (Windows only)
disk Dump disk information
files Dump file information


Send an email.
email online - Normal online mode
email offline <durationInSeconds> - Simulate an offline email server
email send <sender> <recipient> <subject> [<body>] [count=<n>] - Send email
email log {on|off} - Instead of sending emails to email server, simply log that the emails were sent

Argument Function
online Set your master server's email service to normal online mode
offline Simulate an offline email server. Requires an argument for durationInSeconds.
<durationInSeconds> The duration, given in seconds, of the offline simulation. Used only for the offline argument.
send Send an email using your master server's email service
<sender> The sender of your email. Used only for the send argument.
<recipient> The recipient of your email. Used only for the send argument.
<subject> The subject line of your email. Used only for the send argument.
<body> (Optional) The body text of your email. Used only for the send argument.
[count=<n>] (Optional) The number of emails to send. Used only for the send argument.
log Append log information to the email server without sending the emails. Requires either the on or off argument.


Manually run the export database process, which exports the database to the dumps folder in your installation directory and the root of each store point of this enterprise server.


Clear or view the contents of the failed sync cache. 

The failed sync cache tracks devices that failed to sync with a storage server.

Storage servers use this cache to reduce unnecessary network traffic. By default, the failed sync cache retains information for 60 minutes so that a sync for a particular device is not blocked indefinitely.


failed.sync.cache <clear | dump [<limit>]>

Argument Function
clear Clears the failed sync cache.
dump Dumps the failed sync cache to the dumps folder in your installation directory.
[<limit>] (Optional) Specifies a number indicating the upper limit for the entries to be printed.


Generate a copy of all server logs in a zip file in the log directory.


Synchronize hierarchy and business objects, including information on orgs, store points, and storage servers.


Use hierarchy.sync to update your Code42 environment if you have added an org and want to immediately update that information to all storage servers.


Compare the number of available licenses, and send an email at the thresholds defined in Settings > Server > Alerts.


Manages the locator service, which locates the server that hosts a SharePlan resource. If the locator service is disabled, sharing files and folders with a SharePlan link will not function.

locator { status | enable | disable }

Argument Function
status Shows whether the locator service is enabled or disabled
enable Enables the locator service
disable Disables the locator service


Control logging levels.
log [<category>] [<level>]

Argument Function

(Optional) Specify the category of logs to modify. Common options:

  • com.code42.core.ldap
  • com.code42.ssoauth

The complete list of options is  available by contacting our Customer Champions.


(Optional) Specify the level of logging. Options, listed from most severe to least severe:

  • Error
  • Warn
  • Info
  • Fine
  • Trace

log com.code42.core.ldap FINE  - Enable debug-level logging for LDAP
log TRACE - Enable trace-level logging for e-mail system logs
log com.code42.ssoauth TRACE - Enable trace-level logging for all SSO authorization modules


Information and operations pertaining to the login attempt monitor.

login.monitor {info | disable | enable | reset <username> | maxRetries <number> | lockoutTime <minutes> }

Argument Function
info Print the status of the login monitor, the maximum number of retries, and the lockout duration for failed login attempts
disable Disable login attempt monitoring
enable Enable login attempt monitoring
reset <username> Reset a given user's login attempt status. Requires the <username> argument.
maxRetries <number> Change the number of retries allowed before a user is locked out.
lockoutTime {<minutes> | forever} Change the lockout period to minutes. Specifying forever instead of minutes will permanently lock out users who fail to log in correctly, until an administrator unlocks their accounts.


Instruct a node to restart.
node.restart [<guid>]

Argument Function
[<guid>] (Optional) GUID of the enterprise server to restart. If guid is not specified, node.restart will restart the active enterprise server.


node.restart performs the following actions:

  1. Logs activity to <server folder>/server/libexec/restart.log
  2. Verifies execute permission on <server folder>/server/libexec/
  3. Runs <server folder>/server/libexec/
    1. Loads <server folder>/server/.install.vars
    2. Shuts down the Code42 service
    3. Waits 30 seconds
    4. Starts Code42 service

node.restart may not function properly if .install.vars is incorrect.


Synchronize a storage server with the master server
node.sync [<guid>]

Argument Function
[<guid>] (Optional) GUID of the storage server to sync with the master server. If guid is not specified, node.sync will sync the active storage server with the master server.


Run the storage node automatic upgrade process.
node.upgrade <guid> [<remote version>]

Argument Function
<guid> GUID of the storage server to upgrade. If guid is not specified, node.upgrade will upgrade the active storage server.
[<remote version>] (Optional) The remote version to upgrade


Restart a failed job for organization destination (OrgDestination) management.

When access to a destination is offered (or removed) from an organization, the Code42 master server must create (or delete) the relationships between the destination and all the devices and users in the organization. Because this potentially represents a very long running and heavy load on the enterprise server, several background jobs are scheduled. If one of these jobs fails, a log message is written with instructions on how to restart the failed jobs. Use the org.destination.manage command to restart the failed jobs. Because the log message of the failed job displays all the correct values for the job, use those values for the command arguments.

Advanced Process
Because restarting failed jobs can be complex, we recommend contacting our Customer Champions​ to assist you with the process.


org.destination.manage <orgId> <desinationGuid> <offered> <job> [<limit>]

Argument Function
<orgId> Specify the ID of the organization for which you want to restart the job.
<destinationGuid> Specify the GUID of the destination.
<offered> Specify whether the destination is offered for backup (true or false).
<job> Indicate the job to restart. The possible values are AUTO_STARTCONFIG, PLAN, and USER.  
[<limit>] (Optional) Set the maximum number of objects to process.


org.destination.manage 99999 888777666555444333 true CONFIG
org.destination.manage 99999 888777666555444333 false USER
org.destination.manage 99999 888777666555444333 true PLAN
org.destination.manage 99999 888777666555444333 true PLAN 100
org.destination.manage 99999 888777666555444333 true AUTO_START


Validate an organization's destination assignment script.
org.destination.script.validate <orgId>

Argument Function
<orgId> GUID of the organization to validate


Remove a system property. System properties are case-sensitive.
prop.remove <name>

Argument Function
<name> Name of the system property to remove


Set system property. System properties are case-sensitive.

prop.set <name> <value> [save] [{none|all|destination <guid>}]

Argument Function
<name> Name of the system property to set
<value> Value to assign to the system property
[save] (Optional) Cause the property setting to persist after reboot. If save is not specified, the property setting will revert to its previous setting after reboot.
none Apply the property setting to no enterprise server
all Apply the property setting to all enterprise servers in your Code42 environment. Enterprise servers must be currently online.
destination <guid> Apply the property setting to a specific destination, given by the destination's GUID. Destination must be currently online.
  If none, all, or destination <guid> are not specified, prop.set will set the system property on the local enterprise server.

Show system properties.
Usage: [all] [<filter_string>]

Argument Function
[all] (Optional) List all system properties
[<filter_string>] Filter the list of system properties with a given string


Synchronizes all data in local server database with data in other master servers for which this server is the provider.
provider.sync [<hostedOrgId>]

Argument Function
[<hostedOrgId>] (Optional) Specify to sync the database with a specific hosted org, given by the org's GUID. If hostedOrgID is not specified, provider.sync will sync all data in the database with other master servers for which this server is the provider.


Reconnect all or the given computer to its assigned cloud destination.
reconnect [<guid>]

Argument Function
[<guid>] (Optional) GUID of the computer to reconnect. If guid is not specified, reconnect will reconnect all computers to their assigned cloud destinations.


Synchronize store points between servers. Code42 prefers the use of node.sync.


Run the Repository Disk Vacuumer service to purge archives that have passed the cold storage retention limit.




Automatically authorize deactivated devices. If a device is offline, then it will automatically authorize when it connects.
sendAuthorize <guids> [config] [show] - colon separated.

Argument Function
<guids> GUIDs of the devices you want to authorize. Separate multiple GUIDs with colons.
[config] (Optional) Authorize the given devices, and force the configuration stored on the enterprise server to overwrite the configuration on the target devices.
[show] (Optional) Show the authorization queue.

sendAuthorize 111111111111111111:222222222222222222:333333333333333333 config - Authorize the three devices with the GUIDs 111111111111111111, 222222222222222222, and 333333333333333333 and overwrite their local configuration files with the configuration file from the enterprise server


Enables a shared link to a file or folder.
sharedlink.enable {<URL of shared link> | <token of shared link>}




Disables a shared link to a file or folder.
sharedlink.disable {<URL of shared link> | <token of shared link>}


sharedlink.disable enkDGSdhkRW824O7dNZ1_h2XA


Shut down the enterprise server service.


Show the map names, keys in a map, or the value of a key.
Usage: {maps|<mapName>} [<keyPrefix>] [<limit>]

Argument Function
maps Show the names of all maps in use
<mapName> Show all keys in the mapName map
[<keyPrefix>] (Optional) Filter the keys to only those that begin with keyPrefix
[<limit>] (Optional) Show only the first limit number of keys

Examples: maps - shows the names of all maps in use default - shows all keys in the 'default' map (the default limit is 100 keys) default /st/so/ 50 - shows the first 50 keys starting with '/st/so/' in the 'default' map default /st/so/destguid=42 - shows the object stored in map 'default' at key '/st/so/destguid=42'


List, test, or clear system alerts.
system.alert {list|test|clear [<type>]|info}

Argument Function
list List all system alerts
test Generate a test alert for each type of alert
clear [<type>] Clear alerts. If the optional argument type is included, clear alerts of type type. If type is not included, clear all alerts.
info Show information on the types of alerts available

Send one sample email or a set of sample emails.
Usage: <username> {customizable|code42|subscription|<templatePath>}

Argument Function
<username> Recipient of the sample email, given by a Code42 environment username
customizable Customize the content of the test email
code42 Send a standard Code42 email
subscription Send a standard subscription notice email
<templatePath> Send an email defined by a template stored in your Code42 environment installation path. For example: /emails/templated/recover_password.eml


Update the archiveBytes value with actual usage data from this enterprise server.


Print the version date/time string given a long version number.
version [<number>]


Control configuration of web server redirects on the enterprise server.

web redirect {enable|disable|show|reload}

Argument Function
enable Enable redirection of web server subfolders.
disable Disable redirection of web server subfolders. All currently active administration console sessions are logged out and the CrashPlan PROe web service restarts.
show Show the full list of web server redirections.
reload Reload the list of redirections from the configuration file stored on the enterprise server.