1. Code42 Support
  2. Incydr
  3. Incydr administration
  4. Code42 console reference

Code42 console command-line interface reference

Updated

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 Technical Support Engineers.

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

Sends a command to a specific user device. If the target device is offline, the command is sent the next time the device is online.

The example below is specific to the loglevel command.

Usage:
agent.command create <guid> loglevel <modulename> <level>

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

Sends the log level change command to the device.
<modulename>

(Optional) Specifies to which agent module the log level change applies. If no module name is provided, the change applies globally to all logs.

In most cases, the modulename argument can be omitted. However, a Code42 Technical Support Engineer may instruct you to apply changes to a specific module to reduce unwanted log noise.
<level>

Specifies the logging level. In order of details logged, the levels are: trace, debug, info, warning, error, critical

  • Trace provides the most logging detail. 
  • Critical provides the least logging detail.
  • The default level is info.

Example:
agent.command create 123456789012345678 loglevel debug

agent.userhome

Backup agent only

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 agent v8.6.0 or later
The agent.userhome command requires the device to be online and Code42 agent 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

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 

Backup agent only

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

Backup agent only

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

Backup agent only

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.

purge.path

Backup agent only

Deletes files and directories from any backup archives in which they are found. When this command is executed, Code42 searches all archives for files or directories that use the specified file path and then deletes them from those archives. Immediately removing files and directories from backup archives can help remove malware and assist with protecting sensitive or confidential data.

Notes:

  • Before executing this command, delete the files or directories from the endpoint. If they remain on the endpoint and in the backup file selection for that device, Code42 will back up the data again.
  • Affected files are immediately deleted from backup archives.
  • Affected file paths are immediately removed from the restore view in the Code42 console.
  • Affected file paths may remain visible for a short time in the restore view in the Code42 agent, but the files cannot be restored. File paths are completely removed from view after maintenance completes.
  • The user executing the command must have one of these roles:

Usage:
purge.path <switch> <GUID> <file path>

Argument Function
<switch>

(Optional) Specifies additional controls that affect how the command is executed. Leave the switch out if it is not needed.

Use the -legalHoldPurgeAllowed switch to delete the file path from legal hold archives when both of the following are true:

  • The file path is found in a legal hold archive.
  • The user executing the command has a role that includes the legalhold.all permission.
<GUID> GUID of the client device.
<file path>

Absolute path to the files or directories to delete from archives. 

For example:

  • Windows: C:\Users\johndoe\Documents\example.txt
  • Mac: /Users/johndoe/Documents/example.txt
  • Linux: /home/johndoe/Documents/example.txt

When entering file paths:

  • Enclose the file path in quotation marks if it contains any spaces.
  • File paths must exactly match the spelling and capitalization of the paths to the files or directories to be deleted.
  • File paths that end with a directory separator (such as "\" or "/") are treated as directories. The directory and all files it contains are deleted from the archive.
  • File paths to root directories are ignored and are not deleted.

Example:
purge.path 123456789012345678 "C:\Users\johndoe\Documents\2021 Forecasts Milestones.docx" 

test.email

Backup agent only

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