vSphere SDK for Perl Utility Applications Reference

The VMware vSphere SDK for Perl provides a suite of ready-to-run Utility Applications for administering and managing your virtual datacenter. These Utility Applications, listed in Table 1, are in the apps directories:

Linux Installation: /usr/lib/vmware-vcli/apps
Windows Installation: C:\Program Files\VMware\VMware vSphere CLI\Perl\apps

The vSphere SDK for Perl also includes a number of sample applications that you can use as starting points for developing your own applications. The samples are in the samples directories:

Linux Samples: /usr/share/doc/vmware-vcli/samples
Windows Samples: C:\Program Files\VMware\VMware vSphere CLI\Perl\samples

To display usage information, click the application name in the Documentation column of Table 1.

Table 1: vSphere SDK for Perl Utility Applications
connect.plConnects to and disconnects from a host.
credstore_admin.plAdds, removes, retrieves, lists, and clears entries in the credential store.
dsbrowse.plBrowses datastores and lists their attributes.
extractlog.plExtracts the vmware.log for any virtual machine.
fileaccess.plPerforms put and get operations on datastore and configuration files.
guestinfo.plLists and customizes attributes of a guest OS on a virtual machine.
hostdiagnostics.plExtracts the specified log.
hostevacuate.plMigrates all virtual machines from one host to another.
hostinfo.plDisplays the processor, network, and memory attributes of the hosts.
hostops.plPerforms host operations: adds a standalone host, disconnects, reconnects, enters and exits maintenance mode, reboots, shuts down a host, adds a host, removes a host, moves a host into folder cluster.
load_session.plLoads a saved session to a host.
save_session.plConnects to a host and saves session state in a file.
sharesmanager.plDisplays or modifies shares for memory, CPU, and disk for specified virtual machines.
snapshotmanager.plCaptures the state of one or more virtual machines into a snapshot.
vdiskcreate.plCreates a new virtual disk on a virtual machine.
vidiscovery.plDisplays the hierarchy of managed virtual entities.
viperformance.plRetrieves performance counters from a host.
viversion.plDisplays all information about the product.
vmclone.plClones a virtual machine while customizing cloned virtual machine and guest OS.
vmcontrol.plPerforms power-on, power-off, suspend, and reset operations on the virtual machine; performs reboot, shutdown, and standby on the guest OS.
vmcreate.plCreates virtual machines according to an XML specification file.
vminfo.plLists the properties of the virtual machines.
vmmigrate.plMigrates virtual machines within the current host, or to a different host.
vmreconfig.plReconfigures a virtual machine.
vmregister.plRegisters and unregisters a virtual machine.
vmsnapshot.plCreates snapshots of virtual machines.
vmtemplate.plConverts a virtual machine to a template and a template to a virtual machine.

VMware welcomes your suggestions for improving technical publications. Email your feedback to docfeedback@vmware.com

Copyright © 2006-2010 VMware, Inc. All rights reserved.

Last updated May 2010