79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
|
[](https://travis-ci.org/vmware/govmomi)
|
||
|
|
[](https://goreportcard.com/report/github.com/vmware/govmomi)
|
||
|
|
|
||
|
|
# govmomi
|
||
|
|
|
||
|
|
A Go library for interacting with VMware vSphere APIs (ESXi and/or vCenter).
|
||
|
|
|
||
|
|
For `govc`, a CLI built on top of govmomi, check out the [govc](./govc) directory and [USAGE](./govc/USAGE.md) document.
|
||
|
|
|
||
|
|
## Compatibility
|
||
|
|
|
||
|
|
This library is built for and tested against ESXi and vCenter 5.5, 6.0 and 6.5.
|
||
|
|
|
||
|
|
If you're able to use it against older versions of ESXi and/or vCenter, please
|
||
|
|
leave a note and we'll include it in this compatibility list.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
The APIs exposed by this library very closely follow the API described in the [VMware vSphere API Reference Documentation][apiref].
|
||
|
|
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][godoc] for documentation.
|
||
|
|
|
||
|
|
[apiref]:http://pubs.vmware.com/vsphere-6-5/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html
|
||
|
|
[godoc]:http://godoc.org/github.com/vmware/govmomi
|
||
|
|
[drone]:https://drone.io
|
||
|
|
[dronesrc]:https://github.com/drone/drone
|
||
|
|
[dronecli]:http://readme.drone.io/devs/cli/
|
||
|
|
|
||
|
|
#### Building with CI
|
||
|
|
Merges to this repository will trigger builds in both Travis and [Drone][drone].
|
||
|
|
|
||
|
|
To build locally with Drone:
|
||
|
|
- Ensure that you have Docker 1.6 or higher installed.
|
||
|
|
- Install the [Drone command line tools][dronecli].
|
||
|
|
- Run `drone exec` from within the root directory of the govmomi repository.
|
||
|
|
|
||
|
|
## Discussion
|
||
|
|
|
||
|
|
Contributors and users are encouraged to collaborate using GitHub issues and/or
|
||
|
|
[Slack](https://vmwarecode.slack.com/messages/govmomi).
|
||
|
|
Access to Slack requires a [VMware {code} membership](https://code.vmware.com/join/).
|
||
|
|
|
||
|
|
## Status
|
||
|
|
|
||
|
|
Changes to the API are subject to [semantic versioning](http://semver.org).
|
||
|
|
|
||
|
|
Refer to the [CHANGELOG](CHANGELOG.md) for version to version changes.
|
||
|
|
|
||
|
|
## Projects using govmomi
|
||
|
|
|
||
|
|
* [Docker Machine](https://github.com/docker/machine/tree/master/drivers/vmwarevsphere)
|
||
|
|
|
||
|
|
* [Kubernetes](https://github.com/kubernetes/kubernetes/tree/master/pkg/cloudprovider/providers/vsphere)
|
||
|
|
|
||
|
|
* [Terraform](https://github.com/hashicorp/terraform/tree/master/builtin/providers/vsphere)
|
||
|
|
|
||
|
|
* [VMware VIC Engine](https://github.com/vmware/vic)
|
||
|
|
|
||
|
|
* [Travis CI](https://github.com/travis-ci/jupiter-brain)
|
||
|
|
|
||
|
|
* [collectd-vsphere](https://github.com/travis-ci/collectd-vsphere)
|
||
|
|
|
||
|
|
* [Gru](https://github.com/dnaeon/gru)
|
||
|
|
|
||
|
|
* [Libretto](https://github.com/apcera/libretto/tree/master/virtualmachine/vsphere)
|
||
|
|
|
||
|
|
## Related projects
|
||
|
|
|
||
|
|
* [rbvmomi](https://github.com/vmware/rbvmomi)
|
||
|
|
|
||
|
|
* [pyvmomi](https://github.com/vmware/pyvmomi)
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
govmomi is available under the [Apache 2 license](LICENSE).
|