github.com/vmware/govmomi@v0.51.0/README.md (about)

     1  <!-- markdownlint-disable first-line-h1 no-inline-html -->
     2  
     3  [![Build](https://github.com/vmware/govmomi/actions/workflows/govmomi-build.yaml/badge.svg)][ci-build]
     4  [![Tests](https://github.com/vmware/govmomi/actions/workflows/govmomi-go-tests.yaml/badge.svg)][ci-tests]
     5  [![Go Report Card](https://goreportcard.com/badge/github.com/vmware/govmomi)][go-report-card]
     6  [![Latest Release](https://img.shields.io/github/release/vmware/govmomi.svg?logo=github&style=flat-square)][latest-release]
     7  [![Go Reference](https://pkg.go.dev/badge/github.com/vmware/govmomi.svg)][go-reference]
     8  [![go.mod Go version](https://img.shields.io/github/go-mod/go-version/vmware/govmomi)][go-version]
     9  
    10  # govmomi
    11  
    12  A Go library for interacting with VMware vSphere APIs (ESXi and/or vCenter Server).
    13  
    14  In addition to the vSphere API client, this repository includes:
    15  
    16  * [govc][govc] - vSphere CLI
    17  * [vcsim][vcsim] - vSphere API mock framework
    18  * [toolbox][toolbox] - VM guest tools framework
    19  
    20  ## Compatibility
    21  
    22  vSphere 7.0 and higher.
    23  
    24  ## Documentation
    25  
    26  The APIs exposed by this library closely follow the API described in the [VMware vSphere API Reference Documentation][reference-api]. Refer to the documentation to become familiar with the upstream API.
    27  
    28  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][reference-godoc] for documentation.
    29  
    30  ## Installation
    31  
    32  ### Binaries and Docker Images for `govc` and `vcsim`
    33  
    34  Installation instructions, released binaries, and Docker images are documented in the respective README files of [`govc`][govc] and [`vcsim`][vcsim].
    35  
    36  ## Discussion
    37  
    38  Collaborate with the community using GitHub [discussions][govmomi-github-discussions] and GitHub [issues][govmomi-github-issues].
    39  
    40  ## Status
    41  
    42  Changes to the API are subject to [semantic versioning][reference-semver].
    43  
    44  Refer to the [CHANGELOG][govmomi-changelog] for version to version changes.
    45  
    46  ## Related Projects
    47  
    48  * [pyvmomi][reference-pyvmomi]
    49  * [rbvmomi][reference-rbvmomi]
    50  
    51  ## License
    52  
    53  govmomi is available under the [Apache 2 License][govmomi-license].
    54  
    55  ## Name
    56  
    57  Pronounced: _go·​v·​mom·​e_
    58  
    59  Follows pyvmomi and rbvmomi: language prefix + the vSphere acronym "VM Object Management Infrastructure".
    60  
    61  [//]: Links
    62  
    63  [ci-build]: https://github.com/vmware/govmomi/actions/workflows/govmomi-build.yaml
    64  [ci-tests]: https://github.com/vmware/govmomi/actions/workflows/govmomi-go-tests.yaml
    65  [latest-release]: https://github.com/vmware/govmomi/releases/latest
    66  [govc]: govc/README.md
    67  [govmomi-github-issues]: https://github.com/vmware/govmomi/issues
    68  [govmomi-github-discussions]: https://github.com/vmware/govmomi/discussions
    69  [govmomi-changelog]: CHANGELOG.md
    70  [govmomi-license]: LICENSE.txt
    71  [go-reference]: https://pkg.go.dev/github.com/vmware/govmomi
    72  [go-report-card]: https://goreportcard.com/report/github.com/vmware/govmomi
    73  [go-version]: https://github.com/vmware/govmomi
    74  [reference-api]: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/
    75  [reference-godoc]: https://pkg.go.dev/github.com/vmware/govmomi
    76  [reference-pyvmomi]: https://github.com/vmware/pyvmomi
    77  [reference-rbvmomi]: https://github.com/vmware/rbvmomi
    78  [reference-semver]: http://semver.org
    79  [toolbox]: toolbox/README.md
    80  [vcsim]: vcsim/README.md