VMware View API Reference Documentation

Welcome to the VMware View API Reference documentation. This API reference provides comprehensive information about all data structures available through the View API:

In addition, the documentation will outline any View API Helper library classes that makes the API easier to build against.

Connecting to the Connection Server and invoking the View API Services

VMware PowerCLI provides Connect-HVServer cmdlet to connect to the Connection Server. Once connection is established successfully, you can invoke any ViewAPI services. Please refer Connect-HVServer documentation for more details on server connection.

$hvServer = Connect-HVServer -Server <Server> -User <UserName> -Password <Password> -Domain <Domain>
$services = $hvServer.ExtensionData
$<serviceHelper> = New-Object VMware.Hv.<YourServiceName>
<#
 # Processing
 #>

The following is the example for listing the Connection Server IDs with ConnectionServer_List method in ConnectionServer service. You can access the other View API services in the similar manner.

$hvServer = Connect-HVServer -Server <Server> -User <UserName> -Password <Password> -Domain <Domain>
$Global:hvServices = $hvServer.ExtensionData
$csService = New-Object VMware.Hv.ConnectionServerService
$csList = $csService.ConnectionServer_List($hvServices)
foreach ($info in $csList) {
   Write-Host $info.id
}

Navigating the API Reference

The View API Reference is an HTML frameset. Click an entry in the left-hand pane to display information in the right-hand pane. To find the description of a specific object type, click the appropriate category name and then refine your search by entering the object name in the search text field.

To quickly find an entry, start typing its name in the Quick Index field.

Notes