Repository files navigation

A Go library for interacting with VMware vSphere APIs (ESXi and/or vCenter Server).

In addition to the vSphere API client, this repository includes:

• govc - vSphere CLI
• vcsim - vSphere API mock framework
• toolbox - VM guest tools framework

This library supports vCenter Server and ESXi versions following theVMware Product Lifecycle Matrix.

Product versions that are end of support may work, but are not officially supported.

The APIs exposed by this library closely follow the API described in theVMware vSphere API Reference Documentation. Refer to the documentation to become familiar with the upstream API.

The code in thegovmomi package is a wrapper for the code that is generated from the vSphere API description. It primarily provides convenience functions for working with the vSphere API. Seegodoc.org for documentation.

Installation instructions, released binaries, and Docker images are documented in the respective README files ofgovc andvcsim.

The project encourages the community to collaborate using GitHubissues, GitHubdiscussions, andSlack.

NoteAccess to Slack requires a freeVMware {code} developer program membership.

Changes to the API are subject tosemantic versioning.

Refer to theCHANGELOG for version to version changes.

• collectd-vsphere
• Docker LinuxKit
• Elastic Agent VMware vSphere integration
• Gru
• Juju
• Jupiter Brain
• Kubernetes vSphere Cloud Provider
• Kubernetes Cluster API
• OPS
• OpenTelemetry Collector Contrib
• Packer Plugin for VMware vSphere
• Rancher
• Terraform Provider for VMware vSphere
• Telegraf
• VMware Event Broker Appliance
• VMware vSphere Integrated Containers Engine
• VMware vSphere 7.0

• go-vmware-nsxt
• pyvmomi
• rbvmomi

govmomi is available under theApache 2 License.

Pronounced:go·​v·​mom·​ie

Follows pyvmomi and rbvmomi: language prefix + the vSphere acronym "VM Object Management Infrastructure".