Download and install the Cloud Gateway Appliance if you want to enable Hybrid Linked Mode from your on-premises SDDC or access other solutions available from the Cloud Gateway Appliance.
Verify that the host on which you intend to the install the Cloud Gateway Appliance meets the following hardware requirements.
- Ensure that the Cloud Gateway Appliance and your vCenter Server instances can reach each other over your network. Ensure that the following firewall ports are open.
Source Destination Port Purpose User's web browser Cloud Gateway Appliance 5480 Gathering support bundle Cloud Gateway Appliance On-premises vCenter Server 7444 Access to VMware Single Sign-On Cloud Gateway Appliance On-premises vCenter Server 443 Hybrid Linked Mode Cloud Gateway Appliance On-premises Platform Services Controller 443, 389 Hybrid Linked Mode Cloud Gateway Appliance Cloud SDDC vCenter Server 443 Hybrid Linked Mode Cloud Gateway Appliance Cloud ESXi host 902 Virtual Machine Console Cloud Gateway Appliance On-premises Active Directory server (ports dependent on your usage) 389, 636, 3268, 3269 Identity source Cloud Gateway Appliance https://vcgw-updates.vmware.com/ 443 Cloud Gateway Installation and Auto-update, Hybrid Linked Mode
The following figure shows the ports required to be open for linking with the Cloud Gateway Appliance.
- Log in to the VMC Console at https://vmc.vmware.com.
- Click the Tools () tab.
- Click Download on the Gateway Appliance card.
You are directed to Customer Connect, where you can complete the download of the appliance installer ISO image.
- 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.
- Click Get Started.
- Accept the End User License agreement and click Next.
- Specify the Gateway deployment parameters and click Next.
Option Steps You can connect to an ESXi host on which to deploy the appliance.
- Enter the FQDN or IP address of the ESXi host.
- Enter the HTTPS port of the ESXi host.
- Enter the user name and password of a user with administrative privileges on the ESXi host, for example, the root user.
- Click Next.
- 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.
- Enter the FQDN or IP address of the vCenter Server instance.
- Enter the HTTPS port of the vCenter Server instance.
- 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.
- Click Next.
- 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.
- 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.
- Select the ESXi host or DRS cluster on which you want to deploy the appliance, and click Next.
- Set up the target appliance VM and click Next.
Parameter Description VM name Enter a name for the 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 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.
- Select the datastore location for the Cloud Gateway Appliance and click Next.
- Select the datastore where you want to place the Cloud Gateway Appliance.
- Select Enable Thin Disk Mode to conserve disk space by deploying the appliance using a thin disk.
- 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.
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.
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.
- 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.
- Click Finish to deploy the appliance.
What to do next
To configure services, open the Cloud Gateway Appliance UI at https://gw-address:5480/gw-platform/ where gw-address is the IP address or FQDN of the appliance.
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.