Skip to main content

Who is this article for?

Incydr
Code42 for Enterprise
CrashPlan for Enterprise

Incydr, yes.

CrashPlan for Enterprise, yes.

Code42 for Enterprise, yes.

CrashPlan for Small Business, no.

This article applies to Code42 cloud environments.

Other available versions:

On-premises

HOME
GETTING STARTED
RELEASE NOTES
FAQs
APIs
SYSTEM STATUS
Code42 Support

Code42 console command-line interface reference

Who is this article for?

Incydr
Code42 for Enterprise
CrashPlan for Enterprise

Incydr, yes.

CrashPlan for Enterprise, yes.

Code42 for Enterprise, yes.

CrashPlan for Small Business, no.

This article applies to Code42 cloud environments.

Other available versions:

On-premises

Overview

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

To access the command-line interface, press Ctrl + Shift + X.

Before you begin

If you have any questions about command usage or best practices, contact our Customer Champions for Code42 for Enterprise support.

Use caution when you modify 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.

Command parameters in 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:
command john.doe@code42.com

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
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

Access the command-line interface

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

  1. Sign in to the Code42 console.
  2. Press Ctrl + Shift + X.
    The command-line interface appears in the Code42 console.
  3. Enter commands at the top of the command-line interface.
  4. Review the output below.

Commands

Agent.userhome

Updates the :user directory for a specific device to correct errors in a user's home path so that files can back up as expected. This command adds the specified directory to the existing :user path for that device to preserve backed up files. Because the command is additive, you can update a device's :user directory even if the backup file selection is locked.

Requires Code42 app v8.6.0 or later
The agent.userhome command requires the device to be online and Code42 app v8.6.0 (or later) on the endpoint for which you want to update the :user directory.

Usage:
agent.userhome <guid> <userHomePath>

Argument Function
<guid> GUID of the client device.
<userHomePath>

Absolute path to the user's home directory on that client device. For example:

  • Windows: C:\Users\johndoe
  • Mac: /Users/johndoe
  • Linux: /home/johndoe

Note: This command accepts the directory path you enter. There is no validation to confirm that the directory exists on the endpoint.

Use one of these methods to confirm the :user directory on a specific endpoint:

Subsequent file selection changes reset the :user directory
If you update the file selection on the Backup tab of the Device Backup Default Settings after using this command, the :user directory resets to use only the most recent path set.

Clientcommand

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

Alias:
cc "<command>" <guid>

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

Example:
clientcommand "java option Xmx 1024m" 123456789012345678

Computer

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

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

Disconnect

Disconnect all devices, or a single device if given a GUID, from all cloud (non-provider) destinations. Does not deauthorize the device.
Usage:
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.

Login.monitor.reset

Reset a given user's login attempt status.

Usage:
login.monitor.reset <username>

Argument Function
<username> Specify the user whose login attempt status you want to reset.

Test.email

Send one sample email or a set of sample emails.

Usage:
test.email <username> {customizable|code42|<templateKeyword>|<templatePath>} 

For example:
test.email admin@example.com customizable
test.email admin@example.com code42
test.email admin@example.com backup_alerts
test.email admin@example.com /emails/templated/admin_initiated_password_reset.eml

Argument Function
<username> Recipient of the sample email, given by a Code42 username.
customizable Send emails that can be customized. (Sends emails that can be customized for Code42 cloud environments as well as on-premises environments.)
code42

Send all Code42 emails.

<templateKeyword>

Send a test email for emails that can be customized in Code42 cloud environments. Valid values are:

  • backup_alerts
  • backup_reports
  • password_reset_user
  • password_reset_admin 
<templatePath>

Send an email defined by a template in the Code42 cloud environment.

Following are some examples:

  • /emails/templated/admin_initiated_password_reset.eml

  • /emails/templated/backup_alert_user.eml

  • /emails/templated/backup_alert_admin.eml

  • /emails/templated/backup_report_admin.eml

  • /emails/templated/backup_report_user.eml

  • /emails/templated/directory_sync_summary.eml

  • /emails/templated/system_alert_admin.eml

  • /emails/templated/user_initiated_password_reset.eml