Manage Endpoint Agent Settings

The Labels feature has been upgraded to Tags. All your existing labels have been automatically migrated to the new tagging system with no action required on your part. Existing labels were converted to a tag key with an empty value (for example, a label named subnet-10 is now a tag with the key subnet-10 and no value). You can now manage all tags centrally by navigating to Manage > Tags.

Existing Endpoint Agents can be reviewed and managed from the Endpoint Experience > Agent Settings section of the ThousandEyes web application:

For information about agent health states, reasons, impacts, recommended actions, and onboarding history, see Explain Endpoint Agent Health with Explainability Logging.

To add a new Endpoint Agent, see the Installation documentation.

The following information about each agent is provided in the main table:

Field Name	Description
Name	The name of the agent, followed by the list of usernames of the most recent users with Endpoint Agent to log into the system.
Tags	A chevron will appear to the right of the agent name for each tag currently assigned to the agent. Hover over the chevrons to display a tooltip with the names of the tags. If no tags are assigned, this space is blank.
Agent Version	The version of the Endpoint Agent software (not the same as the version of the Browser Extension). A yellow dot indicates a version that is not the current version. Hover over the dot to view the current version.
Serial Number	A unique hardware identifier assigned by the manufacturer for asset tracking and device identification. Requires Endpoint Agent version 2.31.0 or later.
Browser extension	Indicates the state of browser extensions. Extension icons for Chrome, Internet Explorer, and Edge appear once the extension is installed. Icons display a green dot for an active extension and a yellow dot for inactive extension. Icons are grey if the extension has been uninstalled.
Current location	The location of the agent at the time of last contact, based on geolocation information such as client IP address.
Last Contact	Time elapsed since last contact with the ThousandEyes application.
Last Modified	The date when the agent's configuration or software was last modified.
License Type	The type of license consumed by the agent. Possible values are Advantage or Essentials.

To see detailed information about a single agent, select the relevant entry in the table to open the Endpoint Agent settings panel.

Read-only Agent Name field for a RoomOS Endpoint Agent

The side panel contains the following information about the agent. Some details can be edited/configured, and are marked below.

Configuration Option	Description
Agent Name	The agent's name (configurable via a text field). For RoomOS Endpoint Agents, this field is read-only when Obtain RoomOS name from ControlHub is enabled. To change the name while this setting is enabled, rename the device in Control Hub.
Proxy	The proxy the agent uses for scheduled tests (configurable via a drop-down menu. See [proxies](https://docs.thousandeyes.com/product-documentation/global-vantage-points/endpoint-agents/configuring/endpoint-agent-proxy-configuration-for-scheduled-tests)).
License Type	The type of license on which the agent is running (configurable via a drop-down menu. See [Endpoint Agent Licensing](https://docs.thousandeyes.com/product-documentation/global-vantage-points/endpoint-agents/endpoint-agent-licensing)).
Current Lables	The list of currently applied Endpoint Agent dynamic tags (see [Manage dynamic tags for Endpoint Agents](https://docs.thousandeyes.com/product-documentation/global-vantage-points/endpoint-agents/configuring/dynamic-tags) for configuration options).
Assigned Scheduled Tests	A 24 hour timeline of scheduled tests assigned/running on the agent.
Tests	A list of all tests running/assigned on the agent.

If any changes are made to the Endpoint Agent, click Save Changes, or Cancel to revert the changes.

To see more details about the agent and the system on which the agent is installed, click the Show Agent Details link in the top right corner of the panel.

This panel extension shows the following information:

Field Name	Description
Created	The date when the agent was created.
Hostname	The hostname of the system on which the agent is installed.
OS Version	The operating system and version on which the agent is installed.
Serial Number	The unique hardware serial number of the device on which the agent is installed.
NIC model	The model of the Wi-Fi network interface when the agent uses a wireless connection (Windows).
NIC driver version	The driver version for the Wi-Fi network interface when the agent uses a wireless connection (Windows).
Battery health	The battery state of health, expressed as the percentage of currently available maximum capacity relative to its original design capacity. Available on battery-powered devices only.
Memory	The physical memory of the system on which the agent installed.
Manufacturer	The manufacturer of the system on which the agent installed.
Model	The model number of the system on which the agent installed.
Users	Usernames of users who have one or more browser extensions installed in their profile.
Support tools	Additional options for further detailed information.

Disabling an Endpoint Agent

An Endpoint Agent can be disabled from the ThousandEyes UI at the Endpoint Experience > Agent Settings page. To disable an Endpoint Agent, click the agent's row to display the details panel then click the Disable button in the lower left corner of the panel:

Disabling an agent will immediately display "Disabled" in the agent's Last Contact field on the Agent Settings page:

While disabled, the Endpoint Agent collects no test data but does check in with ThousandEyes every 15 minutes for configuration changes and software updates.

The Endpoint Agent browser extension is updated separately from the Chrome Web Store (Chrome extension) or the Microsoft Add-ons Store (Internet Explorer or Edge extension).

Re-enabling a disabled Endpoint Agent

A disabled Endpoint Agent can be enabled from the ThousandEyes UI at the Endpoint Experience > Agent Settings page. To enable the agent, click the agent's row to display the details panel then click the Enable button in the lower left corner of the panel.

Re-enabling an agent will immediately update the agent's Last Contact field, but the agent will receive a new configuration at the next check-in, which will occur within 15 minutes.

Systems with Disabled Agents

Disabling an Endpoint Agent from the ThousandEyes application also affects the browsers with the Endpoint Agent extension installed. Systems with agents disabled from the application display a greyed-out ThousandEyes icon in each browser with the Endpoint Agent extension installed. Hovering over the icon will display a tooltip with a message indicating that the agent is disabled:

The disabled icon is displayed upon first check-in after the Agent is disabled from the application.

Status of the Endpoint Agent Browser Extension

You can view the status of the Browser Extensions installed per agent in the UI at the Endpoint Experience > Agent Settings page of the ThousandEyes web application:

Hovering over the extension icon shows its status and version:

The browser icons can be two colors: green or amber:

• The icon is green if the agent detects the extension as enabled (regardless of whether the extension is active or inactive).

  In some cases, the agent cannot detect whether the extension is enabled. In such cases the icon is green only when the extension is active, which in turn means that the agent has seen data from that extension within the last 24 hours.

• The amber color means that the extension is installed (and most likely enabled) but is inactive, which in turn means that the user has not navigated to a matching domain within browser session settings or used the browser recorder.

  In scenarios where the agent cannot find an extension installed on a browser; the icon of the corresponding browser is faded and is marked with amber color.

Auto - manage the status for Endpoint Agents

The Agent Status Settings located on the top right of the Agent Settings page provides you with configuration options to automatically manage and handle the statuses of endpoint agents.

These options allow you to configure the number of days after which the agents can be disabled or deleted, thereby utilizing the licenses optimally. You can also configure the number of days an active but disabled agent can be re-enabled.

For example, you can auto-disable agents that were inactive for 10 days, as the end-users may be on vacation, and free up their corresponding licenses. Similarly, you can configure the number of days (say 20 days) in which the disabled agents get re-enabled, if they show some activity.

The Agent Status Settings provide the following three options:

• Auto-disable - This setting allows you to configure the number of days after which an inactive agent can be disabled. If selected, this setting gets applied instantaneously to the exisitng agents and lists all the affected agents in the right-hand column.

Once applied, this setting will continue monitoring the existing agents periodically and disable the agents that meet the configured condition. You can find these impacted agents in the activity log.

• Auto-delete - This setting allows you to configure the number of days after which a disabled agent can be deleted. If selected, this setting gets applied instantaneously to the existing agents and lists all the affected agents in the right-hand column.

Once applied, this setting will monitor the existing agents periodically and delete the disabled agents that meet the configured condition. You can find these impacted agents in the activity log.

• Auto-enable - This setting allows you to configure the number in which a disabled agent can be enabled if it shows some activity. If selected, this setting applies instantaneously to the existing agents and lists all the affected agents in the right-hand column.

Once applied, this setting will continue monitoring the existing agents periodically and enable the disabled agents that meet the configured condition. You can find these impacted agents in the activity log.

The number of days configured to auto-enable the disabled agents must be less than the number of days configured to auto-delete the disabled agents.

Transfer Ownership of an Endpoint Agent.

Transfer Ownership via Agent Settings

This method can be used to transfer the ownership of agents across:

• the organization but in different account groups.

• different organizations but in the same region (the user must have access to both account groups in the different organizations).

When you transfer the ownership of an Endpoint Client Agent to another account group, the device's history is retained in the original account group. Endpoint Client Agents should not be rapidly moved between multiple account groups.

Offline Endpoint Agents will effectively complete the transfer after they are online and do a check-in with the ThousandEyes platform.

To transfer ownership of an Endpoint Agent Client to another Account Group:

1. Navigate to the the UI at the Endpoint Experience > Agent Settings page of the ThousandEyes web application:

1. In the UI at the Endpoint Experience > Agent Settings page, identify the desired agent, either by scrolling down the list, searching for the agent with the search function, or using the available filters to focus on the list of agents shown.

2. Click the three dots icon at the end of the agent row.

3. Click Transfer Ownership. The Transfer Agent Ownership pop-up will open.

4. Select the desired Account Group from the drop-down and click Transfer to confirm.

Transfer Ownership across different regions using Connection String.

ThousandEyes for Government users and organizations cannot transfer agents across different regions using the connection string.

For more information on ThousandEyes for Government prerequisites and configuration options, see ThousandEyes for Government - FedRAMP® Moderate.

In this method, you can transfer one or all of your agents; the status of the agent(s) will, however, remain as "transferring" until you manually delete the agent(s) from the original account, which you can safely do once the agent(s) are registered in the new account.

The following example explains the transfer of ownership across organizations:

Consider the following scenario of transferring a desired agent from Organization A to Organization B and follow the steps mentioned below:

1. Obtain the Connection String of Organization B from the UI installer in the ThousandEyes web application.

2. Within the ThousandEyes web application, switch to the corresponding Account Group of Organization A, where the agent will be transferred.

3. Navigate to the UI at the Endpoint Experience > Agent Settings page of the ThousandEyes web application:

1. In UI at the Endpoint Experience > Agent Settings page, identify the desired agent by scrolling down the list, searching for the agent with the search function, or using the available filters to focus on the list of agents shown.

2. Click the agent's row to display the details panel and click on the Show Agent Details link in the top-right corner.

1. In the Region Transfer section, pass the Connection String parameter of Organization B.

2. Click Save Changes to initiate the transfer. The selected agent will now display their status as Transferring.

This is equivalent to using the agent re-installation procedure to transfer the agents. The main difference is the re-installation method allows the transfer of any number of agents instead of all.

Transfer Ownership of All the Agents across different regions using Connection String.

The following example explains the transfer of ownership across organizations:

Consider the following scenario of transferring all the agents from Organization A to Organization B and follow the steps mentioned below:

1. Obtain the Connection String of Organization B from the UI installer in the ThousandEyes web application.

2. Within the ThousandEyes web application, switch to the corresponding Account Group of Organization A, from which all the agents will be transferred.

3. Navigate to the the Endpoint Agents > Agent Settings page of the ThousandEyes web application and click the Agent Status button on the top-right:

   
4. In the Region Transfer section, pass the Connection String parameter of Organization B.

5. Click Apply to initiate the transfer. The selected agents will now display their status as Transferring.

Accessing the Agent Views/ Views for the Agent

You can access the data of a specific agent from the Agent Settings page in the Agent Views or the general Views sections.

To access the Agent Views/ Views:

1. Navigate to the UI at Endpoint Experience > Agent Settings page of the ThousandEyes web application:

1. In the UI at Endpoint Experience > Agent Settings page, identify the desired agent, either by scrolling down the list, searching for the agent with the search function, or using the available filters to find the desired agent.

2. Click the three dots icon at the end of the agent row.

3. Click either the Open in Agent Views or the Open in Views, a new window will open showing the data for the selected agent in the Views or Agent Views tabs respectively.

If you click Open in Views, the Views page opens with the default metric in Local Networks.

Exporting Endpoint Agent Data

The Downloads option located on the top right of the Agent Settings page, provides you with options to download the data for the agents. You can either download the data for all the agents or select the desired agents (by checking the corresponding check-box) and download their data specifically. The data is downloaded in CSV format.

The following example of a downloaded CSV file demonstrates the data associated with an agent gets downloaded:

The data exported also includes additional data that is not displayed on the Agent settings page.

Field Name	Description
Agent Name	Name of the Agent.
Agent Status	Status of the agent. It can either be Enabled or Disabled.
Creation Time	Date and time on which the agent was created.
HostName	The hostname of the system on which the agent is installed.
Agent Type	Type of the agent. It can either be Endpoint Agent or Endpoint Agent Pulse.
Agent Version	The client version of the agent.
Users	Name of the user's machine.
Is TCP Driver Available	Indicates the availability of the TCP driver.
NPCAP Version	The version of the NPCAP library supported by the agent.
Browser Extension Status	The browser agents installed on the agent and their respective status.
Browser Extension Chrome Version	The version of Chrome browser extension installed on the agent.
Browser Extension Edge Version	The version of Edge browser extension installed on the agent.
Browser Extension IE Version	The version of IE browser extension installed on the agent.
Platform	The operating system or the platform on which the agent is deployed.
OS Version	Version of the operating system installed on the machine on which the agent is deployed.
Memory	The physical memory of the system on which the agent installed.
Manufacturer	The manufacturer of the system on which the agent installed.
Model	The model number of the system on which the agent installed.
VPN Name	The name of the VPN used by the machine.
VPN Gateway Address	The virtual address used by the VPN at the host side.
VPN Client Address	The virtual address used by the VPN at the client side.
VPN Client Network Range	The address range associated with the VPN.
Public IP Address	Public IP address of the system on which the agent is installed.
Private IP Address	Private IP address of the system on which the agent is installed.
Location	The location of the agent at the time of last contact, based on geolocation information such as client IP address.
Latitude	The geographical latitude coordinates of the agent at the time of last contact.
Longitude	The geographical longitude coordinates of the agent at the time of last contact.
Last Seen Time	Date and time at the last contact.
Last Modified Time	The date and time when the agent's configuration or software was last modified.
AS Name	Name of the service provider.
AS Number	The Autonomous System Number (ASN) associated with the system on which the agent is installed.

Managing Multiple Endpoint Agent Simultaneously

It is possible to simultaneously manage multiple agents from the ThousandEyes application's Endpoint Agent Settings page. To begin with:

1. Select all the agents you intend to manage, by selecting the check-boxes corresponding to the desired agent.

1. You can now select an option, for example, Disable all the selected agents, by clicking the Disable button located in the bottom ribbon along with the other operations such as deleting, transferring the ownership, of the selected agents.

Advanced Agent Settings

Use Advanced Agent Settings to manage account-level Endpoint Agent behavior, including allowed NPCAP versions and RoomOS agent name syncing.

Managing Allowed NPCAP Versions

For more information, see NPCAP Driver Upgrade Management.

The default NPCAP version bundled with the Endpoint Agent installer is always on the allowlist for your account. The versions you add in Advanced Agent Settings are additional allowed versions. They extend the default list instead of replacing it.

To add additional versions:

1. Go to Endpoint Experience > Agent Settings, and select the Advanced Agent Settings tab.

Allowed NPCAP versions in Advanced Agent Settings

1. Add the NPCAP driver versions that you want to support.

2. Select Save Changes, and confirm the list of supported NPCAP driver versions in the dialog.

Selecting additional NPCAP versions

Select Reset To Default to revert to the default supported versions, and then select Save Changes.

Syncing RoomOS Agent Names from Control Hub

In the RoomOS Control section, the Obtain RoomOS name from ControlHub setting controls whether supported RoomOS Endpoint Agents use their Control Hub device names as their agent names in the ThousandEyes platform.

When the setting is disabled, RoomOS Endpoint Agents keep their existing naming behavior. ThousandEyes uses the device hostname or SEPMAC address when an agent first registers, and you can edit the agent name in Endpoint Experience > Agent Settings.

When the setting is enabled:

• A supported RoomOS Endpoint Agent adopts its Control Hub device name on its next check-in.

• The agent name becomes read-only in the ThousandEyes platform.

• Changes to the device name in Control Hub sync to the ThousandEyes platform on subsequent check-ins.

This setting requires RoomOS version 11.39.0.0 or later, or version 26.7.0.0 or later.

RoomOS Control settings in Advanced Agent Settings

For more information about the initial naming behavior for RoomOS Endpoint Agents, see Naming RoomOS Agents.