README.md

govmomi

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

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

• govc - vSphere CLI

• vcsim - vSphere API mock framework

• toolbox - VM guest tools framework

Compatibility

This library is built for and tested against ESXi and vCenter 6.5, 6.7 and 7.0.

It may work with versions 5.1, 5.5 and 6.0, but neither are officially supported.

Documentation

The APIs exposed by this library very closely follow the API described in the VMware vSphere API Reference Documentation. Refer to this document 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

govmomi (Package)

$ go get -u github.com/vmware/govmomi

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

Contributors and users are encouraged to collaborate using GitHub issues and/or Slack. Access to Slack requires a VMware {code} membership.

Status

Changes to the API are subject to semantic versioning.

Refer to the CHANGELOG for version to version changes.

Projects using govmomi

• collectd-vsphere

• Docker Machine

• Docker InfraKit

• Docker LinuxKit

• Gru

• Juju

• Kubernetes vSphere Cloud Provider

• Kubernetes Cluster API

• Kubernetes kops

• Libretto

• Open Storage

• OPS

• Packer

• Rancher

• Terraform

• Travis CI

• Telegraf

• VMware Event Broker Appliance

• VMware VIC Engine

• vSphere 7.0

Related projects

• rbvmomi

• pyvmomi

• go-vmware-nsxt

License

govmomi is available under the Apache 2 license.

Name

Pronounced "go-v-mom-ie"

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