Use the command-line installer to script or automate your Cloud Gateway Appliance installation.

Note: The instructions in this section apply to version 1.11 and later of the SDDC software.

Use the command vcgw-deploy to install the Cloud Gateway Appliance from the command line. In addition to installing the appliance, you can use vcgw-deploy to validate your installation templates and run pre-checks on your installation. For a full list of vcgw-deploy options, run vcgw-deploy install --help.

Prerequisites

Verify that the host on which you intend to the install the Cloud Gateway Appliance appliance meets the following hardware requirements.

Hardware Minimum required
CPUs 8
Memory 24 GB
Storage 190 GB

Procedure

  1. Log in to the VMC Console at https://vmc.vmware.com.
  2. Click the Tools () tab.
  3. Click Download on the Gateway Appliance card.
    You are directed to My VMware, where you can complete the download of the appliance installer ISO image.
  4. Prepare a JSON template for the installation.
    1. In the installer ISO image, browse to the cli-installer/templates directory.
      This directory contains sample JSON templates for installing the Cloud Gateway Appliance either directly on an ESXi host or through a vCenter Server system.
    2. Copy a template to a working directory and edit it to include the necessary parameters.
      For more information about available template parameters, invoke the installer with the option --template-help. For example, on Windows, enter vcgw-deploy.exe install --template-help.
  5. From the command line, change directory to the cli-installer directory and run the installation prechecks.
    • For Windows OS, enter vcgw-deploy.exe install path-to-template --precheck-only.
    • For Linux OS, enter vcgw-deploy install path-to-template --precheck-only.
    • For Mac OS, enter vcgw-deploy install path-to-template --precheck-only.
    The prechecks identify problems with the template and parameters provided, so that you can fix any errors before launching the installation.
  6. Launch the installer.
    • For Windows OS, enter vcgw-deploy.exe install path-to-template --accept-eula.
    • For Linux OS, enter vcgw-deploy install path-to-template --accept-eula.
    • For Mac OS, enter vcgw-deploy install path-to-template --accept-eula.

What to do next

Note:

After you have installed the appliance, consider configuring appliance log collection following the guidelines in VMware Knowledge Base article 67158. Appliance logs are useful when requesting support.