Skip to content

VMware

The VMware-based deployment is the recommended installation method for most environments, providing a fast and straightforward deployment process.

Prerequisites

For a VMware installation, the following prerequisites must be met:

  • VMware vSphere ESXi 8.0 or newer

Image Download

First, go to the Software Downloads Portal, select ControlGuard, then ControlGuard vX for VMware and proceed to the download by following the link to the latest VMWare image file.

We recommend verifying the SHA256 signature of the downloaded image file using the following command:

sha256sum ControlGuard-vX-2025.20.0240b1-vmware-x64.ova

sha256sum ControlGuard-vX-2025.20.0240b1-vmware-x64.ova

Ensure that the checksum displayed in the output exactly matches the SHA256 value published on our official download page. Never use checksums obtained from untrusted or third-party sources, as doing so may compromise the integrity and security of your installation.

Virtual Machine Installation

To deploy a virtual machine (VM) from an OVA file on VMware ESXi, log in to the ESXi Host Client, right-click the host, and select Create/Register VM. Choose to Deploy a virtual machine from an OVF or OVA file, then click Next. Follow the wizard to upload the OVA image file you downloaded, provide a name for the new VM, select the storage and network, and review the details before finishing the deployment.

Step-by-step guide

  1. Log in to the ESXi Host Client: Access your ESXi host through its web client.
  2. Initiate VM creation: Right-click the host in the inventory and select Create/Register VM.
  3. Select the deployment type: Choose Deploy a virtual machine from an OVF or OVA file and click Next.
  4. Upload the OVA file: Click the blue pane to browse your local machine and select the OVA image file, then click Open.
  5. Specify VM details: Enter a name for your new VM and click Next.
  6. Select storage: Choose the datastore where the VM's files will be stored and click Next.
  7. Configure network: Map the VM's network adapter to the correct network in your environment.
  8. Review and complete: Review the deployment settings on the Ready to complete page and click Finish to start the deployment process.
  9. Post-deployment configuration: After the import is complete, you can select the new VM to configure options like CPU, memory, or other settings as needed.

Initial Setup

Web-based Setup Wizard

When starting the virtual machine for the first time, a setup wizard will be accessible via a web browser at https://VM-IP:8443, where VM-IP is the IP address assigned to the virtual machine. By default, the virtual machine obtains an IP address automatically via DHCP. If no DHCP service is available, the virtual machine will automatically configure itself with the fallback IP address 192.168.1.1.

Delay processing requests

The host and web-based setup wizard may take several minutes to become accessible after the initial boot.

Log in to the web-based setup wizard using the following default credentials:

  • Username: admin
  • Password: controlguard

Follow the on-screen instructions to complete the initial configuration. During this process, you will be required to change the administrator password and will have the option to modify the virtual machine’s hostname, IP address, DNS settings, and other parameters.

Once all configuration steps are completed, the virtual machine will automatically reboot to apply the new settings.

Control-based Setup

Alternatively you can complete the initial setup directly on the host console via SSH.

Connect using SSH to the host using the admin user and the controlguard password, substituting <VM-IP> with the actual IP address assigned to the virtual machine. Once logged in, launch the installation wizard by executing the cginstall command:

$ ssh admin@<VM-IP>
[admin@controlguard-vx ~]$ cginstall
Welcome to the ControlGuard vX Setup
[...]

Follow the on-screen prompts provided by the console setup program. Upon completion, the host will automatically reboot to apply the new settings.