Windows Agent Installation
    • Dark
      Light
    • PDF

    Windows Agent Installation

    • Dark
      Light
    • PDF

    Article summary

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

    Important
    Before you deploy any Edge DX Agents, read the prerequisites for Agent deployment and make sure that your environment is ready.

    Supported Windows OS versions

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

    Download the Agent Manager

    We recommend that you install the Edge DX Agent using the Agent Manager. The Agent Manager installs the Agent and automatically keeps it updated according to your Agent version control settings. By default, the Agent Manager installs the most recent GA version of the Agent.

    To download the Agent Manager, go to Configuration > Downloads > Windows Agent and click Download.

    If you don't want to use the Agent Manager, you can directly download the latest Agent at the bottom of the Downloads page. Note that if you don't install the Agent Manager, you won't be able to use Edge DX's built-in version control.

    Installation methods

    There are multiple methods to install the Agent Manager.

    • Interactive GUI installation - Note that this installation method does not include as many customization options.
    • Command line installation - This method gives you more customization options, and lets you deploy the Agent Manager onto many devices at once.
    • Cloning a Windows image - If you are deploying the Agent Manager by cloning a Windows image, follow the command line installation instructions. Note that you must add the ONLYSTARTONBOOT=1 parameter to the command if you are installing the Agent Manager onto a device that will be cloned.
    Deployment examples
    Click these links to watch videos about Edge DX Agent deployment using SCCM or Intune.

    Interactive GUI installation

    To install the Agent Manager onto a device using the interactive GUI installer:

    1.  Run the agentmanagersetup.msi file you downloaded from the Edge DX Downloads page.
    2. Click Next to confirm that you agree to ControlUp's End User License Agreement.
    3. Click Install to install the Agent Manager.
    4. Copy your Tenant Name (located on the Edge DX Downloads page) and paste it into the tenant name field in the Agent Manager Setup window.
      1. Optionally, if you want the Agent to connect to your tenant using a proxy, select Use HTTPS Proxy and enter the proxy IP address and port number.
      2. Click Test to make sure that your device can reach your tenant with a GET request. If this test fails, make sure you meet the Agent prerequisites.
    5. Copy your Device Registration Code (located on the Edge DX Downloads page) and paste it into the device registration code field in the Agent Manager Setup window. Click Check to make sure that the code is correct. This check sends a POST request to your tenant. If this check fails even though the code is entered correctly, make sure you meet the Agent prerequisites.
    6. Click OK to save the tenant name and device registration code you entered.
    7. Click Finish after the installation has been completed.

    The Agent Manager and Agent are now installed on your device. The Agent automatically connects to your environment and you can view your device in Edge DX. The Agent Manager automatically keeps the Agent updated according to your Agent version control settings.

    Command line installation

    To install the Windows Agent Manager from the command line:

    1. After downloading the Agent Manager, copy the msiexec command on the Edge DX Downloads page. This command already includes your unique tenant name and device registration code.msiexec install command.png
    2. Optionally, add the following parameters to the msiexec command:
      • 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. Read Proxy server configuration below for details.
      • 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. 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 Manager onto the device.

    The Agent Manager and Agent are now installed on your device. The Agent automatically connects to your environment and you can view your device in Edge DX. The Agent Manager automatically keeps the Agent updated according to your Agent version control settings.

    Proxy server configuration

    You can configure the Agent to use a proxy server to connect to your Edge DX environment.  If you want the Agent to only use a proxy when the device is in a certain location (like your company's offices), you can set a proxy test IP address. Every time the Agent starts, it pings the test IP address. If the Agent receives a response, it uses the proxy. If the Agent does not receive a response, it does not use the proxy.

    To configure a proxy server during Agent installation, follow the instructions above for either Interactive GUI installation or Command line installation. Note that the interactive GUI installer doesn't give you the option to add a proxy test IP address during installation.

    To configure a proxy server for an existing Agent, you can use the Registry Editor:

    •   To set the proxy server, go to Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Avacee\SIP and add a string (REG_SZ) ProxyAddress. Set the value of ProxyAddress to the proxy IP and port number (for example, 10.0.0.1:8080).
    • To set the test IP address, go to Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Avacee\SIP and add a string (REG_SZ) proxy_test_ip. Set the value of proxy_test_ip to the IP address to test (for example, 127.0.0.1).

    Scripted Uninstall of Edge DX Agent for Windows

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

    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.


    Was this article helpful?