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.
See “Understanding Server‐Side Objects” on page 24.<br />
Step 6: Close the Server Connection<br />
Chapter 2 Writing <strong>vSphere</strong> <strong>SDK</strong> <strong>for</strong> <strong>Perl</strong> Scripts<br />
To log out and exit, use the Util::disconnect() subroutine. Example 2‐1 shows the complete listing <strong>for</strong><br />
simpleclient.pl.<br />
Example 2-1. Sample Script (Commented Version)<br />
#!/usr/bin/perl<br />
# The simpleclient.pl script outputs a list of all the entities of the specified managed-entity<br />
# type (ClusterComputeResource, ComputeResource, Datacenter, Datastore, Folder, HostSystem,<br />
# Network, ResourcePool, VirtualMachine, or VirtualService) found on the target vCenter Server or<br />
# ESX system. Script users must provide logon credentials and the managed entity type. The script<br />
# leverages the Util::trace() subroutine to display the found entities of the specified type.<br />
use strict;<br />
use warnings;<br />
use <strong>VMware</strong>::VIRuntime;<br />
# Defining attributes <strong>for</strong> a required option named 'entity' that<br />
# accepts a string.<br />
#<br />
my %opts = (<br />
entity => {<br />
type => "=s",<br />
variable => "VI_ENTITY",<br />
help => "ManagedEntity type: HostSystem, etc",<br />
required => 1,<br />
},<br />
);<br />
Opts::add_options(%opts);<br />
# Parse all connection options (both built-in and custom), and then<br />
# connect to the server<br />
Opts::parse();<br />
Opts::validate();<br />
Util::connect();<br />
# Obtain all inventory objects of the specified type<br />
my $entity_type = Opts::get_option('entity');<br />
my $entity_views = Vim::find_entity_views(view_type => $entity_type);<br />
# Process the findings and output to the console<br />
<strong>for</strong>each my $entity_view (@$entity_views) {<br />
my $entity_name = $entity_view->name;<br />
Util::trace(0, "Found $entity_type: $entity_name\n");<br />
}<br />
# Disconnect from the server<br />
Util::disconnect();<br />
To run the simpleclient.pl script<br />
1 Open a command prompt or console.<br />
2 Change to the directory that contains the simpleclient.pl script.<br />
3 Run the script using the following syntax:<br />
perl simpleclient.pl --entity <br />
For example:<br />
perl simpleclient.pl --server aquarium.mycomp.com --username abalone --password tank --entity<br />
HostSystem<br />
<strong>VMware</strong>, Inc. 23