VMware ESXi and vSphere Cluster Management
Install the VMware Client Integration Plug-in for vSphere Web Client
Learn how to download, install, and verify the legacy VMware Client Integration Plug-in for virtual machine console access through the vSphere Web Client.
What the VMware Client Integration Plug-in Does
The VMware Client Integration Plug-in is a workstation-installed VMware component for the legacy vSphere Web Client. It connects supported browser-based management functions with applications and capabilities on the administrator's computer.
Its main purpose in this workflow is to enable the vSphere Web Client to launch an interactive virtual machine console. A virtual machine console provides direct display and keyboard input access to a guest operating system, similar to using a physical monitor and keyboard.
The plug-in is installed on the administrator's workstation. It is not installed on the ESXi host, the vCenter Server appliance, or the virtual machine. Installing it also does not grant permissions; the signed-in vSphere account must already be allowed to view the virtual machine and open its console.
Legacy Environment and Version Context
This procedure applies to the legacy vSphere Web Client, commonly accessed through an HTTPS URL using TCP port 9443. The usual URL pattern is:
https://WEB_CLIENT_URL:9443/vsphere-clientReplace WEB_CLIENT_URL with the host name or IP address of the system hosting the vSphere Web Client. The actual URL path, browser support, desktop operating system support, and installer behavior depend on the installed vSphere release.
The legacy vSphere Web Client should not be confused with the newer vSphere Client based on an HTML5 interface. Modern releases can use different console mechanisms and may not require this plug-in. Always match the client, browser, operating system, and console method to the vSphere version being managed.
Prerequisites
- Network access from the management workstation to the vSphere Web Client server.
- A supported desktop operating system and browser for the applicable vSphere release. Do not assume that every current browser supports a legacy plug-in.
- Permission to download and install software locally. Local administrator rights may be required.
- A valid vSphere Web Client host name or IP address and the correct HTTPS port, commonly 9443.
- Certificate trust and browser security settings that permit access to the Web Client endpoint.
- An account with vSphere permissions sufficient to view the target virtual machine and launch its console.
Close browsers or active console sessions if the installer requests it. Save work first, because a browser restart may be needed after installation.
Installation Checklist
| Stage | Action | Expected Result | Notes |
|---|---|---|---|
| Pre-installation validation | Confirm version, operating system, browser, network access, certificate trust, and local installation rights. | The workstation is suitable for the legacy client. | Compatibility is release-dependent. |
| Open Web Client endpoint | Browse to the HTTPS Web Client address on TCP port 9443. | The Web Client sign-in page loads. | Use the organization-approved host name or IP address. |
| Download installer | Select the Client Integration Plug-in download link and save the file locally. | The installer completes without an error. | Use a known, writable folder. |
| Run installation wizard | Launch the installer, review the introduction, accept the EULA, and choose the destination. | The wizard is ready to install the component. | Retain the default path unless policy requires another location. |
| Complete installation | Start the installation and wait for copying and registration to finish. | The final confirmation screen reports success. | Restart the browser if requested. |
| Launch and test VM console | Sign in, select an authorized virtual machine, and launch its console. | The console opens and accepts keyboard and mouse input. | Approve permitted browser or external-application prompts. |
Step 1: Open the vSphere Web Client
- Open a supported browser on the administrator's management workstation.
- Enter the Web Client address using HTTPS and the port used by the legacy deployment. For this workflow, the common pattern is
https://WEB_CLIENT_URL:9443/vsphere-client. - Confirm that the page belongs to the expected vCenter Server or Web Client endpoint.
- If the browser displays a certificate warning, stop and validate the endpoint before continuing.
Test reachability if the page does not load. Check the host name or IP address, DNS resolution, firewall and proxy rules, and whether the Web Client service is available. A vSphere administrator may need to confirm server-side service status.
Step 2: Download the Client Integration Plug-in
- Locate the Client Integration Plug-in download control on the vSphere Web Client sign-in or landing page.
- Select the download link presented by the Web Client. Download the installer only from the organization's expected vSphere Web Client endpoint.
- Save the file to a known local folder, such as the workstation's approved downloads or software staging folder.
- Confirm that the download completed and that the file is not marked as incomplete, quarantined, or blocked by endpoint security.
If the download control is missing, verify that the correct legacy Web Client address was used and that the installed vSphere release supports this workflow. Do not obtain a replacement installer from an untrusted source.
Step 3: Run the Installation Wizard
- Open the downloaded VMware Client Integration Plug-in installer.
- Proceed past the introductory or welcome screen.
- Read and accept the EULA, or End-User License Agreement, to continue.
- Select an installation destination, or retain the default location when it is appropriate for the workstation.
- Start the installation and wait while the wizard copies and registers the required components.
- Complete the wizard from its final confirmation screen.
The installer may require local administrator approval, and it may ask you to close browsers or related console applications. Close those applications and repeat the installation if necessary. Do not interrupt the process while files are being copied or registered.
Step 4: Verify Console Access
- Close and reopen the supported browser if the installer requested a restart or if the Web Client was open during installation.
- Return to the vSphere Web Client and sign in with an authorized account.
- Locate and select the target virtual machine.
- Use the Web Client's console action to launch the virtual machine console.
- Approve a browser security prompt, pop-up, external-protocol request, or external application launch prompt when it is expected and permitted by policy.
- Confirm that the console handler opens and that the guest display updates.
- Test keyboard input, mouse interaction, and basic display interaction without making unintended changes to the guest.
A successful installation is demonstrated by a working console session, not merely by the installer reporting completion.
Practical Example: First-Time Console Access
An administrator uses a supported Windows management workstation to access the organization's legacy vSphere Web Client. The administrator opens the HTTPS address on port 9443, selects the Client Integration Plug-in download option, and saves the installer locally. They run the wizard, accept the EULA, retain the default installation path, and complete setup. After restarting the browser, they sign in, select an authorized virtual machine, and launch its console. The console opens, and keyboard and mouse input work as expected.
Certificate and Security Considerations
HTTPS encrypts communication with the Web Client, but encryption does not by itself prove that the endpoint is trustworthy. Before downloading software, compare the host name in the address with the certificate subject or subject alternative name where possible. Confirm the certificate chain according to organizational policy.
If the certificate is issued by an internal certificate authority or is self-signed, use the organization's approved trust process. Do not dismiss an unexpected certificate warning blindly. An unexpected identity, issuer, or certificate change should be escalated as a potential security issue.
Console access provides direct interaction with a guest operating system. Limit the permission to authorized administrators and technicians, protect the credentials used to sign in, and avoid sharing console sessions unnecessarily. Software deployment tools can be used for consistent installation across administrator workstations when the relevant vSphere release and organizational policies support that approach.
Legacy Plug-in Versus Modern Console Access
| Characteristic | Legacy vSphere Web Client with Plug-in | Modern vSphere Client Approach |
|---|---|---|
| Client-side installation requirement | Requires a workstation-installed VMware Client Integration Plug-in for supported functions such as console launch. | May use browser-based or separately integrated console methods and may not require this plug-in. |
| Browser dependency | Requires a browser and operating system combination supported by the specific legacy vSphere release. | Uses compatibility requirements defined by the modern vSphere release and its console implementation. |
| Console launch behavior | The Web Client may invoke a local console handler or external application through browser prompts. | The console workflow can differ and may be more directly integrated into the HTML5 client. |
| Version compatibility considerations | Installer behavior, supported browsers, and detection depend on the legacy release. | Follow the documentation and support matrix for the installed modern release instead of applying legacy plug-in instructions. |
Common Problems and Resolutions
| Symptom | Likely Cause | Checks | Resolution |
|---|---|---|---|
| Download link is missing or unavailable | Wrong client interface, unsupported release, incomplete page load, or unavailable Web Client service. | Confirm the URL, port 9443, vSphere version, browser compatibility, and service availability. | Use the correct legacy Web Client endpoint and ask the vSphere administrator to verify server-side access. |
| Installer cannot run | Browser download protection, endpoint security, unsupported operating system, or insufficient privileges. | Verify the file source, file completion, platform support, execution policy, and local permissions. | Copy the installer to a writable local folder, obtain approved elevation, or follow organizational software deployment procedures. |
| Installation fails | Insufficient disk space, locked files, incompatible previous installation, or unsupported workstation. | Read the installer message, check disk space and local event records, and close browsers or related applications. | Repair or remove an incompatible prior installation only through the supported procedure for that release, then retry. |
| Browser does not recognize the component | Browser was not restarted, browser or operating system is unsupported, or registration was blocked. | Restart the browser, confirm the release support matrix, and check endpoint security or policy logs. | Use a supported browser and workstation, reinstall if necessary, and test from another supported workstation. |
| Console launch is blocked | Pop-up, external protocol, or application launch prompt was denied or suppressed. | Inspect browser prompts, pop-up settings, and security policy notifications. | Allow the expected launch action according to policy, then sign in again and retry. |
| Console opens but cannot connect | Network reachability, permissions, virtual machine state, or version incompatibility problem. | Verify Web Client connectivity, virtual machine access rights, target availability, and client compatibility. | Test another authorized virtual machine or workstation and involve the vSphere administrator if server-side access is unavailable. |
Structured Troubleshooting
The Web Client Page Does Not Load
- Verify the Web Client host name or IP address.
- Confirm that HTTPS and the legacy port 9443 are being used where applicable.
- Test DNS resolution and network connectivity from the workstation.
- Check whether firewalls, proxies, or filtering devices permit the connection.
- Ask the platform administrator to verify Web Client service availability.
The Installer Download Is Blocked or Cannot Be Opened
- Check browser download protections and endpoint security policy.
- Confirm that the file came from the expected vSphere Web Client server.
- Verify that the user can execute installers and has the required local privileges.
- Copy the installer to a local writable folder before launching it.
The Installer Stops or Fails
- Confirm that the workstation operating system is supported by the installed vSphere release.
- Check available disk space and local installation permissions.
- Close browsers or applications that may hold related files open.
- Review installer messages and local system event records when available.
- Repair or remove an incompatible previous installation only according to the supported procedure for that release.
The Plug-in Installs but the Console Action Does Nothing
- Restart the browser after installation.
- Check for blocked pop-ups, external protocol requests, or application launch prompts.
- Confirm browser compatibility with the legacy plug-in.
- Verify that the selected virtual machine is reachable and that the account has console permissions.
- Try another supported administrator workstation to determine whether the problem is local to the first workstation.
A Certificate Warning Appears
- Compare the URL host name with the certificate subject or subject alternative name.
- Determine whether the organization uses an internal certificate authority or a self-signed certificate.
- Import or trust the certificate only through approved organizational procedures.
- Escalate unexpected certificate changes as a potential security issue.
Exam-Relevant Notes
- The Client Integration Plug-in is a client-side workstation component, not an ESXi or virtual machine installation.
- Its key legacy use is enabling virtual machine console access from the vSphere Web Client.
- TCP port 9443 is commonly associated with the legacy vSphere Web Client URL in this workflow.
- Installation does not grant vSphere permissions; role-based access still controls whether a user can open a console.
- Browser, operating system, and installer compatibility are tied to the vSphere release.
- Modern vSphere Client interfaces may use different console mechanisms and may not require the legacy plug-in.
Summary
Install the VMware Client Integration Plug-in on the administrator workstation by opening the supported legacy vSphere Web Client endpoint, downloading the installer from that endpoint, completing the wizard, and restarting the browser when required. Validate the result by launching an authorized virtual machine console and testing display, keyboard, and mouse interaction. Treat certificate warnings, external launch prompts, permissions, and version compatibility as part of the installation and verification process.
For related background, see VMware Client Integration Plug-in installation.