Use the command-line installer to script or automate your VMware Cloud Gateway 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 VMware Cloud Gateway from the command line. In addition to installing VMware Cloud Gateway, 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.

Procedure

  1. Download the VMware Cloud Gateway installer:

    • For vSphere+ and VMware Cloud Foundation+: Log in to the VMware Cloud Gateway Download page and download the ISO image.

    • For VMware Cloud on AWS:

      1. Log in to the VMware Cloud Console at https://vmc.vmware.com.

      2. Click the Tools tab.

      3. Click Download on the Gateway Appliance card.

        You are directed to Customer Connect, where you can download the installer ISO image.

  2. 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 VMware Cloud Gateway either directly on an ESXi host or through a vCenter Server system.

      For VMware Cloud Foundation+, modify the JSON template to point to the FQDN or IP address of the vCenter Server instance for the management domain.

    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.

  3. 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.

  4. 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.

For VMware Cloud Foundation+, set up also the high availability of the VMware Cloud Gateway VM in the following way:

  • On the Configure tab for the default management cluster, click VM Overrides and set the restart priority policy for theVMware Cloud Gateway VM to high.

  • In an environment with multiple availability zones, add the VMware Cloud Gateway VM to the VM group for the first availability zone.