Agents reference

Overview

The Agents page displays details about all endpoints with a Code42 agent installed. Use the Agents screen to view a list of agents, review details and settings, and perform actions on agents.

Agents and devices
Throughout this article, agent refers to an installed instance of Code42 software (the insider risk agent or backup agent). Device refers to the physical endpoint upon which the agent is installed.

Agents

To view the agents list, select Administration > Environment > Agents. Agents appear in this list after connecting to the Code42 cloud for the first time. 

Agents list

Legacy agent end-of-life
On April 10, 2024, the Code42 legacy agent reached end-of-life. Devices with the legacy agent still appear on this screen to help you identify which devices need to be upgraded, but these devices are no longer backing up, and Incydr monitoring has stopped. See our FAQ for steps to upgrade to a supported agent. 

Item Description
a Issue summary

Displays the total number of agents with the following issues:

  • Not connected to Code42 cloud
  • No file events in past 7 days
  • Error sending file events

Click View agents to update the list below to show only agents with issues.

b Export Export icon Exports the current list of agents to a CSV file and downloads it to your local device. For information on the fields included in the export, see Device CSV export fields.
c Filter

Filters the list by the criteria you select. By default, the table is filtered to show all active agents.

  • Hostname: Enter a partial or full hostname to view a specific device.
    If you enter a partial hostname, only devices with hostnames that begin with those characters appear.
  • GUID: Enter an agent's Globally Unique Identifier (GUID) to view only that agent. GUIDs are included in CSV exports, various reports throughout the Code42 console, and the Code42 API.
  • Organization: Select an organization to view agents in that organization. Optionally, begin typing an organization name to view suggested matches.
  • Agent type: Select an agent type (insider risk agent, backup agent, or legacy agent) to view only devices with that agent installed.
  • Agent issue: Select one or more issues to view agents not connected to the Code42 cloud or with errors sending events.
  • Status: Select Active or Deactivated.
  • Last connected: Select a custom date range to view only agents that have not connected within that timeframe, for example, greater than 30 days. 
  • Backup alert status: Select one or more backup alert statuses to view devices that meet those activity thresholds.

An agent must match all specified filters to be included in the results.

d Filtered by Identifies the filters applied to the list. Click the X to remove a filter.
e Hostname

The name of the device as reported by the device's operating system. The Hostname is a device property that is not managed by Code42. If an authorized user changes the hostname of the device, the new hostname may take up to 24 hours to update in the Code42 console.

f Status The agent's status: ActiveDeactivated, or Blocked. For more details, see Block, deauthorize, and deactivate.
g Issues

Indicates known issues with the agent:

  • Not connected to Code42 cloud
  • No file events in past 7 days
  • Error sending file events

A green check indicates there are no known issues with the agent.

h Agent type

Indicates the Code42 agent type installed on the device.

  • Insider risk agent: Monitors endpoint and cloud activity to detect risk
  • Backup agent: Backs up user files

Available agent types vary based on your product plan.

Legacy agent end-of-life
On April 10, 2024, the Code42 legacy agent reached end-of-life. Devices with the legacy agent are no longer backing up, and Incydr monitoring has stopped. See our FAQ for steps to upgrade to a supported agent. 

i Version

Version number of the Code42 agent installed on the device.

Insider risk agent version number details

The version number includes two values, for example: 1.6.2 (1.7.0). The two numbers reflect the insider risk agent's architecture, which includes two distinct components: a launcher and a service.

  • The first number is the App version, which indicates the version of the executable used to start the Code42 AAT Service. Some non-Code42 locations, such as third-party deployment tools and properties displayed by a device's operating system, only display this number.
  • The second number (in parenthesis) is the Feature pack version, which indicates the features and functionality of the agent. This number is used throughout the Code42 console. In most places, it is displayed alongside the App version.
j Operating system

Operating system for this device.

k Last check-in (UTC) 

The last time the agent connected to the Code42 cloud. Hover over a value to see the exact timestamp.

-

Last backup activity (UTC)

(not pictured)

The last time any backup activity occurred for this agent.

Backup and legacy agent only

-

Backup alerts

(not pictured)

Indicates backup activity status, based on the warning and critical thresholds defined in Organization Details:

  • OK - The most recent backup activity does not exceed the defined warning or critical threshold.
  • WarningBackupAlert - The agent has not backed up to any destination for longer than the number of days specified for the warning threshold.
  • CriticalBackupAlert - The agent has not backed up to any destination for longer than the number of days specified for the critical threshold.

If an agent is backing up to multiple destinations, the most severe alert is listed. To view the backup status for each destination, select the agent to open the agent's details.

Backup and legacy agent only

l View Click to open the agent details to view more information about the agent. 
Devices with multiple entries
A single device is displayed multiple times when:
  • The insider risk agent and backup agent are installed on the same device.
  • The backup agent is installed per user for multiple user accounts.

Agent details

Click any row in the Agents table to view more details about that agent. You can also access details by selecting an agent in the User Detail View.

Agent details

Item Description
a Hostname

The name of the device as reported by the device's operating system. The Hostname is a device property that is not managed by Code42. If an authorized user changes the hostname of the device, the new hostname may take up to 24 hours to update in the Code42 console.

b Status The agent's status: Active, Deactivated, or Blocked. For more details, see Block, deauthorize, and deactivate.
c Agent issues

Indicates known issues with the agent:

  • Not connected to Code42 cloud
  • No file events in past 7 days
  • Error sending file events

If no issues apply, No agent issues appears.

d Username The username signed in to the Code42 agent on this device. Click the link to view the user's profile.
e Actions

Lists actions to perform on the agent:

Insider risk agent
Backup agent
  • Edit device backup defaults: Displays Device Settings where you can edit settings for this device.
  • Activate / Deactivate
  • Block / Unblock
    • Block: Signs out the user and prevents future sign-in for this device until the device is unblocked. Backup continues and archives remain active and stored.
    • Unblock: Unblock a blocked device to allow the user to sign in again.
  • Deauthorize: The current user is signed out of the Code42 agent, but users can sign in again at any time. Backup stops until the user signs in again. 
  • Replace device: Designate that this device should assume the backup archive and GUID of another device. View tutorial for additional information.
  • Upgrade: Manually initiate an upgrade for this device, intended for testing the Code42 agent upgrade prior to upgrading all of your devices. Once a manual upgrade has been started, it cannot be canceled. Status information during the upgrade is displayed on the device. 

    This action is available only when a Code42 agent upgrade is available and device auto-upgrades is disabled.

  • Pause backup: Pauses backup for the device.
  • Resume backup: Resumes a paused backup for this device.
  • Restart backup engine: Restarts the backup engine for this device.
  • Verify file selection: Scan folders for file changes and deleted files.
  • Retrieve agent logsDownload logs for this device.
f Operating system

The device's operating system: Windows, Mac, or Linux.

g Serial number A unique identifier reported by the device's operating system.
h IP address The IP address the Code42 agent last reported to the Code42 cloud (as reported by the device's operating system).
i GUID The Code42 Globally Unique Identifier for this agent.
j Agent type

Indicates the Code42 agent type installed on the device.

  • Insider risk agent: Monitors endpoint and cloud activity to detect risk
  • Backup agent: Backs up user files

Legacy agent end-of-life
On April 10, 2024, the Code42 legacy agent reached end-of-life. Devices with the legacy agent are no longer backing up, and Incydr monitoring has stopped. See our FAQ for steps to upgrade to a supported agent. 

k Agent version

Version number of the Code42 agent installed on the device.

Insider risk agent version number details

The version number includes two values, for example: 1.6.2 (1.7.0). The two numbers reflect the insider risk agent's architecture, which includes two distinct components: a launcher and a service.

  • The first number is the App version, which indicates the version of the executable used to start the Code42 AAT Service. Some non-Code42 locations, such as third-party deployment tools and properties displayed by a device's operating system, only display this number.
  • The second number (in parenthesis) is the Feature pack version, which indicates the features and functionality of the agent. This number is used throughout the Code42 console. In most places, it is displayed alongside the App version.
-

Authority connection

(not pictured)

Indicates the agent's connection status:

  • Online: The agent is currently connected to the Code42 cloud
  • Offline: The agent is not currently connected to the Code42 cloud

Backup agent and legacy agent only

-

Restores

(not pictured)

The number of restores initiated for files backed up from this device. Click the number to view the device's Restore history.

Backup agent and legacy agent only

l

Last check-in

The last time the agent connected to the Code42 cloud. Hover to see the exact timestamp. 

Insider risk agent only

m Date created Date the agent was initially added to Code42.
--

Profile Backup

(not pictured)

The most recent date that the USMT ScanState command ran successfully and created a MIG file. A green checkmark indicates the last ScanState command succeeded. A red exclamation point indicates the last ScanState command failed.

Only appears for:

--

Reference

(not pictured)

Notes about the device for reference. For more information, see Add reference information to devices, users, and organizations.

Insider risk agent only. Reference information for the backup agent appears in the settings tabs.

Agent secrets

Requires insider risk agent version 1.10.0 or later. Windows and Linux devices only.

If Uninstall secrets are enabled for your organization, uninstalling the insider risk agent from a user's device requires an authorization code. To uninstall the agent as part of troubleshooting a single device, you can provide a device-specific code to the end user so they can uninstall the agent. Unlike the organization-wide secrets listed in Deployment > Uninstall secrets, agent secrets are only valid for 6 hours and are unique to each device. To view agent secrets, you must be a Customer Cloud Admin or Org Admin role.

To uninstall with an agent secret:

  1. From the Agent details, click the Agent secret tab.
    To view agent secrets, you must have the Customer Cloud Admin or Org Admin role.
  2. Click Show to view the secret.
  3. Click the copy icon copy-icon-source.png to copy the secret to your clipboard.
  4. Include the secret as a parameter in the uninstall command.
    Agents requiring an uninstall secret can only be uninstalled via the command line.

Agent-secrets-2023-09-20.png

Backup agent

Devices with the backup agent include additional details about backup status and settings.

Device backup details

Item Description
a Destination Name of the backup destination. The icon next to the destination name indicates whether the destination is a cloud destination (cloud icon) or a local destination (hard drive icon).
b Selected Amount of data on this device selected for backup.
c Backup Status

Progress bar representing the amount of data backed up and the amount remaining. The amount displayed is refreshed at least once every 15 minutes.

Progress bar colors represent alert state:

  • Green - No alert
  • Yellow - Warning state
  • Red - Critical state

Warning and critical states are determined by reporting settings.

If there are multiple backup sets backing up to the same destination, indicates the combined status of all backup sets. (Code42 agent version 10.x and earlier indicates the status of the backup set with the most recent activity.)

d Last Activity The time since this device sent any backup data to the specified destination.
e Completed

The time since this device last completed a backup to the specified destination. 

If there are multiple backup sets backing up to the same destination, indicates the time since all backup sets completed. (Code42 agent version 10.x and earlier indicates the time since the most recent backup set completed.)

f Used storage Total amount of data stored in this device's backup archive at the specified destination.
g Restore

Displays the Web Restore window, from which you can select files to restore from this destination. View tutorial for additional information.

h Archive options

The archive action menu provides options to:

  • Maintain archive: Reclaims space in the backup archive by immediately applying file selection or retention policy changes (such as how many versions to keep and how long to keep deleted files). Overrides the Maintain archives… interval.
  • Resume backup: Resumes a backup that has been paused for a selected device.
  • Pause backup: Pauses backup for a selected device.
i Settings

Read-only display of settings for this device. Go to Actions > Edit device backup defaults to change settings.

For more details about each tab, see:

Restore history

Backup agent only

View the Devices: Backup Restore History screen by clicking the number of restores from the Device details.

Restore history

Item Description
a Device name

The name assigned to the device by Code42. By default, Device Name uses the Hostname reported by the device's operating system.

Users and administrators can change the Device Name in the Code42 agent, and in the Code42 console via Actions > Edit device backup details > General.

b Operating System Displays the operating system of the device that received the restored data.
c User User whose data was restored. An info icon  appears if another user initiated the restore (for example, an administrator restoring from the Code42 console).
d Restore to Device that received the restored data. Click to view the Device details.
e # Files Number of files restored.
f Size Total size of the restored files.
g Transfer rate Speed in Mbps of the file restoration.
h Restore date Date and time the files were restored.
i Duration Total time to restore the files.
j Export Click to export the restore history details to a CSV file and download it to your local device. See Restore history CSV export fields below for descriptions of all included fields.

Restore history CSV export fields

Export the restore history table to a CSV file by selecting Export . The following attributes are exported to the CSV file.

Field Description
user User whose backup data was restored.
deviceName Name of device that received the restored data. This is the name assigned to the device by Code42. Users and administrators can change this name.
numFiles Number of files that were restored.
numBytes Total size of the files restored.
transferRateBytesPerSecond Speed in Mbps of restore job.
startDate Date the restore started.
endDate Date the restore finished.
acceptingDeviceId ID of the device that received the restored data.
acceptingDeviceName The name of device that received the restored data. This is the name assigned to the device by Code42. Users and administrators can change this name.
acceptingDeviceOsHostname The name of the device that received the restored data, as reported by the device's operating system. The osHostname is a device property that is not managed by Code42, but if an authorized user changes the hostname of the device, the new hostname may take up to 24 hours to update in the CSV export and Code42 console.
acceptingDeviceOsName Operating system of the device that received the restored data.
acceptingDeviceOsVersion Version of the operating system of the device that received the restored data.
acceptingType Type of device.
acceptingUserFirstName First name of the user whose device accepted the restored data.
acceptingUserId ID of the user whose device accepted the restored data.
acceptingUserLastName Last name of the user whose device accepted the restored data.
acceptingUsername User name of the user whose device accepted the restored data.
completedDate The date the restore finished.
rateByesPerSecond Speed in Mbps of restore job.
requestingUserId ID of the user who requested the restore.
restoreBytes Total bytes restored.
restoreFiles Number of files restored.
restoreId ID of the restore job.
sourceOrgId ID of the organization where the restored files originated.
sourceUserId ID of the user whose files were restored.
startDate Date the restore began.

Agent CSV export fields

Export the current list of agents to a CSV file by selecting Export . The following attributes are exported to the CSV file.

Field Description
computerId Identification number for the device.
name The name assigned to the device by Code42. By default, name uses the osHostname reported by the device's operating system, but users and administrators can change the name in the Code42 agent and/or Code42 console.
osHostname

The name of the device as reported by the device's operating system. The osHostname is a device property that is not managed by Code42, but if an authorized user changes the hostname of the device, the new hostname may take up to 24 hours to update in the Code42 console and CSV export.

guid Globally Unique Identifier for the device.
status Active, deauthorized, deactivated, or blocked
active TRUE: Device is active
FALSE: Device is deactivated
blocked TRUE: Device is blocked
FALSE: Device is not blocked
alertState Backup alert state of this device.
userId Identification number of the device's user.
orgId Identification number of the device's organization.
lastConnected Time when the device last connected to the Code42 cloud.
osName Operating system of the device.
osVersion Version of the operating system of the device.
osArch Architecture of the device.
address IP address that the Code42 agent last reported to the Code42 cloud.
remoteAddress

Device's IP address.

javaVersion Version of Java that the Code42 agent uses on this device.
timeZone Time zone the device last reported to the Code42 cloud.
displayVersion Version number for the device's installation of the Code42 agent.
service Indicates which service the device is using.
targetComputerId Identification number of the device used for computer-to-computer backup.
targetComputerGuid Globally Unique Identifier for the device used for computer-to-computer backup.
targetComputerName Name of the backup destination of the device used for computer-to-computer backup.
targetComputerOsName Operating system for the device used for computer-to-computer backup.
targetComputerType Type of device used for computer-to-computer backup. This is either a SERVER or DEVICE.
selectedFiles Total number of files selected for backup from this device.
selectedBytes

Total number of bytes selected for backup.

todoFiles

Total number files remaining to back up.

todoBytes

Total bytes of data remaining to back up.

archiveBytes

Total bytes the archive occupies on disk.

billableBytes Amount of data that is billable.
lastActivity Time since the device sent any backup data to the specified destination.
lastCompletedBackup Time since the device last completed a backup to the specified destination.
lastConnected Time when this device last connected to a storage destination.
This field differs from the first instance of lastConnected returned in the CSV export, which indicates the time when the device last connected to the Code42 cloud.
using

TRUE: An archive for the device exists in the Code42 environment.

FALSE: No archive exists for the device in the Code42 environment.

targetAlertState Deprecated. No longer in use.
percentComplete Percentage of backup that is complete.
userUid Unique identifier of the user.
computerExtRef Customer-provided reference for the device.

modelInfo

Device's hardware model information.

creationDate

Date the device was first registered.

modificationDate

Time when the device's database record was last updated.

loginDate

Time when the device last connected to the Code42 cloud.
upgradeAvailable

Whether a new version of the Code42 agent is available for the device. Values are true or false.