The UpGuard agent is used to collect scan data on behalf of the UpGuard appliance. 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. In the UpGuard website navigate to Discover and then Add Nodes via the top navigation bar.
  2. Type windows in the search bar to highlight all supported Windows types and click on the version of Windows you plan to register, then select to use the agent.
  3. First, click the Download Agent button to download the latest Windows Agent Installer.
  4. Run the Windows Agent Installer on the Windows device you wish to register with UpGuard and this will begin the installation and registration process.
  5. When prompted to enter your API Key, copy the API key from the website into the installation wizard.
  6. On the same screen, modify the Target URL to match the appliance you are logging in from. For example, if you are logged into an appliance from https://me.upguard.com, then this is your Target URL.
  7. Review “Configuration Directory” option to decide where to install the agent and configuration files.
  8. Click next to install the agent and register the node with the UpGuard website.
  9. Once the installation has completed, return to the UpGuard website and click Scan Node to have your node scanned for the first time.

Unattended Install

The Windows agent is designed to be installed via an automated process such as 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://you.upguard.com --api_key <api key from step 5 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\UpGuard.

Configuration

Changing the Default Test Timeout

By default UpGuard will timeout any tasks 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\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