govmomi

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

Compatibility

vSphere 7.0 and higher.

Documentation

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

The code in the govmomi 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. See godoc.org for documentation.

Installation

Binaries and Docker Images for govc and vcsim

Installation instructions, released binaries, and Docker images are documented in the respective README files of govc and vcsim.

Discussion

Collaborate with the community using GitHub discussions and GitHub issues.

Status

Changes to the API are subject to semantic versioning.

Refer to the CHANGELOG for version to version changes.

Related Projects

• pyvmomi
• rbvmomi

License

govmomi is available under the Apache 2 License.

Name

Pronounced: go·​v·​mom·​e

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