← Back to branch summary

~nskaggs/+junk/xenial-test

« back to all changes in this revision

Viewing changes to src/github.com/juju/govmomi/README.md

  • Committer: Nicholas Skaggs
  • Date: 2016-10-24 20:56:05 UTC
  • Revision ID: nicholas.skaggs@canonical.com-20161024205605-z8lta0uvuhtxwzwl
Initi with beta15

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/github.com/juju/govmomi/README.md
 
1
[![Build Status](https://travis-ci.org/vmware/govmomi.png?branch=master)](https://travis-ci.org/vmware/govmomi)
 
2
 
 
3
# govmomi
 
4
 
 
5
A Go library for interacting with VMware vSphere APIs (ESXi and/or vCenter).
 
6
 
 
7
For `govc`, a CLI built on top of govmomi, check out the [govc](./govc) directory.
 
8
 
 
9
## Compatibility
 
10
 
 
11
This library is built for and tested against ESXi and vCenter 5.5.
 
12
 
 
13
If you're able to use it against older versions of ESXi and/or vCenter, please
 
14
leave a note and we'll include it in this compatibility list.
 
15
 
 
16
## Documentation
 
17
 
 
18
The APIs exposed by this library very closely follow the API described in the [VMware vSphere API Reference Documentation][apiref].
 
19
Refer to this document to become familiar with the upstream API.
 
20
 
 
21
The code in the `govmomi` package is a wrapper for the code that is generated from the vSphere API description.
 
22
It primarily provides convenience functions for working with the vSphere API.
 
23
See [godoc.org][godoc] for documentation.
 
24
 
 
25
[apiref]:http://pubs.vmware.com/vsphere-55/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html
 
26
[godoc]:http://godoc.org/github.com/vmware/govmomi
 
27
 
 
28
## Status
 
29
 
 
30
Changes to the API are subject to [semantic versioning](http://semver.org).
 
31
 
 
32
Refer to the [CHANGELOG](CHANGELOG.md) for version to version changes.
 
33
 
 
34
## License
 
35
 
 
36
govmomi is available under the [Apache 2 license](LICENSE).