- Quick Start Guide
- API Documentation
- Submitting samples
- Resource Maintenance
- Repository Administrator Resources
- VMware Resources
This document for the vSphere Automation SDK for perl describes -
- How to run the samples in this repository
- The procedure for contributing new samples.
vCenter 6.0 and 6.5. Certain APIs and samples that are introduced in 6.5 release, such as vCenter, Virtual Machine and Appliance Management. Please refer to the notes in each sample for detailed compatibility information.
The VMware vSphere Automation SDKs provide support for your client application infrastructure with services to perform management operations in your vSphere environment. The vSphere Automation SDK for Perl also contains samples that demonstrate how the libraries work with other vSphere APIs.
The version 6.5 SDK enables programmatic access to the following services:
* Service discovery using Lookup Service
* Authentication (Single Sign-On)
* Session management
* Tagging
* Content Library
* Virtual Machines
In case of windows platform-
- Download the latest ActiveState Perl 64-bits (https://www.activestate.com/activeperl/downloads) or Strawberry Perl (http://strawberryperl.com/).
- Need to install few required CPAN modules using below commands:
ppm install XML::LibXML
ppm install UUID::Random
ppm install Crypt::OpenSSL:RSA
ppm install Exception::Class
ppm install Crypt::X509- Download and install the vSphere SDK for Perl 6.5 (VMware-vSphere-Perl-SDK-6.X.X-XXXXX.XXXX.x86_64.exe) from (https://code.vmware.com/web/sdk/65/vsphere-perl).
- Need to copy python27.dll from vSphere_SDK_install_directory/bin to vSphere_SDK_install_directory/Perl/lib/VMware.
In case of RHEL platform-
- Need to install few required CPAN modules using below commands:
yum install e2fsprogs-devel libuuid-devel openssl-devel perl-devel
yum install glibc.i686 zlib.i686
yum install perl-XML-LibXML libncurses.so.5 perl-Crypt-SSLeay perl-Time-Piece- $rm -rf /usr/lib64/perl5/auto/Crypt/OpenSSL/RSA/RSA.so
- perl -MCPAN -e 'install Crypt::OpenSSL::RSA'
- Download the vSphere SDK for Perl 6.5 (VMware-vSphere-Perl-SDK-6.X.X-XXXXX.XXXX.x86_64.tar.gz) from (https://code.vmware.com/web/sdk/65/vsphere-perl) and follow below mentioned steps to install.
Untar the vSphere SDK for Perl 6.5 binary that you downloaded.
$tar –zxvf VMware-vSphere-Perl-SDK-6.X.X-XXXXX.XXXX.x86_64.tar.gz
A vmware-vsphere-vcli-distrib directory is created.
Log in as superuser and run the installer.
$cd vmware-vsphere-cli-distrib
$./vmware-install.pl
To accept the license terms, enter yes and press Enter.
To install Perl modules locally, enter yes and press Enter.
Specify an installation directory, or press Enter to accept the default, which is /usr/bin.In case of SLES platform-
- Need to install few required CPAN modules using below commands:
yast -i openssl-devel libuuid-devel libuuid-devel-32bit e2fsprogs-devel- Need to download modules LWP::Protocol::https-6.06 and Net::Https 6.06 from CPAN site (http://search.cpan.org/) and follow below mentioned steps:
$tar -zxvf downloaded_module.tar.gz
$cd extracted_folder_name
$./ Makefile.pl
$make
$make install- Download the vSphere SDK for Perl 6.5 (VMware-vSphere-Perl-SDK-6.X.X-XXXXX.XXXX.x86_64.tar.gz) from (https://code.vmware.com/web/sdk/65/vsphere-perl) and follow below mentioned steps to install.
Untar the vSphere SDK for Perl 6.5 binary that you downloaded.
$tar –zxvf VMware-vSphere-Perl-SDK-6.X.X-XXXXX.XXXX.x86_64.tar.gz
A vmware-vsphere-vcli-distrib directory is created.
Log in as superuser and run the installer.
$cd vmware-vsphere-cli-distrib
$./vmware-install.pl
To accept the license terms, enter yes and press Enter.
To install Perl modules from CPAN, enter yes and press Enter.
Specify an installation directory, or press Enter to accept the default, which is /usr/bin.In case of Ubuntu platform-
- Need to install few required CPAN modules using below commands:
For Ubuntu-15.10 64 bits-
$sudo apt-get install lib32z1 lib32ncurses5 uuid uuid-dev perl libssl-dev perldoc libxml-libxml-perl libcrypt-ssleay-perl libsoap-lite-perl
For Ubuntu-16.04 64 bits-
$sudo apt-get install lib32z1 lib32ncurses5 uuid uuid-dev libssl-dev perl-doc libxml-libxml-perl libcrypt-ssleay-perl libsoap-lite-perl libmodule-build-perl- Download the vSphere SDK for Perl 6.5 (VMware-vSphere-Perl-SDK-6.X.X-XXXXX.XXXX.x86_64.tar.gz) from (https://code.vmware.com/web/sdk/65/vsphere-perl) and follow below mentioned steps to install.
Untar the vSphere SDK for Perl 6.5 binary that you downloaded.
$tar –zxvf VMware-vSphere-Perl-SDK-6.X.X-XXXXX.XXXX.x86_64.tar.gz
A vmware-vsphere-vcli-distrib directory is created.
Log in as superuser and run the installer.
$cd vmware-vsphere-cli-distrib
$./vmware-install.pl
To accept the license terms, enter yes and press Enter.
To install Perl modules from CPAN, enter yes and press Enter.
Specify an installation directory, or press Enter to accept the default, which is /usr/bin.For more info, please refer to https://www.vmware.com/support/developer/viperltoolkit/
* Red Hat Enterprise Linux (RHEL) 7 (Server) 64 bit
* Red Hat Enterprise Linux (RHEL) 6.6 (Server) 64 bit
* SLES 12 64 bit
* SLES 11 SP3 64 bit
* Ubuntu 16.04 (LTS) 64bit
* Ubuntu 15.10 (LTS) 64bit
* Windows 10 64 bit
* Linux: Perl 5.10+
* Windows: ActivePerl 5.14+
Strawberry Perl 5.24.1.1+
The vsphere-automation-sdk-perl-master.zip file contains the following:
+vsphere-automation-sdk-perl-master
+bin
+doc
+lib
+runtime
+sdk
+README.md
+samples
+README.md
+LICENSE
-
Please pick up one of the supported linux/windows platform from the Supported Platforms list.
-
Follow Prerequisites section to install all required module.
-
Load the GitHub repository page: https://github.com/vmware/vsphere-automation-sdk-perl-samples to download the repository
-
Click on the green “Clone or Download” button and then click “Download ZIP”
-
Once downloaded, extract the zip file to the location of your choosing
-
At this point, you now have a local copy of the repository
-
Set PERL5LIB env variable or perl include path using these commands:
* On windows platform:
set PERL5LIB=%PERL5LIB%;SDK-root-directory-path\lib\runtime;SDK-root-directory-path\lib\sdk;SDK-root-directory-path\samples
* On other plateforms:
export PERL5LIB=$PERL5LIB:SDK-root-directory-path/lib/sdk:SDK-root-directory-path/lib/runtime:SDK-root-directory-path/samplesThe samples directory in this distribution has sample scripts, showing how to call the VMware-vSphere-Automation-SDK-Perl API.
Use a command like the following to get list of VMs present in vCenter.
$ cd vsphere-automation-sdk-perl-master/samples/Vcenter/Vm
$ perl list_vms.pl --server https://vCenter_server_ip --username 'user name' --password 'password'
The API documentation can be found [here] (doc/client.zip)
Before you start working with this project, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
The following information must be included in the README.md or in the sample docstring in case README already exists in same folder.
- Author Name
- This can include full name, email address or other identifiable piece of information that would allow interested parties to contact author with questions.
- Date
- Date the sample was originally written
- Minimal/High Level Description
- What does the sample do ?
- Any KNOWN limitations or dependencies
The following information should be included when possible. Inclusion of information provides valuable information to consumers of the resource.
- vSphere version against which the sample was developed/tested
- SDK version against which the sample was developed/tested
- Perl version against which the sample was developed/tested
- Follow the GitHub process
- Please use one branch per sample or change-set
- Please use one commit and pull request per sample
- Please post the sample output along with the pull request
- If you include a license with your sample, use the project license
Ownership of any and all submitted samples are maintained by the submitter.
Any bugs or other issues should be filed within GitHub by way of the repository’s Issue Tracker.
Any community member can resolve issues within the repository, however only the board member can approve the update. Once approved, assuming the resolution involves a pull request, only a board member will be able to merge and close the request.
It is highly recommended to add any and all submitted samples to the VMware Sample Exchange: https://code.vmware.com/samples
Sample Exchange can be allowed to access your GitHub resources, by way of a linking process, where they can be indexed and searched by the community. There are VMware social media accounts which will advertise resources posted to the site and there's no additional accounts needed, as the VMware Sample Exchange uses MyVMware credentials.
Board members are volunteers from the SDK community and VMware staff members, board members are not held responsible for any issues which may occur from running of samples from this repository.
Members:
- Kapil Yadav (VMware)
- Steve Trefethen (VMware)
Items added to the repository, including items from the Board members, require 2 votes from the board members before being added to the repository. The approving members will have ideally downloaded and tested the item. When two “Approved for Merge” comments are added from board members, the pull can then be committed to the repository.