C# Sample Programs

The C# (.NET) sample programs are located in the SDK\vsphere-ws\dotnet\cs\samples\ directory. Details listed in C# (.Net) Sample Programs. Each of the examples listed in the table is actually a directory that contains a .cs file, a .csproj file, a filename2008.csproj file, and a filename2010.csproj file.

The samples include a GeneratingStubs.txt file and a readme_dotnet.html file at top level.

The readme file explains how to build the examples using Visual Studio 2005 or Visual C# 2005 Express.

C# (.Net) Sample Programs 

Example	Description
AddVirtualNic	Adds a virtual NIC to the ESX/ESXi system. First specifies a HostVirtualNicSpec, and then adds the NIC to the host.
AddVirtualSwitch	Adds a virtual switch to the ESX/ESXi system.
AddVirtualSwitchPortGroup	Adds a virtual port group to the ESX/ESXi system.
AppUtil	Contains the following utility applications: ■ AppUtil – Utility application that drives the user input mechanism for other samples and includes some other utility functions. ■ ArgumentHandlingException – Handles command-line exceptions. Used by AppUtil. ■ CertPolicy – Handles certification problems by displaying informational messages. ■ ClientUtil – Client utilities related to prompting the user and logging. Used by AppUtil. ■ Log – Logger to file or console. ■ OptionSpec – Option parsing utility. ■ ServiceUtils, ServiceUtilsV25 – Utilities for connecting to the server. ■ VersionUtil – Utility that determines the name space and supported versions. ■ VMUtils – Utility that sets values for a basic virtual machine. Some of the setup, such as adding a floppy disk drive, might not always be needed.
Basics	Uses the PerformanceManager for basic monitoring.
Browser	Retrieves the contents of the ServiceInstance starting at the root folder, and prints a listing of ManagedEntity objects. Optionally, obtains properties for a specific type, or by default, for ManagedEntity itself.
CIMInfo	CIMInfo versioning sample that retrieves the details of CIM_Fan like Activecooling, Caption, CommunicationStatus and so on.
Coldmigration	Migrates a powered off virtual machine from one host to another.
Connect	Simple example that logs in and logs out.
Create	Creates a Folder, Cluster, Datacenter or standalone host. Prompts the user for the item to create and where to put the item, for example, in a folder.
CreateUser	Creates a user. Specifies permissions for the user using the AuthorizationManager.
CredentialStorePSCmdLets	Multiple commandlets for managing the credential store.
Delete	Deletes a managed entity.
DeleteOneTimeScheduledTask	Extracts a task from scheduledTaskManager and deletes it. This sample is well commented and illustrates using the PropertyCollector. You can create the task using the OneTimeScheduledTask example.
DisplayNewProperties	Retrieves the specified set of properties for the given managed object reference into an array of result objects (returned in the same order as the property list)
DisplayNewPropertiesHost	Displays properties of an ESX/ESXi host. The properties displayed depend on the version of the host.
DisplayNewPropertiesVM	Displays a set of properties for a virtual machine. The properties displayed depend on the version of the software on the host.
EventFormat	Retrieves and formats the last event on the ESX/ESXi or vCenter Server system. Demonstrates event formatting.
EventHistoryCollectorMonitor	Creates an EventHistoryCollector and monitors the corresponding events.
GetUpdates	Retrieves updates for a virtual machine or an ESX/ESXi host.
GetVirtualDiskFiles	Retrieves the virtual disk files from a host’s datastores.
GetVMFiles	Downloads the files in the virtual machine configuration directory as well as the files in the virtual machine snapshot, suspend, and log directories. Writes progress to the console.
History	Displays the performance measurements of a specified counter of a specified ESX/ESXi for a specified duration, or 20 minutes (default) at the console.
HostPowerOps	Performs reboot, shutdown, or suspend (power off to standby) operations on an ESX/ESXi system.
LicenseManager	Displays licensing information. The user can specify a license server,
MobStartPage	Includes a program, image files, and HTML files for displaying a Managed Object browser.
Move	Moves a managed entity from one folder to another.
OneTimeScheduledTask	Creates a ScheduledTask that powers off a virtual machine and schedules the task using a OnceTaskScheduler. You can delete the task using the DeleteOneTimeScheduledTask commandlet.
PrintCounters	Defines a printEntityCounters function that prints counters for a virtual machine, host, or resource pool.
PropertyCollector	Illustrates use of the PropertyCollector.
QueryMemoryOverhead	Illustrates use of the QueryMemoryOverhead method. The folder includes two examples, QueryMemoryOverheadV25 uses the currently valid QueryMemoryOverheadEx method, QueryMemoryOverhead uses the deprecated QueryMemoryOverhead method.
RealTime	Displays the current performance measurements of selected CPU counters of any specified virtual machine at the console.
RecordSession	Records a session and allows you to retrieve a specified set of properties for a specified managed object reference into an array of result objects.
RemoveManagedObject	Removes a host from a cluster or a virtual machine from a host. Handles errors, for example, if the host is not in a cluster, by printing that information to the command line.
RemoveVirtualNic	Removes a virtual NIC from the ESX/ESXi system.
RemoveVirtualSwitch	Removes a virtual switch from the ESX/ESXi system.
RemoveVirtualSwitchPortGroup	Removes a virtual port group from the ESX/ESXi system.
Rename	Renames a managed entity.
SCSILunName	Prints the virtual machine file system volumes on a specified SCSI LUN.
SearchIndex	Illustrates the use of the SearchIndex API.
SimpleClient	Demonstrates connecting to a service, logging on to service, obtaining service content, and logging out from the service.
SSPI	Illustrates how to use an SDK application with Microsoft SSPI.
SSPICIMClient	Illustrates how to use an CIM client application with Microsoft SSPI.
TaskList	Displays currently running tasks and their state.
VMClone	Clones a virtual machine.
VMCreate	Creates a virtual machine.
VMEventHistoryCollectorMonitor	Returns all events on the latest page on the EventHistoryCollector.
VMotion	Validates that migration with VMotion is feasible between two hosts, and performs the migration if the hosts are compatible.
VMPowerOps	Retrieves a reference to a virtual machine and invokes power operations specified on the command line on that virtual machine.
VMPowerStateAlarm	Creates an alarm that monitors virtual machine state and sends email if the virtual machine power is off. Includes error handling, for example, when the command is attempted with an ESX/ESXi host as a target.
VMReconfig	Reconfigures a virtual machine by changing its memory, cpu, disk, nic, or cd.
VMSnapshot	Performs snapshot operations such as create, revert to, remove, remove all, and so on.
VMware.Security.CredentialStore	Illustrates use of the VMware credential store.
WatchVM	Monitors updates on a virtual machine using the PropertyCollector.
WeeklyRecurrenceScheduledTask	Creates a task that reboots a virtual machine once a week.

Axis 4.1

■	SDK\samples\Axis\java\com\vmware – Top-level directory for Java samples

■	SDK\samples\Axis\java\com\vmware\apputils – Helper applications.

■	SDK\samples\Axis\java\com\vmware\samples – Samples. Details listed in Java Sample Programs.

■	SDK\samples\Axis\java\com\vmware\security – Credential store utility

■	SDK\samples\Axis\java\com\vmware\vim and SDK\samples\Axis\java\com\vmware\vim25 – Stub directories. The vim directory contains stubs for servers that precede VirtualCenter 2.5, the vim25 directory contains stubs for VirtualCenter 2.5 and later, including vSphere 4.0 and later.

Java Sample Programs 

Directory	Example	Description
alarm	VMPowerStateAlarm	Creates an alarm to monitor a virtual machine's power state.
ciminfo	CIMInfo	Includes functions for information retrieval, such as functions that create an association traversal filter, retrieve an instance of a specified CIM class, get a single instance of the class provided, and run the specified operation for that instance of the class.
	CIMUtil	CIM utility functions, including a wrapper that provides an enumerator over all the instances of the specified class and some simpler wrappers.
events	EventFormat	Retrieves and formats the last event from the host daemon or vpxd. Includes a function that formats the event message.
	EventHistoryCollectorMonitor	Demonstrates how to create and monitor an EventHistoryCollector. Uses the latestPage property of EventHistoryCollector to filter the events.
	VMEventHistoryCollectorMonitor	Standalone client that demonstrates how to perform the following tasks: ■ Logging into the web service. ■ Creating EventHistoryCollector filtered for a single virtual machine. ■ Monitoring events using the latestPage property of the EventHistoryCollector.
general	Browser	Prints all managed entities and for each entity its type, reference value, property name, property value, inner object type, inner reference value and inner property value.
	Connect	Connects to an ESX/ESXi system or a vCenter Server system.
	Create	Creates a managed entity such as a folder, datacenter, or cluster.
	Delete	Deletes a managed entity from the inventory tree. The managed entity can be a virtual machine, a ClusterComputeResource, or a folder.
	GetUpdates	Demonstrates how to use the PropertyCollector to monitor one or more properties of one or more managed objects. In particular this sample monitors one or all virtual machines and all hosts or one host for changes to some basic properties.
	LicenseManager	Demonstrates uses of the licensing API using License managed object reference.
	Move	Moves a managed entity from its current location in the inventory to a new location in a specified folder
	PropertyCollector	Illustrates the use of the PropertyCollector API.
	RemoveManagedObject	Destroys or unregisters a managed inventory object like a Host, VirtualMachine, Folder, and so on.
	Rename	Renames a managed entity object.
	SearchIndex	Illustrates the use of the SearchIndex API.
	SimpleClient	Connects to the server, logs in, lists the inventory contents (managed entities) at the console, and logs out.
	TaskList	Displays a list of tasks performed on a specified managed object.
host	AddVirtualNic RemoveVirtualNic	Adds a virtual NIC to a port group on a virtual switch an removes a virtual NIC from a port group.
	AddVirtualSwitch RemoveVirtualSwitch	Adds a virtual switch to a host and removes a virtual switch from the host.
	AddVirtualSwitchPortGroup RemoveVirtualSwitchPortGroup	Adds a port group to a virtual switch.
	ColdMigration	Puts virtual machine files into a specified datacenter and datastore and registers and reconfigures the corresponding virtual machine.
httpfileaccess	GetVMFiles	Retrieves configuration files, snapshots files, log files, and virtual disk files of a virtual machine and places them on the system on which the program is run.
performance	Basics	Displays available performance counters or other metadata for an ESX/ESXi host.
	History	Reads performance measurements from the current time, or from a specified start time, for a specified duration.
	PrintCounters	Writes the available counters of a managed entity into the specified file at the specified location. The managed entity can be a host system, a virtual machine, or a resource pool.
	Realtime	Displays performance measurements from the current time at the console.
	VItop	An esxtop-like sample application that lets administrators specify the CPU and memory counters by name to obtain metrics for a specified host.
	VIUsage	Creates a GUI for graphical representation of the counters.
scheduling	DeleteOneTimeScheduledTask	Demonstrates deleting a ScheduledTask.
	OneTimeScheduledTask	Demonstrates creating a ScheduledTask using the ScheduledTaskManager.
	WeeklyRecurrenceScheduledTask	Demonstrates creating a weekly recurrent scheduled task.
scsilun	SCSILunName	Displays the CanonicalName,Vendor, Model, Data, Namespace and NamespaceId of the host’s SCSI LUN.
simpleagent	SimpleAgent	Accesses the local credential store to obtain a single user account to log in to the specified server.
	CreateUsers	Creates a user account and password and stores them in the local credential store.
vm	VMClone	Locates an existing virtual machine on the vCenter Server system, makes a template from this virtual machine, and deploys instances of the template onto a datacenter.
	VMCreate	Creates a virtual machine. Different command-line input creates the virtual machine in different ways.
	VMDeltaDisk	Creates a delta disk on top of an existing virtual disk in a virtual machine, and simultaneously removes the original disk using the reconfigure API. Use delta disks in conjunction with linked virtual machines.
	VMLinkedClone	Creates a linked virtual machine from an existing snapshot.
	VMotion	Checks whether migration with VMotion is feasible between two hosts. Performs the migration if the hosts are compatible.
	VMpowerOps	Performs power operations on a virtual machine.
	VMPromoteDisks	Consolidates a linked virtual machine by using the VirtualMachine.PromoteDisks method.
	VMReconfig	Reconfigures a virtual machine. Includes reconfiguring the disk size, disk mode and so on.
	VMRelocate	Relocate a linked virtual machine using disk move type.
	VMSnapshot	Performs virtual machine snapshot operations
version	Samples in the version directory illustrate running against hosts that have different versions of vSphere or VMware Infrastructure installed. The HostPowerOps sample includes running against Virtual Infrastructure 2.0. The other samples apply to Virtual Infrastructure 2.5 and later versions including vSphere 4.0.
	displaynewpropertieshost/ DisplayNewPropertiesHost DisplayNewPropertiesHostV25	Displays properties of the host based on the API version supported by ESX/ESXi or vCenter Server.
	displaynewpropertiesvm/ DisplayNewPropertiesVM DisplayNewPropertiesVMV25	Displays properties of a virtual machine based on the API version supported by the host to which you connect.
	getvirtualdiskfiles/ GetVirtualDiskFiles GetVirtualDiskFilesV25	Searches the virtual disk files in all the datastores available in a specified host using the properties ControllerType and ThinProperty.
	hostpowerops/ HostPowerOps HostPowerOpsV25	Powers down a host. This samples illustrates how to run a sample against hosts of multiple versions, including Virtual Infrastructure 2.0.
	installhostpatch/ InstallHostPatch InstallHostPatchV25	Uses the HostPatchManager managed object to upgrade the components in an ESXi system.
	querymemoryoverhead/ QueryMemoryOverhead QueryMemoryOverheadV25	Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics.
	recordsession/ RecordSession RecordSessionV25	Demonstrates recording a session.