vSphere SDK for Perl Programming Guide - Documentation - VMware
vSphere SDK for Perl Programming Guide - Documentation - VMware
vSphere SDK for Perl Programming Guide - Documentation - VMware
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
<strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> <strong>Programming</strong> <strong>Guide</strong><br />
Sample Scripts – Scripts that you can customize <strong>for</strong> your needs and that illustrate the <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong><br />
<strong>Perl</strong>’s functionality. You must know <strong>Perl</strong> to customize the scripts. Unlike the utility applications, sample<br />
scripts are not supported by <strong>VMware</strong>.<br />
A <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> installation also includes the following libraries:<br />
Web Services <strong>for</strong> Management <strong>Perl</strong> Library and Examples – The WS‐Management <strong>Perl</strong> Library allows<br />
you to write scripts that retrieve CIM data from the ESX/ESXi host using CIMOM, a service that provides<br />
standard CIM management functions over a WBEM (Web‐Based Enterprise Management). See “Web<br />
Services <strong>for</strong> Management <strong>Perl</strong> Library” on page 51.<br />
Credential Store Library and Examples – Allows <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> applications to manage the<br />
<strong>vSphere</strong> credential store. The credential store allows <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> scripts to authenticate<br />
themselves to ESX/ESXi or vCenter Server systems. See “Credential Store <strong>Perl</strong> Library” on page 61.<br />
Using <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong><br />
This section explains how to get started with <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> by looking at two typical usage scenarios.<br />
It also lists common <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> tasks and discusses programming conventions.<br />
Getting Started<br />
If you want to use the <strong>SDK</strong> to retrieve per<strong>for</strong>mance in<strong>for</strong>mation <strong>for</strong> a host, you might per<strong>for</strong>m the following<br />
tasks:<br />
1 Check the <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> Utility Applications Reference or the apps directory <strong>for</strong> a script that retrieves<br />
per<strong>for</strong>mance in<strong>for</strong>mation.<br />
Check /usr/lib/vmware-vcli/apps on Linux and Program Files\<strong>VMware</strong> <strong>vSphere</strong> CLI\<strong>Perl</strong>\apps<br />
on Windows. All utility applications are fully supported.<br />
The viper<strong>for</strong>mance.pl script retrieves per<strong>for</strong>mance counters from the host.<br />
NOTE If you cannot find a utility application, examine the sample scripts. You can use sample scripts as<br />
starting points <strong>for</strong> your application. On Linux, /usr/share/doc/vmware-vcli/samples, on Windows,<br />
Program Files\<strong>VMware</strong>\<strong>VMware</strong> <strong>vSphere</strong> CLI\<strong>Perl</strong>\samples. Sample scripts are not supported.<br />
2 Run the script with the --help option or without any options to see its online documentation. More<br />
detailed in<strong>for</strong>mation is in the Utility Applications Reference included in the <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong><br />
documentation set and available from the <strong>VMware</strong> Web site.<br />
3 Run the viper<strong>for</strong>mance.pl script.<br />
viper<strong>for</strong>mance.pl --url https://:/sdk/vimService --username nemo --password fi\$h<br />
--host Aquarium --countertype net --interval 30 --samples 3<br />
Escape characters must precede special characters in passwords. See Table 1‐3, “Options Available <strong>for</strong> all<br />
<strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> Scripts,” on page 15 <strong>for</strong> a complete list of connection parameters.<br />
If you want to use the <strong>SDK</strong> <strong>for</strong> a task that none of the utility applications can per<strong>for</strong>m, you might per<strong>for</strong>m the<br />
following tasks:<br />
1 Check the /samples folder <strong>for</strong> a sample script that per<strong>for</strong>ms a similar task. The scripts in the samples<br />
folder are available <strong>for</strong> customization.<br />
2 If a script that per<strong>for</strong>ms a similar task is available, modify the script. If none of the scripts is suitable, write<br />
a new script using the <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> subroutines.<br />
10 <strong>VMware</strong>, Inc.
Change language