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


  • The installer OVA deployment must complete before you begin. Allow up to five minutes after the installer OVA deployment for the services to initialize.


  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. Update the HCX Activation Server URL to
  4. Enter the License Key.
  5. (Optional) If there is a proxy server in the environment in the path for outbound HTTPS connections, select 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.

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

  7. Click OK.

    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.
  8. To start the configuration wizard, log in to the system using the admin user credentials.
    The system location screen appears.
  9. 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.

  10. Click Continue.
    A screen appears prompting you for a system name.
  11. Enter the system name, and click Continue.
    A screen appears prompting you to select the cloud instance type.
  12. Select the cloud instance to which HCX for Telco Cloud is connected: vSphere, vCloud Director, VMware Integrated OpenStack, or Kubernetes.
    Note: The HCX can connect to only one cloud instance per deployment.
  13. Click Continue.
    A series of screens appears to request the configuration details for your selection.
  14. 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


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

    vCloud Director

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

    VMware Integrated OpenStack

    1. Enter the VMware Integrated OpenStack (VIO) details:
      • OpenStack Management Server (OMS) URL
      • User name
      • Password
    2. Enter the Keystone details:
      • Admin user name
      • Admin Password
    3. Enter the 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 drop-down)
      • User name
      • Password
      • Projects (optional)

        For each Domain, you can add multiple Projects.

        • Project Name (select from drop-down)
        • User name
        • Password
    4. Enter the vCenter and NSX details:
      1. vCenter Server
        • vCenter URL
        • User name
        • Password
      2. NSX
        • NSX URL
        • User name
        • Password
    5. Enter the AMQP details:
      • AMQP Hostname
      • Port
      • vHost
      • User name
      • Password
      • Use SSL


    1. Enter the Kubernetes Cluster details:
      • Kubernetes Master API Server URL
      • Kubernetes Cluster Name (logical name that uniquely identifies this cluster)

        Enter a logical name that uniquely identifies this cluster.

      • Kubernetes Configuration (kubeconfig YAML file for authentication)
    The system verifies the configuration and then generates a configuration summary.
  15. Review the system summary information.
    Summary information can vary depending on the cloud instance type.
  16. 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.

  17. (vSphere instance only) Configure vSphere roles for the vSphere 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 sufficient privileges to perform the HCX-related operations in vCenter Server.

    3. Click Save.
  18. Connect to vRealize Orchestrator.
    The HCX supports connection to VMware vRealize Orchestrator for the workflow automation development and management. The vRealize Orchestrator is required for pre- or post scripts run as part of the virtualized network function (VNF) or cloud-native network function (CNF) deployments.
    1. Navigate to the appliance management interface: <hcx-ip-or-fqdn>:9443.
    2. Select the Configuration tab, and click vRealize Orchestrator..
    3. Click Edit.
    4. Enter the vRealize Orchestrator URL (https://<vro-ip-or-fqdn>), port details, and administrative credentials, and click Update.
      Note: If vRealize Orchestrator is signed with a self-signed certificate, you must import the vRealize Orchestrator certificate using the method described in the section "Importing Certificates with a Remote Site URL." The port is mandatory while importing certificates. For vRealize Orchestrator version 7.x, use port 8281: < https://vro-ip-or-fqdn>:8281. For vRealize Orchestrator version 8.x, use port 443: < https://vro-ip-or-fqdn>:443. See Managing CA and Self-Signed Certificates.


The initial system configuration is complete.

What to do next

Complete the procedure for activating and configuring the VMware Telco Cloud Automation component.