The UpGuard appliance is the on-premises version of an UpGuard Core instance. The appliance works as a black-box, where only UpGuard employees will have access to modify its contents.

System Requirements

  • Minimum appliance specifications:
    Nodes Up to 1,000 1,001 to 5,000 5,001 to 10,000 Over 10,000
    CPU 8 CPU Cores 16 CPU Cores 32 CPU Cores Please contact your Account Manager for more information.
    RAM 32 GB RAM 64 GB RAM 128 GB RAM
    STORAGE diskA: default
    diskB: 150GB
    diskC: 150GB
    diskD: 100GB
    diskE: 100GB
    diskA: default
    diskB: 500GB
    diskC: 500GB
    diskD: 100GB
    diskE: 100GB
    diskA: default
    diskB: 1TB
    diskC: 1TB
    diskD: 100GB
    diskE: 100GB
  • The appliance will need to be accessible over port 443 for:
    • All Connection Managers
    • All users accessing the UpGuard Web UI
  • It is recommended that one Connection Manager is deployed for every 1,000 - 1,500 nodes intending to be scanned.


  1. The appliance is distributed as a black-box appliance in OVA format. If you need a different format, please contact UpGuard Support.

  2. Please contact UpGuard support for a download link.

  3. After downloading, proceed to importing the appliance.


The ova file should be imported into your VMWare environment without modifying any settings.

Configuring a static IP and hostname is done via the console after the machine is booted, see Advanced Configuration.

Advanced Configuration

Once the appliance has booted, you can enter the configuration utility through the console by pressing Alt+F9 (on Windows) or fn+Alt+F9 (on Mac).

You can use the configuration utility to setup advanced network configuration details for the appliance.

Configure Networking

  1. Select Configure Networking and press Enter.


  2. Select the only network interface to use and press Enter.


DHCP Configuration

  1. Choose Dynamic (DHCP) Configuration in the utility menu and press Enter to continue. The appliance will then be assigned an IP address.


  2. Return to the “Configure Networking” screen and find the IP address indicated by the network adapter name.


  3. You may also exit out of ConfigTTY using Alt+F1 (on Windows) or fn+Alt+F1 (on Mac) to view the IP address from the console.


Static Configuration

  1. Choose Static Configuration in the utility menu and press Enter to continue.


  2. You can then Enter the desired IP address, netmask, gateway and DNS information for the appliance.


    Field Description
    IP Address / Netmask Specifies the IP address that will be used for the appliance. The CIDR suffix is mandatory.
    Gateway Specifies the address for the gateway to be used by the appliance.
    DNS Servers Specifies the DNS servers that the appliance will use for name resolution.
  3. Ensure that you Apply Configuration to save your settings before finishing.

  4. It is recommended to reset the appliance (through VMWare) to make sure it uses the correct network configuration.

Configure Hostname

  1. Choose Configure Hostname and press Enter.


  2. Enter your Hostname and press Enter.


    Field Description
    Hostname This setting allows you to specify the name that will be used by the appliance when it is registered with the UpGuard website. This can also be set via the connection manager’s web interface.
  3. Once finished, choose Exit and press Enter.

Next Steps

Once an appliance is configured and running, please contact UpGuard support to complete the appliance provisioning.

For more information around some ongoing appliance tips and tricks, please visit our guide on Appliance Maintenance.

Tags: appliance ova