The vSphere Web Services SDK Programming Guide provides information about developing applications using the VMware® vSphere Web Services SDK.

VMware provides different APIs and SDKs for various applications and goals. The vSphere Web Services SDK targets developers who create client applications for managing VMware® vSphere components available on ESXi hosts and vCenter Servers.

For more VMware API and SDK documentation, go to

Revision History

This book is revised with each release of the product or when necessary. The following table summarizes significant changes in each version of this book.

Table 1. Revision History

Revision Date


18 JUN 2024 vSphere 8.0 Update 3
  • Updates to Client Applications chapters, Web Services and JSON.
  • Rebranded website links from VMware to Broadcom.
  • Corrections to PropertyCollector chapter, especially concerning WaitForUpdatesEx (OCT 2023).
21 SEP 2023 vSphere 8.0 Update 2
  • Removed /etc/syslog.conf from /host HTTP access. This configuration has been moved to the ConfigStore.
  • Changed some section titles for search engine optimization.
  • Corrected reference to PropertyCollector as a singleton, which is not strictly correct.
  • Added clarifications regarding PropertyCollector updates.
18 APR 2023 vSphere 8.0 Update 1
05 DEC 2022 Minor cleanup.

06 OCT 2022

vSphere 8.0

  • Removed C# and .NET material after deprecation.

  • Removed more system configuration parameters that have been moved to ConfigStore. These settings can no longer be edited directly with a web browser.

  • Updates for accuracy including Security chapter. Alt text for graphics.

05 OCT 2021

vSphere 7.0 Update 3

  • Added raw cloud-init configuration to Guest Operations chapter.

  • Added PTP time service capability to Hosts chapter.

19 MAY 2021

  • Added information about configuring advanced host options.

  • Added information about configuring direct access to physical devices on the host.

  • A number of system configuration parameters moved to ConfigStore. These settings can no longer be edited directly with a web browser.

12 APR 2021

VMware has rebranded the My VMware portal as VMware Customer Connect. We have updated this document accordingly.

9 MAR 2021

vSphere 7.0 Update 2

  • Added a simpler use case in the Property Collector chapter. Also made minor corrections and clarifications.

  • Rerganized part of the Tasks chapter to break up the very long Listview example program into sections. Also made minor corrections and clarifications.

06 OCT 2020

vSphere 7.0 Update 1

  • In Inventory Traversal and Property Selection, add best practice to destroy PropertyCollector views after use.

  • In Task Monitoring Example Using the ListView Object, cross-reference information about chunking of results from PropertyCollector.

  • At VMware, we value inclusion. To foster this principle within our customer, partner, and internal community, we are replacing some of the terminology in our content. We have updated this guide to remove instances of non-inclusive language.


vSphere 7.0

Added scalable shares feature. Reworked and expanded fixed shares and other resource anagement material.

Added Virtual Machine Guest Operations chapter, including guest customization for instant clone virtual machines.


vSphere 6.7 Update 3

Bug fixes. Added section on crypto key query for VM encryption.


vSphere 6.7 Update 1

Added section on Hyperconverged Infrastructure (HCI) clusters.


vSphere 6.7 - GA

Added Instant Clone material to VM Management chapter.

Minor updates elsewhere.


Removed appendix with list of permissions. Was not maintained.


vSphere 6.5 - GA

Added chapter about vSphere virtual machine encryption.

Removed description of deprecated CIM Storage Management API.

Updated information about session cookie management.


Updated information about migrating VMs with vMotion across data centers.


vSphere 6.0 - Rewrote “Exporting a Virtual Application” section in Virtual Applications chapter.


vSphere 5.5 – Added a C# example of using LoginByToken; clarified limitation for HA clusters.


vSphere 5.1 – Added information about using the SessionManager.LoginByToken method; added information about distributed virtual switches.


vSphere 5.0 - Revised performance manager chapter. Added information about: unset properties, using vCenter to access host data, and using the QueryConfigOption to add devices; emphasized ListView instead of TaskManager; clarified limits and limitations of Linked Virtual Machines; updated samples in chapters 3,5,14, and 16; replaced information about Axis bindings with JAX-WS; and updated paths to samples supplied with SDK.


Restructured manual and added chapters about host, storage, and networking. Revised property collector chapter and added appendix about HTTP access.


vSphere Web Services SDK 4.0 Programming Guide.

Intended Audience

This book is intended for anyone who needs to develop applications using the vSphere Web Services SDK. Developers typically create client applications using Java and targeting VMware vSphere. An understanding of Web Services technology and some programming background is required.

Document Feedback

VMware welcomes your suggestions for improving our documentation. Please post your feedback into topics on the website.