Install connector in VMware

VMware is a virtualization and cloud computing software provider. VMware bases its virtualization technologies on its bare-metal hypervisor ESX/ESXi in x86 architecture. It allows you to run multiple virtual machines on a single physical machine, with each virtual machine sharing the resources of that one physical computer across multiple environments. Different virtual machines can run different operating systems and multiple applications on the same physical computer.

VMware vSphere is a cloud operating system, or virtualized data center platform. VMware vSphere includes the following components:

  • VMware ESX / ESXi hypervisor. A type-1 hypervisor that functions as the virtualization server.

  • VMware vCenter Server. Manages vSphere environments.

  • VMware vSphere Client. Installs and manages virtual machines through the hypervisor. It allows you to deploy and export virtual machines, virtual appliances (a preconfigured virtual machine that typically includes a preinstalled guest operating system and other software), and vApps stored in Open Virtual Machine Format (OVF).

  • VMware VMFS. The file system component from VMware.

Create and download a connector in EAA

Create an Enterprise Application Access (EAA) identity connector and download the connector file to install in a virtual environment.

  1. Log in to Enterprise Center.

  2. In the Enterprise Center navigation menu, select Application Access > Clients & Connectors > Access and Identity Connectors.

  3. Click Add New Connector (+).

  4. Enter a connector name and an optional description.

  5. For Package select VMware.

  6. (Optional) If you need remote debugging, enable Debugging.

  7. Click Save.
    The connector you created appears in Connectors list page. You will see Created in the Status column. A banner appears indicating that you will receive an email when the connector file is ready for download. Click the Download Template link.

  8. Download the connector file and save it in a secure location. The contents of the connector .tgz file is required to set up the connector in the virtual environment.


It may take some time before your connector file is available for download.

Next, install the connector in a virtualized environment.

Install the connector in VM

After you create and download a connector in EAA, you can install it in your virtualized environment (VM).

Connector footprint:

ProcessorsIntel-VT, or AMD-V with hardware virtualization enabled four cores
Memory (RAM)8 GB
Storage16 GB
Network1 vNIC,1 GB/s, Static IP address or dynamic IP assigned from DHCP server, DNS
  1. Install your EAA connector VM in either vSphere, VMware Workstation, VMware Player, or Virtual Box. Follow the instructions from the Connector VM ready for deployment email.

Next, deploy the connector.

Deploy the connector

Initial Setup

  1. Download the VMware connector from the Enterprise Center.
  2. The connector downloads as a tar.gz file but the file extension may be incorrect in Microsoft Windows. Rename the tar file to tar.gz file. For example, rename <filename>.tar to<filename>.tar.gz.
  3. Extract the /agentdirectory.
  4. To deploy a connector with ESX or ESXi follow the steps below based on which version of ESX or ESXi you are using.

Deploy a VMware vSphere Client using ESX or ESXi versions earlier than 6.5

  1. In the VSphere Client:
    a. Select Create/Register VM

vsphere create

b. Choose, Deploy a virtual machine from an OVF or OVA file

vsphere deploy

c. Upload the agent.ova file.

vsphere drop
Make sure that the Open Virtualization Application/Appliance (OVA) deployment is completed successfully. Wait for the success message to appear.

Deploy a VMware vSphere Client using ESX or ESXi version 6.5 or later

Prerequisite: To deploy a connector with ESX or ESXi versions later than 6.5, use the VMware Open Virtual Machine Format (OVF) tool from a command line interface.

Execute this CLI command:


Note: See OVF CLI Command line options guide for additional details.

Verify that connector is running

  1. Return to the Enterprise Application Access.
  2. In the Enterprise Center navigation menu, select Application Access > Clients & Connectors > Access and Identity Connectors.
  3. On the connector list page, check your connector. The connector status should be Ready and should see Connector is running.

If your connector fails to check-in after five minutes, there may be a problem with its networking DHCP configuration or an outbound connection through your firewall or forward proxy. You can use the connector VM console menu (option 5) to check the reachability to Cloud. If issues are not resolved also see, Troubleshoot connectors.