Windows Agent Installation

This article covers how to install the Edge DX Agent onto Windows devices.

Before you install the Agent, perform the necessary whitelisting in your proxy, firewall, and antivirus software. Click here to see the whitelisting requirements.

Supported Windows OS Versions

• Windows 7 SP1+ (x64)
• Windows 10 Version 1607+ (x64)
• Windows 11
• Windows Server 2012 R2+ (x64)

Agent Download & Installation

There are a few ways to install the Windows Agent onto a device, primarily:

• Manual GUI installation. This method doesn't have as many options as the command-line install.
• Command-line installation. This method is convenient for deploying the Agent onto many devices at once, and gives you more customization options.

Whichever method you use, you first need to go to Configuration > Downloads and download the Windows Agent Manager. The Agent Manager installs the Agent and keeps it updated with the Agent versions that you set in your Agent Version Control settings.

Manual Agent Installation

To manually install the Windows Agent Manager onto a device:

1. After downloading the Windows Agent Manager, run the agentmanagersetup.msi file and click Next to start the installation wizard.
   
2. In the installation wizard, enter your tenant name. You can find your tenant name on the Agent Downloads page. 
3. If you want the Agent to connect to your tenant via a proxy, select Use HTTPS Proxy and enter the proxy IP address and port number.
4. Click Test to make sure that your tenant is reachable with a GET request. Continue if the installation wizard shows a successful connection message.
5. Copy your Device Registration Code from the Agent Downloads page and paste it into the installation wizard.
6. Click Check to make sure that the registration code is correct for your tenant. This check performs a POST request to your tenant and will fail if something is intercepting the network connection between the Agent and your Edge DX tenant. If this step fails, read the Agent Connection Troubleshooting section and make sure you have performed the necessary whitelisting for the Edge DX Agent.
7. If the registration code is correct, click OK and close the wizard.

The Agent Manager automatically installs the Agent. The Agent automatically connects to your environment and you can monitor the device in Edge DX.

Command Line Agent Installation

To install the Windows Agent Manager using the command line:

1. After downloading the Agent Manager, copy the msiexec command on the Agent Downloads page. This command already includes your tenant name and device registration code.
   
   
2. Optionally, add the following parameters to the msiexec command, depending on what you want to configure:
   • PROXY sets a web proxy IP address and port number for Agent communication. For example, PROXY=10.0.0.1:8080.
   • PROXY_TEST_IP sets an IP address to test before using the proxy server configured in the PROXY parameter. The Agent pings the IP address each time the Agent starts. If the Agent receives a ping response, then it uses the proxy server. If the Agent doesn't receive a ping response, then it does not use a proxy. This feature can be useful if you want the Agent to use a proxy only when the device is in a certain location (for example, in your company's offices).
   • GROUP sets the device group the device. For example, GROUP=Finance. You can use device groups to organize devices which can be useful when filtering data, performing actions, configuring Agent version control, and more. You can set device groups after the Agent is installed if you don't want to do it now. Learn more about device groups.
   • ONLYSTARTONBOOT=1 sets the Agent to not automatically start after the Agent is installed. You must use this option if you are installing the Agent onto a Windows image for cloning (for example, using Citrix PVS/MCS). The Agent starts and connects to your environment on the first boot of the cloned image.
     
     
     Example

     The following example shows you how you would configure each of these parameters on the command-line.

     msiexec /i agentmanagersetup.msi /qn DEVREGCODE=<SampleCode> TENANT=<TenantName>.sip.controlup.com ALLUSERS=1 PROXY=10.0.0.1:8080 PROXY_TEST_IP=1.2.3.4 GROUP=Finance ONLYSTARTONBOOT=1

3. After setting any additional parameters, run the command on a device to install the Agent onto the device.

The Agent Manager and Agent installs onto the device, and the Agent automatically connects to your environment.

Scripted Uninstall of Edge DX Agent for Windows

You can perform a scripted uninstall of the Edge DX agent for:

• All of the Windows devices in your organization
• One or more specific Windows devices in your organization

To perform a scripted uninstall of the Edge DX agent for Windows, use the PowerShell script below.

$Command = "c:\Windows\System32\msiexec.exe"

### to fully uninstall Agent Manager ###
$Params = "/x {2AE0BDC4-26B3-4352-81EA-F4811B5B9B60} /norestart /qn"
$ParamsArray = $Params.Split(" ")
& "$Command" $ParamsArray

### to fully uninstall SIP Agent ###
$Params = "/x {0EE8541E-2D9F-4382-820F-DE7B93F7ED53} /norestart /qn"
$ParamsArray = $Params.Split(" ")
& "$Command" $ParamsArray

Scripted Uninstall of the Edge DX Agent from All Windows Devices in Your Organization

To uninstall the Edge DX from all Windows devices in your organization, perform the following steps:

1. Under Configuration > Scripts click Add Script. See the Edge DX Scripting Guide for more information.
2. Schedule when the script should run. For example, you can select the System - Once Per Day trigger to run the script on each device in the next few minutes. See the Edge DX Scripting Guide - Script Triggers for more information.

Scripted Uninstall of the Edge DX Agent from One or More Specific Windows Devices in Your Organization

To uninstall the Edge DX from one or more specific Windows devices in your organization, run the script provided above as a Custom Action. See the Edge DX Scripting Guide - Custom Actions for more information.