ThousandEyes Documentation
  • ThousandEyes Documentation
  • What's New
    • Changelog
    • Naming and Navigation Menu Changes - Summary List
  • Product Documentation
    • Getting Started
      • Getting Started with Account Setup
      • Getting Started with Cloud and Enterprise Agents
      • Getting Started with Cloud and Enterprise Agent Tests
      • Getting Started with Endpoint Agents
      • Getting Started with Transactions
      • Getting Started with Dashboards
      • Getting Started with Alerts
      • Getting Started with Internet Insights
      • Getting Started with the ThousandEyes API
      • Getting Started with API Tests
      • Getting Support from ThousandEyes
      • Notification of Upgrades, Maintenance and Outages
      • New User FAQ
      • ThousandEyes Glossary
    • Global Vantage Points
      • Cloud Agents
        • Where Are Cloud Agents Available?
        • Webex Cloud Agents
        • AWS Wavelength Cloud Agents
        • Cloud Agent with Local Problems
      • Enterprise Agents
        • Getting Started
          • Where Can I Get the Account Group Token?
        • Installing
          • Enterprise Agent System Requirements
            • Enterprise Agent Support Lifecycle
          • Appliances
            • How to Set Up the Virtual Appliance
            • Enterprise Agents: Hypervisor Installation
            • Installing Enterprise Agent on VirtualBox
            • Enterprise Agent Deployment Using ThousandEyes Virtual Appliance (Hyper-V)
            • Enterprise Agent Deployment Using ThousandEyes Virtual Appliance (OVA)
            • Custom Virtual Appliances
            • Installing a Physical Appliance
            • Installing an Enterprise Agent on a Raspberry Pi Device
          • Cisco Devices
            • Catalyst Switching
            • Catalyst Routing
            • Nexus Switching
            • Service Routing
            • Meraki MX Appliances
            • Cisco Enterprise NFV Infrastructure Software
            • Installation Methods
              • Installing Enterprise Agents on Cisco Nexus Switches with Application Hosting
              • Installing Enterprise Agents on Cisco Nexus Switches with Guestshell
              • Installing Enterprise Agents on Cisco Routers using SD-WAN Manager Feature Templates
              • Installing Enterprise Agents on Cisco Routers using the SD-WAN Manager ThousandEyes Workflow
              • Installing Enterprise Agents on Cisco Switches with Docker
              • Installing Enterprise Agents on Cisco Routers with Docker
              • Installing Enterprise Agents on Cisco Switches with the DNA Center
          • Linux Packages
            • Enterprise Agent Deployment Using Linux Package Method
            • Installing the Enterprise Agent with BrowserBot on Oracle Linux Server 7
          • Docker Agents
            • Installing Enterprise Agents with Docker
          • Cloud Templates
            • Installing Enterprise Agents with Microsoft Azure
          • Docker Agent Configuration Options
          • Missing Dependencies for Enterprise Agent on Redhat Enterprise Linux RHEL 7 Installation
          • Migrating ThousandEyes Appliance or Package-Based Enterprise Agent to Docker
        • Configuring
          • Password Reset on the Virtual Appliance
          • Configuring rDNS Lookups for Enterprise Agents
          • Connecting to the ThousandEyes Virtual Appliance Using SSH (Mac/Linux)
          • Connecting to the ThousandEyes Virtual Appliance Using SSH (Windows)
          • Static IP Addresses for ThousandEyes Repositories
          • Firewall Configuration for Enterprise Agents
          • Enterprise Agent Port Forwarding
          • Security Policy and Public NTP Servers on Enterprise Agents
          • Secure Access to ThousandEyes Appliances
          • Disabling the Web Server of a Virtual Appliance
          • NAT Traversal for Agent-to-Agent Tests
          • Enterprise Agent on Docker Advanced Networking
        • Managing
          • Cisco Devices
            • Disable, Restart, or Uninstall the Enterprise Agent via DCNM
          • Docker Agents
            • Add/Remove BrowserBot from Existing Docker Enterprise Agents
          • Upgrading Operating Systems for Enterprise Agents
          • Backup and Restore Your Enterprise Agent Configuration
          • Upgrade Ubuntu 20.04 Focal-Based ThousandEyes Appliances
          • Crash Reporting for Enterprise Agents
          • Configuring a Local Mirror of the ThousandEyes Package Repository
          • Resetting an Enterprise Agent
          • Working with Enterprise Agent Clusters
          • Replacing an Enterprise Agent Using the Agent Clustering Method
          • Replacing an Enterprise Agent Using Agent Identity Files
          • Unlocking the ThousandEyes Appliance
          • Uninstalling the Enterprise Agent (Linux Package)
        • Proxy Environments
          • Installing Enterprise Agents in Proxy Environments
          • Configuring an Enterprise Agent to Use a Proxy Server
          • Writing and Testing Proxy Auto-Configuration (PAC) Files
        • Troubleshooting
          • How to Generate Packet Captures
          • Troubleshooting Automatic-Update Problems on Enterprise Agents
          • Troubleshooting Time Synchronization on Enterprise Agents
          • Installing CA Certificates on Enterprise Agents
          • Agent Unable to Trace Path to Destination?
          • BrowserBot Installation Fails on Red Hat or CentOS in Amazon EC2
          • What to Do If te-agent Stops Running Due to a VACUUM Error
        • Enterprise Agents: What Information Do We Collect?
        • What Is BrowserBot?
        • Upgrading to BrowserBot 2
        • Upgrading to BrowserBot 2.6+ (Chromium 97)
        • Enterprise Agent Utilization
        • Network Utilization from Enterprise Agent Test Traffic
        • Enterprise Agent Interface Selection
        • ThousandEyes Product Lifecycle Policy
      • Endpoint Agents
        • Installing
          • System Requirements
          • Download the Endpoint Agent Installer
          • Install the Endpoint Agent
          • Reinstall the Endpoint Agent
          • Install the Endpoint Agent Browser Extension
          • Install Endpoint Agents for Windows via Group Policy
          • Installing Browser Extensions for Windows via Group Policy
          • Guidance for Windows Software Deployment Teams
          • Install Endpoint Agents for macOS using Munki and the Managed Software Center
          • Deploy an MSI package to Intune for Windows Devices
          • Endpoint Agent Installation on Cisco Webex Devices (RoomOS)
          • Endpoint Agent Installation on Cisco Phone Devices (PhoneOS)
          • Uninstall or Delete an Endpoint Agent
          • Endpoint Agent Installation Reference
          • NPCAP Driver Upgrade Management
        • Configuring
          • Configure Endpoint Agent Labels
          • Endpoint Agent Proxy Configuration for Scheduled Tests
        • Managing
          • Manage Endpoint Agent Settings
        • How Does the Endpoint Agent Work
        • Cisco Secure Client ThousandEyes Endpoint Agent Module
        • Endpoint Agent Licensing
        • Assigning tests to an Endpoint Agent
        • Data Collected by Endpoint Agent
        • Reporting on data collected by Endpoint Agent
        • Endpoint Agent VPN Support
        • Endpoint Agent TCP Support
        • Endpoint Agent End-user Experience
        • Endpoint Agent FAQ
      • Working with Agent Settings
      • Obtaining a list of ThousandEyes Agent IP Addresses with te-iplist
    • Tests
      • HTTP Server Tests
        • Collecting Proxy Metrics
        • POSIX Extended Regular Expression Syntax (Quick Reference)
        • POSIX Extended Regular Expression Syntax
        • Custom User-Agent Strings in a Web Test
        • Two-Step HTTP Testing (OAuth)
      • Web-Layer Tests
      • Network Tests
        • Network Tests Explained
        • Agent-to-Agent Test Overview
        • DSCP Options in Network Tests
      • DNS Tests
      • Voice Tests
        • SIP Server Test Settings
        • RTP Stream Test Settings
        • Using the SIP Server View
        • Using the RTP Stream View
      • BGP Tests
        • Inside-Out BGP Visibility
        • Using the BGP Route Visualization View
        • Using the BGP Updates Table
        • Working with Raw BGP Data
        • Reasons for Failure of Private Peering with ThousandEyes
        • RPKI
      • API Tests
        • Using the API Test Step Builder
      • Templates
        • User-defined Templates
      • Recommendations
        • Associated Service Recommendations
        • AWS Test Recommendations
      • ThousandEyes Metrics: What Do Your Results Mean?
      • Sharing Test Data
      • Working with Test Settings
      • Scheduled Versus Instant Tests
      • Working with Instant Tests
      • Working with Labels for Agent and Test Groups
      • Multi-Service Views
      • Identifying Traffic from ThousandEyes Agents
      • Excluding ThousandEyes Agents from Google Analytics
    • Internet and WAN Monitoring
      • Path Visualization
        • How Path Trace Works
        • MPLS Tunnel Inference Using Deep Path Analysis
        • Troubleshooting
          • Reasons for Missing Information on the Visualization View
          • Virtual Machine with NAT Breaks Path Visualization
          • Cisco ASA Breaks Path Visualization
          • Path Visualization: Edge Firewall Incorrectly Shows a Single Hop to the Destination
          • Network Overview Shows Packet Loss That Does Not Appear in Path Visualization
      • Views
        • Using the Network Overview
        • Using the FTP Server View
        • Using the HTTP Server View
        • Using the DNS Server View
        • Using the DNS Domain Trace View
        • Using the DNSSEC Trace View
        • Using the API Test Views
      • Troubleshooting
        • CLI Network Troubleshooting Utilities
        • HTTP Server Test Fails with SSL Error
        • HTTP Server Test Fails with SSL Error: OpenSSL SSL_connect: SSL_ERROR_SYSCALL
        • HTTP Server Test Error "dh Key Too Small"
    • Browser Synthetics
      • Browser Synthetics Test Types
      • Browser Synthetics Disambiguation
      • Test Settings for Page Load and Transaction Tests
      • Navigating Waterfall Charts for Page Load and Transaction Tests
      • Using Round Robin Test Scheduling
      • What Information Is Transmitted in a Page Load or Transaction Test?
      • Transaction Test SSO Support
        • Implementing SSO in Transaction Scripts
        • Caveats for NTLM/Kerberos Authentication
        • TOTP Examples for SSO
      • Page Load Tests
        • When to Use a Page Load Test
        • Creating a Page Load Test
        • Using the Page Load View
        • How to Generate a HAR File
        • Migrating to Single Interval for Page Load Tests
        • Creating a Page Load Test that Uses SSO
      • Transaction Tests
        • Getting Started With Transaction Tests
          • When to Use a Transaction Test
          • Transaction Tests Compared With Other Test Types
          • ThousandEyes Recorder
          • ThousandEyes Recorder Permissions
          • Working With Web Development Tools
          • Working With Secure Credentials
          • Transaction Test Table Tab View
          • Transaction Metrics on Alerts and Dashboards
          • Screenshots in Transaction Test Views
        • Transaction Test Development Guide
          • Creating Robust Transaction Scripts
            • Optimizing and Troubleshooting Transaction Scripts
            • Transaction Scripting Tips and Tricks
          • Transactions – Executing Custom JavaScript Code
        • Use Cases | Code Examples
          • Uploading or Downloading Files in a Script
            • Transaction Scripting Examples for File Downloads
          • Include API Calls in a Transaction Test
            • Using the node-fetch module
            • Using the net module
            • Using the tls module
        • Transaction Scripting Reference
      • Dual Chromium Option
        • Why Are Regular Chromium Upgrades Needed?
        • Configuring Dual Chromium
        • Working With Dual Chromium
        • Chromium Update History
        • Chromium Upgrade Known Issues
    • Endpoint Experience
      • Test Settings
        • Monitoring an Application using Synthetic Tests
        • Configuration Options for Synthetic Tests
        • Managing Synthetic Tests
        • Real User Tests
      • Viewing Data
        • Endpoint Agent Scheduled Tests View
        • Endpoint Agent Real User Tests View
        • Endpoint Agent Local Networks View
        • Endpoint Agent Dynamic Tests View
        • Endpoint Agent Views
        • Endpoint Views Reference
      • Troubleshooting
        • Step-by-Step Guide to Troubleshooting Endpoint Agent Problems
        • Troubleshooting Endpoint Agent Issues
    • Connected Devices
      • Connected Devices Tests
        • Routing
          • Traceroute
        • Network
          • Speed Tests
          • Latency, Loss, Disconnections, and Jitter Tests
          • Responsiveness (Latency under Load) Tests
        • DNS
          • DNS Resolution Tests
        • Web
          • Web Browsing Lite Tests
          • Generic Streaming (HLS/DASH) Tests
        • Voice
        • Dynamic Application Test Suites
          • Gameplay Test Suite
          • Video Conferencing Test Suite
          • Social Media Test Suite
          • Game Store Test Suite
          • Video Streaming Test Suite
            • Netflix Streaming Tests
            • YouTube Streaming Tests
            • BBC iPlayer Streaming Tests
          • Content Delivery Network (CDN) Test Suite
        • Local Network Information
          • Data Usage
      • Test Management
        • Test Triggers
          • Scheduled Tests
          • Instant Tests
        • Testing Thresholds
        • Test Targets
          • Test Server Methodology
        • Automatic Test Configuration Retrieval
      • Device Agents
        • Router Agents
          • Router Agent Device Support
        • Connected Devices Agent Release Versions
      • Usage Guides
        • Viewing Charts
        • Configuring Charts
        • Using Maps
        • Exporting Data
        • Importing Metadata
        • Managing Metadata
        • Creating Reports
        • Viewing Agents
        • Using Test Schedules
        • Accessing Your APIs
        • Using ConstantCare
      • Cisco Real Speed
    • Cloud Insights
      • Integrations
      • Views
      • Settings
    • WAN Insights
      • WAN Insights Quick Start
        • How to Activate ThousandEyes WAN Insights
        • WAN Insights Introductory Tour, Part 1
        • WAN Insights Introductory Tour, Part 2
        • WAN Insights Introductory Tour, Part 3
      • Introducing WAN Insights
        • What Is WAN Insights?
        • WAN Insights Value-Add
        • Why Use WAN Insights?
        • Using WAN Insights Together With ThousandEyes Network Assurance
        • Using WAN Insights Together with vAnalytics and vManage
        • WAN Insights Key Components
        • Enabling WAN Insights
        • Getting Support for WAN Insights
      • WAN Insights Terminology and Reference
      • WAN Insights Technical Overview
        • Application Categories
        • Sites, Routers, Paths, and Interfaces
        • Application Traffic Types
        • Estimating User Counts
        • Estimating Throughput
        • Capacity Planning
        • Understanding Quality
        • Life of a Recommendation
        • Understanding Recommendations
        • WAN Insights and ThousandEyes Alerts
      • WAN Insights User Interface
        • Logging In for the First Time
        • WAN Insights Screens and Workflows
        • Recommendations Screen
        • Recommendation Cards, Explained
        • Recommendation Details Modal
        • Endpoint-Pair Quality Comparison
        • Site Details Screen
        • Capacity Planning Screen
        • Capacity Detail Modal
        • Enter or Upload Bandwidth Data
      • Common Tasks
        • Adding Business-Critical Applications to WAN Insights
        • Email Notifications
        • Adding and Managing WAN Insights Users
        • Applying WAN Insights Recommendations
    • Internet Insights
      • Internet Insights Terminology
      • Limited Outage Map
      • Internet Insights Screens
        • Overview Screen
        • Internet Insights Service Views Screen
        • Application Outages
        • Network Outages
        • Catalog Settings Screen
      • Saving and Sharing from Internet Insights
      • Configuring Internet Insights
      • Provider Labels
      • Using Alerts and Dashboards With Internet Insights
        • My Affected Tests
        • Setting Up Alert Rules for Internet Insights
        • Using the Internet Insights Built-In Dashboard
    • Event Detection
    • Alerts
      • Creating and Editing Alert Rules
        • Global and Location Alert Conditions
        • Alert Rule Severity
        • Adaptive Alert Detection
        • Dynamic Baselines
        • Transport Layer Security (TLS) Alerts
        • Alert Rules for Devices
        • Alert Metrics Reference
      • Default Alert Rules
      • Viewing Alerts
      • Alert Clearing
        • Alert Suppression Windows
      • Alert Notifications
      • Standard Notification Methods
        • Alert Notifications via Email
        • Alert Notifications via SMS
        • Classic Webhooks for Alert Notifications
    • Dashboards
      • Using the Dashboard
      • Customizing Your Dashboard
      • Using the Dashboard Templates
      • Dashboard Widgets
      • Embedding Dashboard Widgets in External Web Sites
      • Excluding Periods of Data From a Dashboard
      • Dashboard Sharing and Snapshots
      • Dashboard Labels
      • Troubleshooting with Dashboard Drill Down
      • Tailoring Dashboards with Dashboard Filters
    • Device Layer
      • Discovering Device-Layer Devices
      • Device Discovery Results
      • Using the Device Layer View
    • Account Management
      • User Registration
        • SAML JIT Provisioning
        • ThousandEyes Support for SCIM
          • How to Configure SCIM with Azure Active Directory
          • How to Configure SCIM with Okta
      • Authorization
        • Role-Based Access Control
          • Role-Based Access, Explained
          • Built-In Roles and Permissions
        • Account Groups
          • What is an Account Group?
          • Working with Account Settings
          • Users in Multiple Organizations
          • Changing Ownership of a Test
          • Working with Time Zone Settings
        • OAuth 2.0 with ThousandEyes
          • Integrations with OAuth 2.0
        • Adding a Profile Image with Gravatar
      • Authentication
        • Logging In
        • How to Configure Single Sign-On
      • User Activity
        • Working with the Activity Log
        • ThousandEyes User Session Timeouts and Terminations
        • How Long is my Data Accessible via ThousandEyes?
        • Retaining Data Beyond the 90-Day Limit
        • Multi-Region Cloud Support
      • Usage-Based Billing
        • About Our Consumption Model
          • Device Agent Consumption Model
        • About Units
        • Test Type Layers and Units
        • Setting Quotas
        • Calculating Units
        • FAQs: Usage
      • Customer Security and Privacy Responsibilities
    • Integrations
      • Custom Webhooks
        • Using OAuth 2.0 Authentication for Your Custom Webhook
        • Webhook Variables
      • Custom Webhook Examples
        • Microsoft Teams for Alert Notifications
        • Cisco Webex for Alert Notifications
        • Google Chat for Alert Notifications
        • Event-Driven Ansible for Alert Notifications
        • Splunk Alert Notification
      • Custom-Built Integrations
        • PagerDuty for Alert Notifications
        • ServiceNow for Alert Notifications
          • Incident Management
        • Slack for Alert Notifications
        • AppDynamics for Alert Notifications
        • AppDynamics for Test Recommendations
        • AWS for Test Recommendations
        • AWS for Cloud Insights
          • AWS for Cloud Insights Using CLI
        • Meraki for Data Enrichment
        • Webex Control Hub Integration
        • Microsoft Teams Integration
        • ThousandEyes for OpenTelemetry
          • Configuring ThousandEyes for OpenTelemetry
            • Configuring ThousandEyes for OpenTelemetry Using the API
            • Configuring ThousandEyes for OpenTelemetry Using the UI
          • Configuring ThousandEyes for Splunk Cloud or Enterprise
            • Configuring ThousandEyes for Splunk Cloud or Enterprise using the API
            • Configuring ThousandEyes for Splunk Cloud or Enterprise using the UI
          • ThousandEyes for OpenTelemetry Data Model
            • ThousandEyes for OpenTelemetry Data Model v1
              • OpenTelemetry Collector Data v1 Example
            • ThousandEyes for OpenTelemetry Data Model v2
              • ThousandEyes for OpenTelemetry Data Model v2 - Metrics
                • OpenTelemetry Collector Data v2 Metrics Example
                • ThousandEyes for OpenTelemetry Data Model Metrics - Migration from v1 to v2
              • ThousandEyes for OpenTelemetry Data Model v2 - Traces
                • OpenTelemetry Collector Data v2 Traces Example
          • OpenTelemetry Collector Configuration
          • Automatic Disabling of Failing Streaming Integrations
        • Cisco ThousandEyes App for Splunk
          • Configuration
          • Inputs
          • Dashboards
          • Troubleshooting
    • Best-Practices Guides
      • Choosing the Right Test Protocol for Network & App Synthetics Tests
      • Optimizing SYN vs SACK Probing Methods to Avoid Unexplainable Packet Loss
      • Using Dashboards to Tell a Story
      • Best Practices for Implementing Account Groups
      • Monitoring Microsoft 365
      • Monitoring Microsoft Teams
      • Monitoring Salesforce
      • Monitoring Slack
      • Monitoring Webex Meetings with Endpoint Agents
      • Monitoring Webex Calling
      • Monitoring Webex Meetings with Cloud and Enterprise Agents
      • Monitoring Zoom
    • API
      • Create/Update/Delete Tests Using the ThousandEyes API
      • Obtaining a List of ThousandEyes Agent IP Addresses
      • Writing JSON to API Produces HTTP 406 Response Code
    • Privacy-Related
      • Authorized Subprocessors for ThousandEyes Network Intelligence Platform
    • Archived Documentation
      • Archived - Displaying and Alerting for Unit Consumption
      • Archived - Dependency Tree for ThousandEyes Enterprise Agent Software
      • Archived - Getting Started with ThousandEyes
      • Archived - Sending ThousandEyes Alerts to AppDynamics
      • Archived - ThousandEyes Infrastructure Changes
      • Archived - Using the Transactions (Classic) View
      • Archived - Transaction Test Migration Workflow
      • Archived - Instructions for Mitigating Meltdown and Spectre on Enterprise Agents
      • Archived - Bash (ShellShock) Security Notice
      • Archived - Endpoint Installation using Customized Installers
      • Archived - Configuring Endpoint Agent Setup
      • Archived - Creating Scheduled Tests on Endpoint Agents
      • Archived - Managing the Endpoint Agent
      • Archived - Enterprise Agent Installation on Juniper NFX Routers
      • Archived - Installing and Removing ThousandEyes X Virtual Framebuffer on Enterprise Agents
      • Archived - Permitted Content Types for Page Load Tests
  • Archived Release Notes
    • 2024
      • Release Notes: January 2024
      • Release Notes: February 2024
      • Release Notes: March 2024
      • Release Notes: April 2024
      • Release Notes: May 2024
      • Release Notes: June 2024
      • Release Notes: July 2024
      • Release Notes: August 2024
    • 2023
      • Release Notes: January 2023
      • Release Notes: February 2023
      • Release Notes: March 2023
      • Release Notes: April 2023
      • Release Notes: May 2023
      • Release Notes: June 2023
      • Release Notes: July 2023
      • Release Notes: August 2023
      • Release Notes: September 2023
      • Release Notes: October 2023
      • Release Notes: November 2023
      • Release Notes: December 2023
    • 2022
      • Release Notes: January 2022
      • Release Notes: February 2022
      • Release Notes: March 2022
      • Release Notes: April 2022
      • Release Notes: May 2022
      • Release Notes: June 2022
      • Release Notes: July 2022
      • Release Notes: August 2022
      • Release Notes: September 2022
      • Release Notes: October 2022
      • Release Notes: November 2022
      • Release Notes: December 2022
    • 2021
      • Release Notes: January 2021
      • Release Notes: February 2021
      • Release Notes: March 2021
      • Release Notes: April 2021
      • Release Notes: May 2021
      • Release Notes: June 2021
      • Release Notes: July 2021
      • Release Notes: August 2021
      • Release Notes: September 2021
      • Release Notes: October 2021
      • Release Notes: November 2021
      • Release Notes: December 2021
    • 2020
      • Release Notes: January 2020
      • Release Notes: February 2020
      • Release Notes: March 2020
      • Release Notes: April 2020
      • Release Notes: May 2020
      • Release Notes: June 2020
      • Release Notes: July 2020
      • Release Notes: August 2020
      • Release Notes: September 2020
      • Release Notes: October 2020
      • Release Notes: November 2020
      • Release Notes: December 2020
    • 2019
      • Release Notes: 2019-01-08
      • Release Notes: 2019-02-06
      • Release Notes: 2019-02-20
      • Release Notes: 2019-03-06
      • Release Notes: 2019-03-19
      • Release Notes: 2019-04-02
      • Release Notes: 2019-04-30
      • Release Notes: 2019-05-14
      • Release Notes: 2019-05-30
      • Release Notes: 2019-06-11
      • Release Notes: 2019-07-23
      • Release Notes: 2019-08-06
      • Release Notes: 2019-08-20
      • Release Notes: 2019-09-03
      • Release Notes: 2019-09-17
      • Release Notes: 2019-10-03
      • Release Notes: 2019-10-15
      • Release Notes: 2019-10-29
      • Release Notes: 2019-11-12
      • Release Notes: 2019-11-26
      • Release Notes: 2019-12-10
    • 2018
      • Release Notes: 2018-01-10
      • Release Notes: 2018-01-17
      • Release Notes: 2018-01-31
      • Release Notes: 2018-02-14
      • Release Notes: 2018-03-07
      • Release Notes: 2018-03-14
      • Release Notes: 2018-03-28
      • Release Notes: 2018-04-11
      • Release Notes: 2018-04-25
      • Release Notes: 2018-05-09
      • Release Notes: 2018-05-23
      • Release Notes: 2018-06-06
      • Release Notes: 2018-06-20
      • Release Notes: 2018-07-03
      • Release Notes: 2018-07-18
      • Release Notes: 2018-08-01
      • Release Notes: 2018-08-15
      • Release Notes: 2018-08-29
      • Release Notes: 2018-09-12
      • Release Notes: 2018-09-26
      • Release Notes: 2018-10-10
      • Release Notes: 2018-10-23
      • Release Notes: 2018-11-13
      • Release Notes: 2018-11-27
      • Release Notes: 2018-12-18
    • 2017
      • Release Notes: 2017-01-04
      • Release Notes: 2017-01-18
      • Release Notes: 2017-02-01
      • Release Notes: 2017-02-16
      • Release Notes: 2017-03-02
      • Release Notes: 2017-03-15
      • Release Notes: 2017-03-29
      • Release Notes: 2017-04-12
      • Release Notes: 2017-04-26
      • Release Notes: 2017-05-10
      • Release Notes: 2017-05-24
      • Release Notes: 2017-06-06
      • Release Notes: 2017-06-21
      • Release Notes: 2017-07-07
      • Release Notes: 2017-07-19
      • Release Notes: 2017-08-02
      • Release Notes: 2017-08-16
      • Release Notes: 2017-08-30
      • Release Notes: 2017-09-13
      • Release Notes: 2017-09-27
      • Release Notes: 2017-10-12
      • Release Notes: 2017-10-25
      • Release Notes: 2017-11-08
      • Release Notes: 2017-11-29
      • Release Notes: 2017-12-13
    • 2016
      • Release Notes: 2016-01-06
      • Release Notes: 2016-01-20
      • Release Notes: 2016-02-03
      • Release Notes: 2016-02-17
      • Release Notes: 2016-03-02
      • Release Notes: 2016-03-16
      • Release Notes: 2016-03-30
      • Release Notes: 2016-04-13
      • Release Notes: 2016-04-27
      • Release Notes: 2016-05-11
      • Release Notes: 2016-05-25
      • Release Notes: 2016-06-08
      • Release Notes: 2016-06-22
      • Release Notes: 2016-07-06
      • Release Notes: 2016-07-20
      • Release Notes: 2016-08-03
      • Release Notes: 2016-08-17
      • Release Notes: 2016-08-31
      • Release Notes: 2016-09-14
      • Release Notes: 2016-09-28
      • Release Notes: 2016-10-12
      • Release Notes: 2016-10-26
      • Release Notes: 2016-11-09
      • Release Notes: 2016-11-23
      • Release Notes: 2016-12-07
      • Release Notes: 2016-12-21
    • 2015
      • Release Notes: 2015-01-07
      • Release Notes: 2015-01-21
      • Release Notes: 2015-02-04
      • Release Notes: 2015-02-18
      • Release Notes: 2015-03-04
      • Release Notes: 2015-04-01
      • Release Notes: 2015-04-15
      • Release Notes: 2015-04-29
      • Release Notes: 2015-05-13
      • Release Notes: 2015-05-27
      • Release Notes: 2015-06-10
      • Release Notes: 2015-06-24
      • Release Notes: 2015-07-08
      • Release Notes: 2015-07-22
      • Release Notes: 2015-08-05
      • Release Notes: 2015-08-19
      • Release Notes: 2015-09-16
      • Release Notes: 2015-09-30
      • Release Notes: 2015-10-14
      • Release Notes: 2015-10-28
      • Release Notes: 2015-11-11
      • Release Notes: 2015-12-02
      • Release Notes: 2015-12-16
    • 2014
      • Release Notes: 2014-01-09
      • Release Notes: 2014-01-22
      • Release Notes: 2014-02-05
      • Release Notes: 2014-03-05
      • Release Notes: 2014-03-19
      • Release Notes: 2014-04-09
      • Release Notes: 2014-04-30
      • Release Notes: 2014-06-04
      • Release Notes: 2014-06-11
      • Release Notes: 2014-06-26
      • Release Notes: 2014-07-09
      • Release Notes: 2014-07-23
      • Release Notes: 2014-08-20
      • Release Notes: 2014-09-04
      • Release Notes: 2014-09-17
      • Release Notes: 2014-10-01
      • Release Notes: 2014-10-15
      • Release Notes: 2014-10-29
      • Release Notes: 2014-11-12
    • 2013
      • Release Notes: 2013-01-08
      • Release Notes: 2013-02-27
      • Release Notes: 2013-03-20
      • Release Notes: 2013-04-02
      • Release Notes: 2013-04-17
      • Release Notes: 2013-05-01
      • Release Notes: 2013-05-21
      • Release Notes: 2013-06-11
      • Release Notes: 2013-06-18
      • Release Notes: 2013-07-10
      • Release Notes: 2013-07-24
      • Release Notes: 2013-08-07
      • Release Notes: 2013-09-05
      • Release Notes: 2013-09-18
      • Release Notes: 2013-10-02
      • Release Notes: 2013-10-30
      • Release Notes: 2013-11-13
      • Release Notes: 2013-11-27
    • 2012
      • Release Notes: 2012-03-28
      • Release Notes: 2012-04-11
      • Release Notes: 2012-04-24
      • Release Notes: 2012-05-22
      • Release Notes: 2012-06-05
      • Release Notes: 2012-06-20
      • Release Notes: 2012-08-01
      • Release Notes: 2012-08-28
On this page
  • Disabling an Endpoint Agent
  • Re-enabling a disabled Endpoint Agent
  • Systems with Disabled Agents
  • Status of the Endpoint Agent Browser Extension
  • Auto - manage the status for Endpoint Agents
  • Transfer Ownership of an Endpoint Agent.
  • Transfer Ownership via Agent Settings
  • Transfer Ownership across different regions using Connection String.
  • Accessing the Agent Views/ Views for the Agent
  • Exporting Endpoint Agent Data
  • Managing Multiple Endpoint Agent Simultaneously
  • Advanced Agent Settings
  1. Product Documentation
  2. Global Vantage Points
  3. Endpoint Agents
  4. Managing

Manage Endpoint Agent Settings

PreviousManagingNextHow Does the Endpoint Agent Work

Last updated 1 month ago

Due to recent platform-wide naming, navigation, and URL changes in the ThousandEyes product, you may notice some discrepancies between the product and the screenshots displayed in our technical documentation. The instructions and actual pages in the product are still valid and haven’t changed. Please bear with us as we update our screenshots to better match the in-product experience. See the full scope of changes on .

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

To add a new Endpoint Agent, see the 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.

Agent Labels

A chevron will appear to the right of the agent name for each Agent Label currently assigned to the agent. Hover over the chevrons to display a tooltip with the names of the Agent Labels. If no Agent Labels 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.

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, click on the relevant entry in the table to open the Endpoint Agent Settings side panel.

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

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 labels (see [labels](https://docs.thousandeyes.com/product-documentation/global-vantage-points/endpoint-agents/configuring/configure-endpoint-agent-labels) 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.

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.

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.

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. Within the ThousandEyes web application, switch to the corresponding Account Group of Organization A, where the agent will be transferred.

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

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. Within the ThousandEyes web application, switch to the corresponding Account Group of Organization A, from which all the agents will be transferred.

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

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

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

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

To add additional versions:

  1. Navigate to the Advanced Agent Settings tab in the Endpoint Agents > Agent Settings section of the ThousandEyes web application.

  1. Add the versions of the NPCAP driver you want to be supported.

  2. Click the Save Changes button and confirm your list of supported NPCAP driver versions in the dialog box.

Click the Reset to Default button to revert to the default supported versions and click Save Changes to apply them.

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

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

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

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 or tabs respectively.

This section allows you to customize and manage the NPCAP versions supported for your account. You can learn more about NPCAP version management in the article.

Connection String
re-installation
Connection String
Views
Agent Views
NPCAP Driver Upgrade Management
Naming and Navigation Menu changes - Summary List
Installation