https://github.com/vmware-archive/vsphere-automation-sdk-ruby
DEPRECATED Ruby samples, language bindings, and API reference documentation for vSphere using the VMware REST API
https://github.com/vmware-archive/vsphere-automation-sdk-ruby
api-client bindings documentation restful-api ruby samples vmware-vsphere
Last synced: 7 months ago
JSON representation
DEPRECATED Ruby samples, language bindings, and API reference documentation for vSphere using the VMware REST API
- Host: GitHub
- URL: https://github.com/vmware-archive/vsphere-automation-sdk-ruby
- Owner: vmware-archive
- License: mit
- Archived: true
- Created: 2016-05-14T05:05:09.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-03-30T07:47:23.000Z (about 4 years ago)
- Last Synced: 2025-10-02T01:50:55.698Z (7 months ago)
- Topics: api-client, bindings, documentation, restful-api, ruby, samples, vmware-vsphere
- Language: Ruby
- Homepage:
- Size: 11.9 MB
- Stars: 31
- Watchers: 19
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# DEPRECATED VMware vSphere Automation SDK for Ruby
VMware has announced deprecation of vSphere Automation SDK for Ruby, effective March 29th, 2022. We highly recommend all our customers and partners to migrate from these SDKs to either [vSphere Automation SDK for Python](https://github.com/vmware/vsphere-automation-sdk-python) or [vSphere Automation SDK for Java](https://github.com/vmware/vsphere-automation-sdk-java/). Refer to https://ikb.vmware.com/s/article/87632 for more details.
## Installation
The vSphere Automation SDK for Ruby can be installed from [RubyGems](https://rubygems.org). It is available as a single gem containing all parts of the SDK or as individual components.
To use the entire SDK from a single gem, use:
```ruby
gem 'vsphere-automation-sdk', '~> 0.4.7'
```
The components are modular so you can choose to only install the components you need, for example:
```ruby
gem 'vsphere-automation-cis', '~> 0.4.7'
gem 'vsphere-automation-vcenter', '~> 0.4.7'
```
## Migration
_**Note: This only applies if you used a previous version of the gem that you had to manually build and install from source.**_
If you used a prior iteration of this SDK (_with a version 6.x.y_), you had to build and install the gem from source. If you don't pin to a particular version in your Gemfile (_which is highly recommended_), Bundler will resolve to the latest version of the gem. To get around this, either pin to a particular version or remove the prior version of the gem.
This version is _not_ backwards compatible with the previous versions (_version 6.x.y_).
## Documentation
The documentation for the vSphere Automation SDK for Ruby API can be viewed [here](https://vmware.github.io/vsphere-automation-sdk-ruby). The documentation for the REST APIs used by this SDK can be viewed [here](https://vmware.github.io/vsphere-automation-sdk-rest/vsphere). To try the APIs interactively, you can use the API Explorer. You can view it by going to `https:///apiexplorer`.
## Examples
You can view samples of how to use this SDK within the [sample folder](samples/). If you would like to see a sample, feel free to [create an issue](https://github.com/vmware/vsphere-automation-sdk-ruby/issues) describing what you would like to see. If you would like to modify, extend, or contribute a sample, see the [contributing guidelines](CONTRIBUTING.md).
## Versioning
This project uses [semantic versioning](https://semver.org/). You can safely express a dependency on a major version and expect all minor and patch versions to be backwards compatible.
## Contributing
To contribute to the vSphere Automation SDK for Ruby, see the [contributing guidelines](CONTRIBUTING.md).
## Available Components
The available components include
| Component | Gem Name | Module |
| ----------------------- | ------------------------------ | ------------------------------ |
| [Appliance](appliance/) | `vsphere-automation-appliance` | `VSphereAutomation::Appliance` |
| [CIS](cis/) | `vsphere-automation-cis` | `VSphereAutomation::CIS` |
| [Content](content/) | `vsphere-automation-content` | `VSphereAutomation::Content` |
| [VAPI](vapi/) | `vsphere-automation-vapi` | `VSphereAutomation::VAPI` |
| [vCenter](vcenter/) | `vsphere-automation-vcenter` | `VSphereAutomation::VCenter` |