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
    • Traffic Insights
      • Traffic Insights System Requirements
      • Traffic Insights Configuration Guide
      • Traffic Insights Views and Settings
      • Traffic Insights FPS Monitoring
    • 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
  • Browser Extensions
  • Command-Line Options for Msiexec / Msiexec Switches
  • Extended Network Tests Support for Windows
  • Updating Existing Agents
  • Connection String
  1. Product Documentation
  2. Global Vantage Points
  3. Endpoint Agents
  4. Installing

Endpoint Agent Installation Reference

PreviousUninstall or Delete an Endpoint AgentNextNPCAP Driver Upgrade Management

Last updated 7 months ago

This article provides more in-depth information regarding the opt-in/out configuration options within the Endpoint Agent installer.

Browser Extensions

The Endpoint Agent browser extensions can be installed either at the end of the GUI installation process, or as part of the Windows command line installation.

If the browser settings for either Microsoft Edge or Google Chrome are managed by a separate mechanism (for example, Windows Group Policy or Google Chrome Browser Cloud Management), then the extensions should not be enabled during the installation process. This is due to the Endpoint Agent installer modifying registry keys as part of the process, which may cause conflicts.

This issue does not affect the Internet Explorer extension, which can only be enabled during installation.

  • .

  • .

Endpoint Agent Installer

The Feature Selection page of the installer wizard provides a drop-down menu to select the desired extension, and disable support for Extended Network Tests .

From January 31, 2023, the TCP Network Tests installation feature has been included as a part of the Extended Network Tests. The installer will by default, support the Extended Network Tests. More information can be found .

As the Selection Tree widget is a standard Windows Installer control, with limited ability to customise it; the Will be installed on local hard drive and the Entire feature will be installed on local hard drive options are identical.

Once you have configured the extensions, click Next to continue the installation wizard.

Command-Line Options for Msiexec / Msiexec Switches

Switch
Description
Action

ExtendedNetworkTestsSupport

Extended Network Tests Support

Install Npcap driver if no Npcap driver is installed.

EdgeExtension

Microsoft Edge Browser Extension

Enable support for collecting network metrics for approved pages in Microsoft Edge.

ChromeExtension

Google Chrome Browser Extension

Enable support for collecting network metrics for approved pages in Google Chrome.

IeExtension

Internet Explorer Bowrser Extension

Enable support for collecting network metrics for approved pages in Internet Explore.

Agent

Endpoint Client Agent

Optional Switch for base agent installation. This does not include support for the Extended Network Tests.

TcpNetworkTestsSupport

TCP Network Tests Support

If no Switches are passed, Extended Network Tests will be installed and no Browser Extensions are installed.

To install the extensions via the command-line, add the relevant flags shown in the examples below:

Default

If the MSI is run without any options, the Endpoint agent is installed with support for Extended Network Tests and without any Browser Extensions. msiexec.exe /i <path_to_msi> /quiet /norestart

With Extended Network Tests Support

Install with Extended Network Tests Support and no browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>"

Install with Extended Network Tests Support and all the browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ExtendedNetworkTestsSupport,IeExtension,ChromeExtension,EdgeExtension"

Install with Extended Network Tests Support and Microsoft Edge browser extension: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ExtendedNetworkTestsSupport,EdgeExtension"

Install with Extended Network Tests Support and Internet Explorer browser extension: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ExtendedNetworkTestsSupport,IeExtension"

Install with Extended Network Tests Support and Chrome browser extension: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ExtendedNetworkTestsSupport,ChromeExtension"

Install with Extended Network Tests Support and Microsoft Edge, and Internet Explorer browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ExtendedNetworkTestsSupport,IeExtension,EdgeExtension"

Install with Extended Network Tests Support with Microsoft Edge, and Chrome browser extensions: mmsiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ExtendedNetworkTestsSupport,ChromeExtension,EdgeExtension"

Install with Extended Network Tests Support with Internet Explorer, and Chrome browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ExtendedNetworkTestsSupport,IeExtension,ChromeExtension"

Without Extended Network Tests Support

Install with no Extended Network Tests Support and no browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="Agent"

Install with no Extended Network Tests Support and all the browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="Agent,IeExtension,ChromeExtension,EdgeExtension"

Install with no Extended Network Tests Support but, with Microsoft Edge extension: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="Agent,EdgeExtension"

Install with no Extended Network Tests Support but, with Internet Explorer browser extension: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="Agent,IeExtension"

Install with no Extended Network Tests Support but, with Chrome browser extension: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="Agent,ChromeExtension"

Install with no Extended Network Tests Support but, with Microsoft Edge and Internet Explorer browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="Agent,IeExtension,EdgeExtension"

Install with no Extended Network Tests Support but, with Microsoft Edge and Chrome browser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="ChromeExtension,EdgeExtension"

Install with no Extended Network Tests Support but, with Internet Explorer and Chrome bowser extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ACCOUNT_CONFIG="<connection_string>" ADDLOCAL="IeExtension,ChromeExtension"

Remove the Support for Extended Network Tests

To remove the support for Extended Network Tests, add the REMOVE="ExtendedNetworkTestsSupport" to the command. For example:

msiexec.exe /i <path_to_msi> /quiet /norestart REMOVE="ExtendedNetworkTestsSupport"

Alternatively, you can run all the above command-line Msiexec / Msiexec switches without passing the Connection String parameter. Subsequently, you need to register the agent with the desired account group.

For example, running the following command will install the agent with Extended Network Tests Support and all the browser extensions:

msiexec.exe /i <path_to_msi> /quiet /norestart ADDLOCAL="ExtendedNetworkTestsSupport,IeExtension,ChromeExtension,EdgeExtension" but you need to run the te-agent --register <connection_string> command to register the agent. You need to run the registration command from the administrator console on Windows and sudo on macOS.

Extended Network Tests Support for Windows

The Npcap Driver version must be v 1.55. Also, reboot the system to ensure the Npcap driver is installed.

You can verify the currently installed version of Npcap driver by running the following registry query:

reg query HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\NpcapInst

The installation done by the ThousandEyes Endpoint agent installer will look like this:

QuietUninstallString    REG_SZ    "C:\Program Files (x86)\ThousandEyes\ThirdParty\Npcap\uninstall.exe" /S
DisplayIcon    REG_SZ    C:\Program Files (x86)\ThousandEyes\ThirdParty\Npcap\uninstall.exe
UninstallPath    REG_SZ   C:\Program Files (x86)\ThousandEyes\ThirdParty\Npcap
DisplayName    REG_SZ    Npcap OEM
DisplayVersion    REG_SZ    1.55
Publisher    REG_SZ    Nmap Project
URLInfoAbout    REG_SZ    Npcap: Windows Packet Capture Library & Driver 
URLUpdateInfo    REG_SZ    Npcap: Windows Packet Capture Library & Driver 
VersionMajor    REG_SZ    1
VersionMinor    REG_SZ    55
NoModify    REG_DWORD    0x1
NoRepair    REG_DWORD    0x1

The installation by another product can look like this:

QuietUninstallString    REG_SZ    "C:\Program Files\Npcap\uninstall.exe" /S
DisplayIcon    REG_SZ    C:\Program Files\Npcap\uninstall.exe
UninstallPath    REG_SZ    C:\Program Files\Npcap
DisplayName    REG_SZ    Npcap
DisplayVersion    REG_SZ    1.10
Publisher    REG_SZ    Nmap Project
URLInfoAbout    REG_SZ    Npcap: Windows Packet Capture Library & Driver 
URLUpdateInfo    REG_SZ    Npcap: Windows Packet Capture Library & Driver 
VersionMajor    REG_SZ    1
VersionMinor    REG_SZ    10
NoModify    REG_DWORD    0x1
NoRepair    REG_DWORD    0x1

In either case the DisplayVersion parameter displays the version of Npcap currently installed.

  1. Uninstall (manually) the unsupported version of Npcap. You can do this via Add/Remove Programs.

You can also remove the currently installed Npcap driver using the command line.

The command may vary depending on the existing install, but can be found in the UninstallString key under HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\NpcapInst in the registry and will usually be like this "C:\Program Files\Npcap\uninstall.exe"

You can use the UninstallString command to remove the currently installed Npcap driver, if the outdated version was not installed by the Endpoint Agent installer.

For example, UninstallString REG_SZ "C:\Program Files\Npcap\uninstall.exe"

  1. Run the Endpoint Agent installer to remove the Extended Network Tests feature.

  2. Again, run the Endpoint Agent installer with the Extended Network Tests feature enabled (by default). This step, triggers the installation of the upgraded Npcap driver bundled with the Endpoint Agent.

  3. Restart the ThousandEyes Endpoint Agent service.

For Windows, you can use sc query Npcap to verify if the Npcap driver is installed and running.

If steps described above do not resolve the issue or if the issue keeps reoccurring, please contact ThousandEyes Support team (support@thousandeyes.com).

Updating Existing Agents

However, if the previous installation is uninstalled first, the new data will be assigned to a completely new agent that will have the same name as the original. ThousandEyes recommends running the installer without uninstalling the existing agent.

To enable support via the command line, use the installation command flag as outlined in the examples below:

  • Invoke the installer interactively: msiexec.exe /i <path_to_msi>

  • Invoke the installer silently:

When running the installer silently, all features installed are replaced. Browser extensions must be explicitly mentioned when running the installer silently.

Install only Extended Network Support and no extensions: msiexec.exe /i <path_to_msi> /quiet /norestart

Install Extended Network Tests Support and all extensions: msiexec.exe /i <path_to_msi> /quiet /norestart ADDLOCAL="IeExtension,ChromeExtension,EdgeExtension"

Install Extended Network Tests Support and the Google Chrome extension only: msiexec.exe /i <path_to_msi> /quiet /norestart ADDLOCAL="ChromeExtension"

After a successful installation, both the ThousandEyes Endpoint Agent and the Npcap OEM should be listed under the Apps & Features program on Windows. The installation directory for Npcap OEM is:

  • C:\Program Files (x86)\ThousandEyes\Third Party\Npcap (64-bit Windows)

  • C:\Program Files\ThousandEyes\Third Party\Npcap (32-bit Windows)

Uninstalling the Npcap OEM entry individually from the Apps & Features list is not supported and should be avoided. Uninstalling the Endpoint Agent also uninstalls Npcap OEM and removes it completely from the Apps & Features list.

Connection String

This parameter acts as a token that accurately identifies the account group where the agent should be installed.

If you opt not to install the extensions as part of the Endpoint Agent installer process, you can still install them separately. See .

Install Windows driver and enable support for TCP tests.This switch will be deprecated. More information can be found .

You can also include the : msiexec.exe /i <path_to_msi> /quiet /norestart ENDPOINT_REINSTALLATION_METHOD=MERGE_BY_HOSTNAME ENDPOINT_REINSTALLATION_KEY="<reinstallation_key>"

To view the guidance for software deployment teams, please refer .

The ThousandEyes Endpoint Agent allows users to install a compatible via the command line installation.

If Npcap is already installed (as a part of Wireshark or NMAP), the installer will not change it. If the pre-existing version of Npcap installed is an approved version for your Account Group, the Endpoint Agent will use it for TCP tests. However, if the version is not allowed, the agent will not run TCP tests. You can reach out to the and enable additional versions if you are not using the default version recommended by ThousandEyes. In these situations, we recommend you test agent updates with your preferred version of Npcap. If the ThousandEyes Endpoint Agent installer installed the Npcap driver, then it will be updated on your workstation when necessary. If the version of Npcap on your devices is not compatible and you would like to use the version we distribute, ThousandEyes recommends you follow these instructions:

Existing Endpoint Agents that have the ExtendedNetworkTestsSupport feature turned off (or older versions of the agent that do not support this feature) will need to be reinstalled to enable Extended Network Tests. ThousandEyes recommends to use the to enable TCP tests. The agents can also be updated by following the same process as new agents, outlined below. Updating the agent without uninstalling the previous installation should have no impact on existing data.

Installation of Endpoint agents on clients like Cisco RoomOS Devices, Cisco Secure Client, transferring of agents across organizations, and other integrations, requires the Connection String parameter. You can access the Connection String in the section of the ThousandEyes web application.

Install the Browser Extension
reinstallation token
here
Npcap OEM driver for Windows
support team
convenience script
UI installer
here.
Via the installer wizard
here
Via a command-line flag