Project

vsphere-automation-runtime

0.03
Repository is archived
No release in over 3 years
Low commit activity in last 3 years
vsphere-automation-runtimevmware/vsphere-automation-sdk-rubyHomepageDocumentationSource CodeBug TrackerWiki
A Ruby SDK for the vSphere APIs (Runtime)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
319,161
Stars
31
Forks
12
Watchers
20
 Releases
Current version
0.4.7
Total releases
13
First release
2019-08-05
Latest release
2020-07-14
 Issues
Open Issues
4
Closed Issues
39
Total Issues
43
Issue Closure Rate
90%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
6
Merged Pull Requests
23
Pull Request Acceptance Rate
76%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-11-07
Reverse Dependencies
2

 Dependencies

Development

bundler
~> 2.0
pry
~> 0.12.2
rake
~> 12.3
rspec
~> 3.7
rubocop
~> 0.73.0
vcr
~> 5.0
webmock
~> 3.6
 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 or vSphere Automation SDK for 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. 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:

gem 'vsphere-automation-sdk', '~> 0.4.7'

The components are modular so you can choose to only install the components you need, for example:

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. The documentation for the REST APIs used by this SDK can be viewed here. To try the APIs interactively, you can use the API Explorer. You can view it by going to https://<your vCenter>/apiexplorer.

Examples

You can view samples of how to use this SDK within the sample folder. If you would like to see a sample, feel free to create an issue describing what you would like to see. If you would like to modify, extend, or contribute a sample, see the contributing guidelines.

Versioning

This project uses semantic versioning. 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.

Available Components

The available components include

Component Gem Name Module
Appliance vsphere-automation-appliance VSphereAutomation::Appliance
CIS vsphere-automation-cis VSphereAutomation::CIS
Content vsphere-automation-content VSphereAutomation::Content
VAPI vsphere-automation-vapi VSphereAutomation::VAPI
vCenter vsphere-automation-vcenter VSphereAutomation::VCenter