Download and install the vCenter Cloud Gateway Appliance if you want to link and manage your cloud SDDC from your on-premises data center.

Prerequisites

Ensure that you meet the prerequisites outlined in Hybrid Linked Mode Prerequisites.

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. In the installer ISO image, browse to the ui-installer folder and open the folder for the operating system from which you want to install the appliance.
    • For Windows OS, go the win32 subdirectory and run the installer.exe file.
    • For Linux OS, go to the lin64 subdirectory, and run the installer file.
    • For Mac OS, go to the mac subdirectory and run the Installer.app file.
  5. Click Get Started.
  6. Under Deploy Cloud Gateway, click Start.
  7. Accept the End User License agreement.
  8. Specify the Gateway deployment parameters and click Next.
    Option Steps
    You can connect to an ESXi host on which to deploy the appliance.
    1. Enter the FQDN or IP address of the ESXi host.
    2. Enter the HTTPS port of the ESXi host.
    3. Enter the user name and password of a user with administrative privileges on the ESXi host, for example, the root user.
    4. Click Next.
    5. Verify that the certificate warning displays the SHA1 thumbprint of the SSL certificate that is installed on the target ESXi host, and click Yes to accept the certificate thumbprint.
    You can connect to a vCenter Server instance and browse the inventory to select an ESXi host or DRS cluster on which to deploy the appliance.
    1. Enter the FQDN or IP address of the vCenter Server instance.
    2. Enter the HTTPS port of the vCenter Server instance.
    3. Enter the user name and password of user with vCenter Single Sign-On administrative privileges on the vCenter Server instance, for example, the administrator@your_domain_name user.
    4. Click Next.
    5. Verify that the certificate warning displays the SHA1 thumbprint of the SSL certificate that is installed on the target vCenter Server instance, and click Yes to accept the certificate thumbprint.
    6. Select the data center or data center folder that contains the ESXi host or DRS cluster on which you want to deploy the appliance, and click Next
      Note: You must select a data center or data center folder that contains at least one ESXi host that is not in lockdown or maintenance mode.
    7. Select the ESXi host or DRS cluster on which you want to deploy the appliance, and click Next.
  9. Set up the target appliance VM and click Next.
    Parameter Description
    VM name Enter a name for the vCenter Cloud Gateway Appliance VM. The appliance name must not contain a percent sign (%), backslash (\), or forward slash (/) and must be no more than 80 characters in length.
    Set root password Set a root password for the vCenter Cloud Gateway Appliance VM.

    The password must contain only lower ASCII characters without spaces, at least eight characters, a number, uppercase and lowercase letters, and a special character, for example, an exclamation mark (!), hash key (#), at sign (@), or brackets (()).

    Confirm root password Confirm the password you set above.
  10. Select the datastore location for the vCenter Cloud Gateway Appliance and click Next.
    1. Select the datastore where you want to place the vCenter Cloud Gateway Appliance.
    2. Select Enable Thin Disk Mode to conserve disk space by deploying the appliance using a thin disk.
  11. Configure the network settings for the appliance and click Next.
    Parameter Description
    Network Select the network

    The networks displayed in the drop-down menu depend on the network settings of the target server. If you are deploying the appliance directly on an ESXi host, non-ephemeral distributed virtual port groups are not supported and are not displayed in the drop-down menu.

    IP version Select the version for the appliance IP address.

    You can select either IPv4 or IPv6.

    IP assignment Select how to allocate the IP address of the appliance.
    • static

      The wizard prompts you to enter the IP address and network settings.

      Note: Avoid using an IP address as a system name. If you use an IP address as a system name, you cannot change the IP address and update the DNS settings after deployment.
    • DHCP

      A DHCP server is used to allocate the IP address. Select this option only if a DHCP server is available in your environment.

    FQDN If you have an enabled DDNS in your environment, you can enter a fully qualified domain name (FQDN) for the appliance. If you enter a FQDN that already exists, the installer warns you that this will cause an error in deployment unless you isolate the network that the appliance is on. For example, you can deploy the appliance on a different port group from the existing FQDN.
    IP address If you selected a static IP address, enter the IP address for the appliance. If you enter an IP address that already exists, the installer warns you that this will cause an error in deployment unless you isolate the network that the appliance is on. For example, you can deploy the appliance on a different port group from the existing IP address.
    Subnet mask or prefix length Enter the subnet mask or prefix length for the IP address.
    Default Gateway Enter the default gateway to be used by the appliance.
    DNS Servers Enter the addresses of the DNS servers used by the appliance.
  12. Configure appliance Settings and click Next.
    • Select Synchronize Time with NTP servers and enter the address of one or more NTP servers in the text box to use NTP servers for time synchronization.
    • Select Synchronize Time with ESXi host to synchronize time to the host you're deploying to.
  13. Configure SSO settings.
    Option Description
    Platform Services Controller Enter the IP address or fully qualified domain name of the Platform Services controller in your on-premises environment.
    HTTPS Port Enter the HTTPS port used by the Platform Services Controller.
    Single Sign-On Domain Enter the Single Sign-On domain used by your on-premises Platform Services Controller.
    Single Sign-On User Name Enter the Single Sign-On administrator user name in the form user@sso-domain.
    Single Sign-On Password Enter the Single Sign-On administrator password.
  14. Select whether to join the vCenter Cloud Gateway Appliance to your Active Directory domain.
    Option Description
    Skip Select this option to skip the step of joining the vCenter Cloud Gateway Appliance to the Active Directory domain. You will need to join the appliance to the domain later before you link the appliance.
    Join Enter the following parameters:
    1. In the Domain text box, enter an Active Directory domain name. For example, mydomain.com.
    2. Optionally, in the Organizational Unit text box, provide the full OU LDAP FQDN. For example, OU=Engineering,DC=mydomain,DC=com.
    3. In the Username text box, enter the user name for the Active Directory administrator in User Principal Name (UPN) format. For example, example@mydomain.com.
    4. In the Password field, enter the password for the Active Directory administrator.
  15. Click Finish to deploy the appliance.

Results

The vCenter Cloud Gateway Appliance is deployed to your on-premises environment. A progress bar shows the progress of deployment.

What to do next

Continue to step 2 of the installer to link the vCenter Cloud Gateway Appliance to your cloud SDDC. See Link the vCenter Cloud Gateway Appliance to Your Cloud SDDC from the vCenter Cloud Gateway Appliance Installer.

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.