VMware vCloud Suite Perl SDK README

Introduction
-----------------------------------------------------------------------------

The VMware vCloud Suite SDK for Perl enables programmatic access to vSphere. The SDK includes perl libraries for accessing new features like Content Library and existing features like Tagging which did not support public API prior to vSphere 6.0.

The SDK contains samples for the features mentioned above as well as samples to demonstrate how to interoperate with vSphere APIs.

This README contains the following topics:

    * Intended Audience
    * Prerequisites
    * Supported Platforms
    * Supported Perl Versions
    * What's in the SDK Package?
    * Installation Instructions
    * How to run the samples?
    * Support and Documentation

Intended Audience
-----------------------------------------------------------------------------

The VMware vCloud Suite SDK for Perl is intended for the following audiences:

    * Developers who want to write new applications for vSphere 6.0.
    * Developers migrating an existing vSphere application to use new features.

Prerequisites
-----------------------------------------------------------------------------

VMware vCloud Suite SDK for Perl 6.0 requires vSphere SDK for Perl 6.0 to be installed first in the targeted client platform. The vSphere SDK for Perl 6.0 interactive installer will install all the required dependencies modules for vCloud Suite SDK for Perl 6.0 as well.

For more info, please refer to https://www.vmware.com/support/developer/viperltoolkit/


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

   Red Hat Enterprise Linux (RHEL) 6.3 (Server) 32 bit and 64 bit
   Red Hat Enterprise Linux (RHEL) 5.5 (Server) 32 bit and 64 bit
   Ubuntu 10.04.1 (LTS)  32 bit and 64 bit
   SLES 11  32 bit and 64 bit
   SLES 11 SP2  32 bit and 64 bit
   Windows 7  32 bit and 64 bit
   Windows 8  32 bit and 64 bit
   Windows 2008  64 bit

Supported Perl Versions
-----------------------------------------------------------------------------

   Linux: Perl 5.10+
   Windows: ActivePerl 5.14+

What's in the SDK Package?
-----------------------------------------------------------------------------

The VMware-vCloud-Suite-SDK-Perl-6.0.0--<buildno>.zip file contains the
following:

+VMware-vCloud-Suite-SDK-Perl-6.0.0
   +client
      +lib
         +runtime
         +sdk
      +samples
   +docs
   +README

Installation Instructions
-----------------------------------------------------------------------------

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

2. Unzip the VMware-vCloud-Suite-SDK-Perl-6.0.0-<buildno>.zip bundle to
your preferred location in the file system.
   For example:
    unzip VMware-vCloud-Suite-SDK-Perl-6.0.0-<buildno>.zip

3. Set PERL5LIB env variable or perl include path
   export PERL5LIB=$PERL5LIB:<SDK-root-directory>/VMware-vCloud-Suite-SDK-Perl-6.0.0/client/lib/sdk:<SDK-root-directory>/VMware-vCloud-Suite-SDK-Perl-6.0.0/client/lib/runtime

How to run the samples?
-----------------------------------------------------------------------------

The samples directory in this distribution has sample scripts, showing how
to call the VMware-vCloud-Suite-SDK-Perl API.

   #cd <SDK-root-directory>/VMware-vCloud-Suite-SDK-Perl-6.0.0/client/samples/

   #perl tag_life_cycle.pl --lsurl https://<ip>/lookupservice/sdk --server https://<server_ip> --username <user name> --password <password>

   #perl tagging_workflow.pl --lsurl https://<ip>/lookupservice/sdk --server https://<server_ip> --username <user name> --password <password>


Support and Documentation
-----------------------------------------------------------------------------

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

 <SDK-root-directory>/VMware-vCloud-Suite-SDK-Perl-6.0.0/docs/VMware-vCloud-Suite-SDK-Perl-Api-Reference-Guide.html

Copyright and Licence
-----------------------------------------------------------------------------

Copyright (c) 2014-2015 VMware, Inc.

-The End-