The UpGuard agent is used to collect scan data for the UpGuard website to analyse. Scans take from as little as 30 seconds to complete. Outbound HTTPS access is required for communication to the UpGuard website.

System Requirements

  • A Windows machine on which to install the agent.
  • .NET framework version 4.5.2 or higher
  • PowerShell (Windows Management Framework) version 3 or higher
  • Outbound HTTPS access to the UpGuard website.

Downloading and Installing

  1. Log into your https://app.upguard.com (or appliance URL) account and click the Add Node button on the top right.
  2. Select Windows, then Agent and click on Windows Installer to download the UpGuard agent installer.
  3. When prompted to enter your “Service API Key” by the installer wizard, copy the API Key from the “Install and Scan Instructions” box on the website.
  4. Review “Target URL” and “Configuration Directory” options.
  5. Click next to install the agent and register the node with the UpGuard website.
  6. Once the installation has completed, return to the UpGuard website and click Continue to have your node scanned.

Unattended Install

The Windows agent is designed to be installed by a script. To see the command line arguments available, run:

UpGuard-vX.Y.Z.exe --help

For most UpGuard instances, you should be able to run an unattended install with:

UpGuard-vX.Y.Z.exe --mode unattended --target_url https://your.upguard.appliance --api_key <api key from step 3 above>

Updating

You can update the UpGuard agent by installing a new version right over the top of an existing install.

  1. Visit our downloads page to obtain the latest installer.
  2. New versions of the UpGuard agent can then be installed in-place.

Uninstalling

The UpGuard agent can be uninstalled either through “Add/Remove Programs” or via the “UpGuard Uninstaller” link located in the install directory. By default this is C:\Program Files (x86)\UpGuard.

Configuration

Changing the Default Test Timeout

By default UpGuard will timeout any tests which run for longer than 45 seconds. This is usually sufficient but in some cases you may want to override this value.

  1. Locate your upguard.yml file. The default location for this is C:\Program Files (x86)\UpGuard\.upguard .
  2. Update the test_timeout value to the desired value in seconds. Scan timeouts related to the scanning of Windows 2008 hotfixes and hardware often requires a value around 300 - 500 seconds.

Additional Help