After you have deployed the OVA file, activate the system and perform the initial configuration immediately when you next open the appliance management interface.

Note: You use this same procedure for both HCX Cloud Manager and HCX Connector deployments.

Prerequisites

  • The OVA deployment must complete before you begin. Allow up to five minutes after the installer OVA deployment for the services to initialize.
  • Configure firewall rules at source and destination sites to allow inbound and outbound connectivity based on the HCX services or features used. See https://ports.vmware.com/home/VMware-HCX.
  • Obtain the activation key based on the HCX destination type. See Activating or Licensing New HCX Systems.

Procedure

  1. Browse to the appliance management interface and log in using the admin user credentials.
    Browse to https://hcx-ip-or-fqdn:9443.

    After you log in, the installation welcome screen appears.
  2. Click Continue.
    The activation screen appears.
  3. Enter the License Key.
  4. (Optional) If there is a proxy server in the environment in the path for outbound HTTPS connections, check Configure Proxy.

    If a proxy server is entered, add the local vCenter, ESXi, NSX, SSO, and HCX-IX systems as exceptions not to be sent to the proxy server.

  5. Click Activate.

    The system prompts you to confirm the deployment type. The system detects the deployment type based on the license key and displays a graphic illustrating the installation component.

  6. Click OK.
    The Manage License Keys screen appears.
  7. (Optional) If you have an HCX Enterprise License (upgrade) key, enter it in the HCX License Key field, and click Add.
    The upgrade license key is added to the license key table with the activation key. The table includes information about each license key and its duration.
  8. Click Next.
  9. Observe the system download information.
    After you enter the license information and confirm the deployment type, the system begins downloading the image file that is specific to the deployment type. If upgrades are available, they are applied before the download. The download process can take several minutes depending on your environment. A display screen provides the download status.
    When the download is complete, the system reloads, and the log in screen appears.
  10. To start the configuration wizard, log in to the system using the admin user credentials.
    The system location screen appears.
  11. Enter the location where you are deploying the system.

    Select the nearest major city to where the HCX system is geographically located. HCX sites are represented visually in the Dashboard.

  12. Click Continue.
    A screen appears prompting you for a system name.
  13. Enter the system name, and click Continue.
    A screen appears prompting you to select the cloud instance type.
  14. Select the cloud instance to which VMware HCX will be connected: vSphere, vCloud Director, or VMware Integrated OpenStack.
    The HCX can connect to only one cloud instance per deployment.
    Note: Kubernetes is not available for VMware HCX.
  15. Click Continue.
    A series of screens appears, prompting you for the selection details.
  16. Enter the configuration details for the selected cloud instance.
    After entering the information, click Continue to proceed to the next screen

    Cloud Instance

    Configuration Parameters

    vSphere

    1. vCenter Server and NSX details
      1. vCenter Server
        • vCenter URL
        • User name
        • Password
      2. NSX
        • NSX URL
        • User name
        • Password
    2. SSO details
      • vCenter Server or Platform Services Controller URL
    3. Public Access URL details
      • URL through which the HCX Manager is accessed.
        Note: This is typically the HCX Manager services UI: https// <hcx-mgr-fqdn-or-ip>.

    vCloud Director

    1. vCloud Director details
      • vCloud Director URL
      • System Administrator user name
      • System Administrator password
    2. vCenter Server and NSX details
      Note: The HCX Manager automatically fetches the vCenter Server and NSX URLs.
      1. vCenter Server
        • User name
        • Password
      2. NSX
        • User name
        • Password
    3. AMQP details
      Note: The HCX Manager automatically fetches the AMQP parameters. Edit the parameters as appropriate.
      • AMQP Host name
      • Port
      • vHost
      • User name
      • Password
      • Use SSL

    VMware Integrated OpenStack

    1. VMware Integrated OpenStack (VIO) details
      • OpenStack Management Server (OMS) URL
      • User name
      • Password
    2. Keystone details
      • Admin user name
      • Admin password
    3. Domains and Projects details
      Note: You can add Multiple VIO Domains and Projects.
      1. Add New Domain

        For each Domain, provide the following details.

      • Domain Name (select from the drop-down)
      • User name
      • Password
      • Projects (optional)

        For each Domain, you can add multiple Projects.

        • Project Name (select from the drop- down)
        • User name
        • Password
    4. vCenter and NSX details
      1. vCenter Server
        • vCenter URL
        • User name
        • Password
      2. NSX
        • NSX URL
        • User name
        • Password
    5. AMQP details
      • AMQP Host name
      • Port
      • vHost
      • User name
      • Password
      • Use SSL
    The system verifies the configuration and then generates a configuration summary.
  17. Review the system summary information.
    Summary information can vary depending on the cloud instance type.
  18. To reload the system, click Restart.
    It can take several minutes to reinitialize the system completely. During this process, the appliance management interface is not available.

    After the system reloads, it displays the appliance management dashboard. For more information about the dashboard, see Understanding the Appliance Management Dashboard.

  19. (vSphere instance only) Configure vSphere roles for the cloud instance.
    1. In the appliance management dashboard, navigate to Configuration > vSphere Role-Mapping.
    2. Assign the HCX Roles to the vCenter User Groups that are allowed to perform HCX operations.

      The groups assigned must have the minimum privileges to perform the HCX-related operations in vCenter Server.

      vCenter Resource Type User Privilege Description
      ComputeResource/HostSystem/ClusterComputeResource/ResourcePool VirtualMachine.Inventory.Create On the selected destination compute resource, assign user privileges to create a virtual machine.
      ComputeResource/HostSystem/ClusterComputeResource/ResourcePool VirtualMachine.Interact.PowerOn On the selected destination compute resource, assign user privileges to power on a virtual machine.
      Folder/Datacenter VirtualMachine.Inventory.Create On the selected destination folder (vCenter Inventory), assign user privileges to create a virtual machine.
      Folder/Datacenter VirtualMachine.Interact.PowerOn On the selected destination folder (vCenter Inventory), assign user privileges to power on a virtual machine.
      Datastore Datastore.UpdateVirtualMachineMetadata On the selected destination datastore, assign user privileges to update virtual machine related files.
      Datastore Datastore.DeleteFile On the selected destination datastore, assign user privileges to delete files.
      DistributedVirtualPortgroup/Network Network.Assign On the selected destination Network, assign user privileges to connect NICs.
      VirtualMachine VirtualMachine.Interact.PowerOn On the selected virtual machine, assign user power-on privileges. This permission is required on source side. All the other permissions are required on destination side.
    3. Click Save.

Results

The system configuration is complete.

What to do next

Deploy additional HCX systems.