This site will be decommissioned on December 31st 2024. After that date content will be available at techdocs.broadcom.com.

vSphere ESX Agent Manager SDK 7.0 Update 3 | 5 OCT 2021

About the vSphere Solutions Manager, vServices, and ESX Agent Manager SDK

With vSphere Solutions, vServices, and ESX Agents you can extend the functionality of vCenter Server.

  • A vSphere Solution is an object or program that you create by extending specific classes in the vSphere Web Services API. After you register your solution with the instance of the vSphere Web Services API's ExtensionManager managed object associated with your vCenter Server, you see your new solution in the vCenter Server Extensions of your vSphere Web Client.
    • You can create a vService solution to provide access for a specific application to connect to a service across the network.
    • You can create an ESX Agent to extend the functions of an ESXi host and provide additional services that a vSphere solution requires.
  • The vServices Manager and ESX Agent Manager are pre-built solutions that are part of the vCenter Server Extensions functionality within the vCenter Server.
  • The VMware ESX Agent Manager includes an API library that allows you to adapt and modify the ESX Agent Manager (EAM) Sample Solution and view it using the vSphere Web Client.

For more details about each of these extensibility options, see Developing and Deploying vSphere Solutions, vServices, and ESXi Agents for vSphere 7.0.

Requirements

These release notes apply to the vSphere 7.0 Update 3 release. You should install the following software to use the 7.0 U3 version of the vSphere Solutions Manager, vServices, and ESX Agent Manager SDK.

To use the vSphere Solutions Manager, vServices, and ESX Agent Manager SDKs, download and/or install:

  • ESXi 7.0 Update 3 | 5 OCT 2021
  • vCenter Server 7.0 Update 3 | 5 OCT 2021
  • com.vmware.eam.apiref.doc.jar | API Reference
  • vsphere-vcenter-70-solutions-vservices-esxi-agent-manager-developer-guide.pdf | Programming Guide

What's New

This release of the vSphere Solutions Manager, vServices, and ESX Agent Manager SDKs introduces the following changes:

  • vSphere ESX Agent Manager is integrated with the vSphere Lifecycle Manager feature introduced with vSphere 7.0.

    If you use the vSphere Lifecycle Manager to remediate an ESXi cluster with a desired state specification, the vSphere ESX Agent Manager takes care of configuring the components that are part of the solutions deployed on the ESXi hosts in that cluster. When the desired state is applied on the cluster, the vSphere Lifecycle Manager installs the solution components configured by the ESX Agent Manager. 

The EAM Sample Solution is compatible with Apache Tomcat ® 8.5.5 and later and Pivotal® tc Server 3.0 and later.

Resolved Issues

Resolved in vSphere 7.0 Update 2
  • The ESX Agent manager fails to install and uninstall ESX agents and agencies on clusters which life cycle is managed with the vSphere Lifecycle Manager.

    Create a vSphere ESX agency with several ESX Agent virtual machines configured on a cluster which is not managed with the vSphere Lifecycle Manager. On an attempt to turn this cluster into a cluster managed with the vSphere Lifecycle Manager feature, the vSphere ESX agencies status becomes red. The ESX Agent virtual machines fail to deploy. If you attempt to uninstall such ESX agencies, the operation fails too.

    Manually delete the vSphere ESX agency and redeploy it on a cluster that is not managed with the vSphere Lifecycle Manager.

  • The EAM Sample Solution fails to deploy the ESX agent virtual machines on a cluster managed with the vSphere Lifecycle Manager.

    When you install the EAM Sample Solution on a cluster that is managed with the vSphere Lifecycle Manager, the ESX agency configured with ESX agent virtual machines fails to deploy. An attempt to uninstall this ESX agency fails too.

    Delete the ESX agency manually through the vSphere Client by following these steps:

    1.  Log in to the vCenter Server with the vSphere Client.
    2.  Navigate to the ESX Agent Manager UI.
      1. From the Home menu, select Administration.
      2. Expand Solutions and select vCenter Server Extensions.
      3. Click vSphere ESX Agent Manager from the list of vCenter Server extensions.
    3. In the vSphere ESX Agent Manager UI, click the Configure tab.
    4. Select the affected ESX agency.
    5. Click the vertical ellipses icon and select Delete agency.
check-circle-line exclamation-circle-line close-line
Scroll to top icon