vSphere Automation SDK for Ruby
-------------------------

VMware vSphere Automation SDK for Ruby

DISTRIBUTION CONTENTS
---------------------

The VMware-vSphere-Automation-SDK-Ruby-6.5.0--<buildno>.zip file contains the
following contents:

+<SDK location>
  +README.txt
  +client
    +sdk
    +samples
  +docs
    +apidocs

Supported Platforms
-------------------

Any platform that supports Ruby:
  Linux, Windows and Mac OS X

PREREQUISITES
-------------

Ruby:
  Linux: ruby 1.9.2+, ruby 2.1.2+
  Windows: ruby 1.9.2+, ruby 2.0.0+
  Mac OS X: ruby 2.0.0+

Gems:
  savon 2.3.0+

You can install the above prerequisites in the following way:

  gem install savon

INSTALLATION
------------

1. Please pick up one of the supported linux/windows/mac platforms from the
supported platform list.

2. Unzip the VMware-vSphere-Automation-SDK-Ruby-6.5.0-<buildno>.zip bundle in to
your preferred location in the file system.
  For example:
    cd
    unzip VMware-vSphere-Automation-SDK-Ruby-6.5.0-<buildno>.zip

SAMPLES
-------

The samples directory in this distribution has sample scripts, showing how
to call the VMware-vSphere-Automation-SDK-Ruby API.

  cd <SDK location>/client/samples/
  bin/run_sample

Select one of the samples and use the --help option to see its usage.

  bin/run_sample connection --help
  bin/run_sample tagging --help


SUPPORT AND DOCUMENTATION
-------------------------

 After installing, you can find HTML based API documentation in the
 following locations:

  <SDK location>/docs/apidocs/client/vapi-runtime/
  <SDK location>/docs/apidocs/client/vsphereautomation-bindings/

COPYRIGHT AND LICENSE
---------------------

Copyright (c) 2014-2016 VMware, Inc.

Please refer to the SDK-EULA.txt file for the end user license agreement.

-The End-
