This document supports the version of each product listed and
supports all subsequent versions until the document is replaced
by a new edition. To check for more recent editions of this
document, see http://www.vmware.com/support/pubs.
EN-000734-00
VMware View Integration
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates.
If you have comments about this documentation, submit your feedback to:
VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks
and names mentioned herein may be trademarks of their respective companies.
VMware, Inc.
3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
2VMware, Inc.
Contents
About This Book5
1Introduction7
VMware View Components 7
Integration Interfaces to VMware View 8
2Integrating with the Event Database9
Event Database Tables and Schemas 9
Connection Broker Events 11
View Agent Events 17
View Administrator Events 17
View Transfer Server Events 25
Event Message Attributes 25
Sample Database Queries and Views 27
3Using View PowerCLI29
Introduction to View PowerCLI 29
Start the PowerShell Console with View PowerCLI Loaded 30
Displaying Help for a View PowerCLI cmdlet 30
Error Handling 30
Error When Piping and Specifying Objects at the Same Time 30
View Composer Maintenance Task Types 38
Examples of Using View PowerCLI Cmdlets 39
Displaying Information About a View Connection Server Instance 39
Updating the Configuration of a View Connection Server Instance 39
Managing the Configuration of vCenter Servers in VMware View 39
Managing Desktop Pools 39
Creating and Updating Automatically Provisioned Desktop Pools 40
Creating and Updating Linked-Clone Desktop Pools 40
Creating and Updating Manually Provisioned Desktop Pools 41
Creating Manual Unmanaged Desktop Pools 41
Creating and Updating Desktops Provisioned by Terminal Servers 41
Obtaining Information About Users and Groups from Active Directory 41
Managing Desktop Entitlements 42
VMware, Inc.3
VMware View Integration
Managing Local Desktops 42
Managing Remote Sessions 42
Managing Virtual Machines 42
Displaying Information About Physical Computers 43
Updating the Ownership of Machines 43
Displaying Information About Events 43
Managing the Global Configuration of VMware View 43
Managing View Licenses 44
Examples of Using View PowerCLI for Enhanced Functionality 44
Checking if a View Connection Server Instance Is Running 44
Resize Automatic and Linked-Clone Desktop Pools 45
Determining Paths to vSphere Inventory Objects 46
Determining Paths to vSphere Datastore Objects 47
Adding and Removing Datastores 47
4Customizing LDAP Data49
LDAP Configuration Data 49
Export LDAP Configuration Data 50
Modify LDAP Configuration Data 50
Import LDAP Configuration Data 53
Import LDAP Configuration Data Using the LDIFDE Command 54
5Integrating with SCOM55
View Management Packs 55
Name a View Connection Server Group 56
Import the View MPs 56
View Discovery Script 56
Run the Discovery Script 57
Display Discovered Objects 57
Display Managed Objects 58
Views and Monitors 58
Performance Data Collection Settings 59
Enable a Proxy Agent on a Server 60
Display Performance Data 60
Display Information About an Alert 60
Restart a Service 60
Exclude a Domain from Connectivity Monitoring 60
Close Alerts 61
Class and Relationship Definitions 61
6Examining PCoIP Session Statistics65
Usage Notes for Recorded Statistics 65
General Session Statistics 66
Audio Statistics 66
Imaging Statistics 67
Network Statistics 68
USB Statistics 69
Examples of Using PowerShell to Examine PCoIP Statistics 69
Index71
4VMware, Inc.
About This Book
This guide describes how to integrate VMware View™ software with third-party software such as
Windows PowerShell, business intelligence reporting engines, and Microsoft System Center Operations
Manager (SCOM).
Intended Audience
This book is intended for anyone who wants to customize or integrate software to work with View Manager.
The information in this manual is written for experienced Windows or Linux system administrators who are
familiar with virtual machine technology and datacenter operations.
VMware, Inc.5
VMware View Integration
6VMware, Inc.
1
Introduction
With VMware View™, system administrators can provision desktops and control user access to these
desktops. Client software connects users to virtual desktops running on VMware vSphere™, or to physical
systems running within your network environment.
This chapter includes the following topics:
“VMware View Components” on page 7
“Integration Interfaces to VMware View” on page 8
VMware View Components
You can use VMware View with VMware vCenter Server to create desktops from virtual machines that are
running on VMware ESX
VMware View uses your existing Active Directory infrastructure for user authentication and management.
After you create a desktop, authorized end users can use Web-based or locally installed client software to
securely connect to centralized virtual desktops, back-end physical systems, or terminal servers.
VMware View consists of the following major components:
View Connection Server – a software service that acts as a broker for client connections by authenticating
and then directing incoming user requests to the appropriate virtual desktop, physical desktop, or
terminal server.
®
or VMware ESXi™ hosts and deploy these desktops to end users. In addition,
1
View Agent – a software service that is installed on all guest virtual machines, physical systems, or
terminal servers in order to allow them to be managed by VMware View. The agent provides features such
as connection monitoring, Virtual Printing, USB support, and single sign-on.
View Client – a software application that communicates with View Connection Server to allow users to
connect to their desktops.
View Client with Local Mode – a version of View Client that is extended to support the local desktop
feature, which allows users to download virtual machines and use them on their local systems.
View Administrator – a Web application that allows View administrators to configure View Connection
Server, deploy and manage desktops, control user authentication, initiate and examine system events, and
carry out analytical activities.
vCenter Server – a server that acts as a central administrator for ESX/ESXi hosts that are connected on a
network. A vCenter Server provides the central point for configuring, provisioning, and managing virtual
machines in the datacenter.
View Composer – a software service that is installed on a vCenter server to allow VMware View to rapidly
deploy multiple linked-clone desktops from a single centralized base image.
View Transfer Server – a software service that manages and streamlines data transfers between the
datacenter and View desktops that are checked out for use on end users' local systems. View Transfer
Server is required to support desktops that run View Client with Local Mode.
VMware, Inc.7
VMware View Integration
Integration Interfaces to VMware View
You can use several interfaces to integrate VMware View with external applications.
Event database – you can configure VMware View to record events to a Microsoft SQL Server or Oracle
database. You can then use business intelligence reporting engines to access and analyze this database.
View PowerCLI – you can use the PowerShell interface to perform a wide variety of administration tasks
on View components.
Lightweight Directory Access Protocol (LDAP) – you can export and import LDAP configuration data
from and into VMware View. You can create scripts that update this configuration data without accessing
View Administrator directly.
Microsoft System Center Operations Manager (SCOM) – you can monitor the operations of View
components from the SCOM console.
Windows Management Instrumentation (WMI) – you can examine performance statistics for a PCoIP
session.
8VMware, Inc.
2
Integrating with the Event Database
You can configure VMware View to record events to a Microsoft SQL Server or Oracle database. VMware View
records events such as the following examples:
End-user actions such as logging in and starting a desktop session.
Administrator actions such as adding entitlements and creating desktop pools.
Alerts that report system failures and errors.
Statistical sampling such as recording the maximum number of users over a 24-hour period.
You can use business intelligence reporting engines such as Crystal Reports, IBM Cognos, MicroStrategy 9,
and Oracle Enterprise Performance Management System to access and analyze the event database.
This chapter includes the following topics:
“Event Database Tables and Schemas” on page 9
“Connection Broker Events” on page 11
“View Agent Events” on page 17
“View Administrator Events” on page 17
“View Transfer Server Events” on page 25
2
“Event Message Attributes” on page 25
“Sample Database Queries and Views” on page 27
Event Database Tables and Schemas
Tab le 2-1 shows the tables that implement the event database in VMware View.
Tabl e 2-1. Event Database Tables
Table NameDescription
eventMetadata and search optimization data for recent events.
event_dataData values for recent events.
event_data_historicalData values for all events.
event_historicalMetadata and search optimization data for all events.
The event database prepends the names of these tables with a prefix that you define when you set up the
database. See the VMware View Installation document for more information.
IMPORTANT VMware View does not restrict the growth of the event_historical and event_data_historical
tables. You must implement a space management policy for these tables.
VMware, Inc.9
VMware View Integration
VMware View records details about events to all the database tables. After a certain period of time has elapsed
since writing an event record, VMware View deletes the record from the event and event_data tables. You can
use View Administrator to configure the time period for which the database keeps a record in the event and
event_data tables. See the VMware View Installation document for more information.
N
OTEIt is possible for events to be lost if you restart View Connection Server instances while the event
database is not running. For a solution that avoids this problem see http://kb.vmware.com/kb/1021461.
A unique primary key, EventID, identifies each event that VMware View records in the event and event_
historical tables. VMware View records data values for each event in the event_data and event_data_historical
tables. You can obtain the complete set of information for an event by joining the event and event_data tables
or the event_historical and event_data_historical tables on the EventID column.
The EventType, Severity, and Time columns in the event and event_historical tables identify the type and
severity of an event and the time at which it occurred.
Tab le 2-2 shows the schema for the event and event_historical tables.
Tabl e 2-2. Schema for the event and event_historical Tables
Column Name
AcknowledgedSMALLINTtinyintWhether VMware View acknowledged the
DesktopIdNVARCHAR2(512)nvarchar(512)Desktop ID of the associated pool.
EventIDINTEGERintUnique primary key for the event.
EventTypeNVARCHAR2(512)nvarchar(512)Event name that corresponds to an item in
FolderPathNVARCHAR2(512)nvarchar(512)Full path of the folder that contains the
GroupIdNVARCHAR2(512)nvarchar(512)SID of the associated group in Active
LUNIdNVARCHAR2(512)nvarchar(512)ID of the LUN that stores the associated
MachineIdNVARCHAR2(512)nvarchar(512)ID of the associated physical or virtual
ModuleNVARCHAR2(512)nvarchar(512)View component that raised the event. For
ModuleAndEventTextNVARCHAR2(512)nvarchar(512)Event message with values substituted for
NodeNVARCHAR2(512)nvarchar(512)Name of the virtual device node.
SeverityNVARCHAR2(512)nvarchar(512)Severity level. For example, INFO,
SourceNVARCHAR2(512)nvarchar(512)Identifier for the source of the event.
ThinAppIdNVARCHAR2(512)nvarchar(512)ID of the associated ThinApp™ object.
TimeTIMESTAMPdatetimeTime at which the event occurred,
UserDiskPathIdNVARCHAR2(512)nvarchar(512)ID of the user disk.
UserSIDNVARCHAR2(512)nvarchar(512)SID of the associated user in Active
Oracle
Data Type
SQLServer
Data TypeDescription
event.
0 = false
1 = true
the message catalog. For example,
BROKER_USERLOGGEDIN.
associated object.
Directory.
object.
machine.
example, Admin, Broker, Tunnel,
Framework, Client, or Agent.
attribute parameters.
WARNING, ERROR, AUDIT_SUCCESS,
AUDIT_FAIL.
measured from the epoch (January 1, 1970).
Directory.
10VMware, Inc.
Chapter 2 Integrating with the Event Database
Tab le 2-3 shows the schema for the event_data and event_data_historical tables.
Tabl e 2-3. Schema for the event_data and event_data_historical Tables
Oracle
Column Name
BooleanValueSMALLINTtinyintValue of a Boolean attribute.
EventIDINTEGERintUnique primary key for the event.
IntValueINTEGERintValue of an integer attribute.
NameNVARCHAR2(512)nvarchar(512)Attribute name (for example,
StrValueNVARCHAR2(512)nvarchar(512)Value of a string attribute. For other types
TimeValueTIMESTAMPdatetimeValue of a date and time attribute.
TypeSMALLINTtinyintThe data type of the attribute.
Data Type
SQLServer
Data TypeDescription
0 = false
1 = true
UserDisplayName).
of attributes, this column contains an
interpretation of the data type as a string.
0 = StrValue
1 = IntValue
2 = TimeValue
3 = BooleanValue
Connection Broker Events
Tab le 2-4 shows the event types for the connection broker.
The BROKER_DAILY_MAX_USERS event reports the maximum number of concurrent desktop sessions over
a 24-hour period. Short-lived sessions might not be included in the count because the sampling is performed
every five minutes.
The BROKER_VC_DISABLED and BROKER_VC_ENABLED events report the state of of the vCenter driver
that VMware View uses to track a vCenter Server. The BROKER_VC_STATUS_* events report the state of a
vCenter Server.
Tabl e 2-4. Connection Broker Events
EventTypeSeverityModuleAndEventText
BROKER_AGENT_OFFLINEWARNINGThe agent running on machine
BROKER_AGENT_ONLINEWARNINGThe agent running on machine
BROKER_DAILY_MAX_USERSINFO${Time}: Over the past 24 hours, the
BROKER_DESKTOP_LAUNCH_FAILUREERRORUnable to launch from Pool ${DesktopId}
BROKER_DESKTOP_NOT_ENTITLEDAUDIT_FAILUnable to launch from Pool ${DesktopId}
${MachineName} has not responded to
queries, marking it as offline
${MachineName} is responding again, but
did not send a startup message
maximum number of users with
concurrent desktop sessions was
${UserCount}
for user ${UserDisplayName}: The broker
encountered an error while processing the
request, please contact support for
assistance
for user ${UserDisplayName}: User is not
entitled to this Pool
VMware, Inc.11
VMware View Integration
Tabl e 2-4. Connection Broker Events (Continued)
EventTypeSeverityModuleAndEventText
BROKER_DESKTOP_PROTOCOL_NOT_
SUPPORTED
BROKER_DESKTOP_REQUESTINFOUser ${UserDisplayName} requested Pool
BROKER_EVENT_HANDLING_STARTEDINFOBroker ${BrokerName} has started
BROKER_EVENT_HANDLING_STOPPEDINFO${BrokerName} has stopped handling
BROKER_LOCALMODE_OLD_ANCHOR_
DELETE_FAILURE
BROKER_LOCALMODE_OPERATION_AUDIT_
FAI LUR E
BROKER_LOCALMODE_OPERATION_
FAI LUR E
BROKER_LOCALMODE_OPERATION_
SUCCESS
BROKER_MACHINE_ALLOCATEDINFOUser ${UserDisplayName} requested Pool
BROKER_MACHINE_ASSIGNED_
UNAVAILABLE
BROKER_MACHINE_CANNOT_CONNECTAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_MACHINE_CHECKEDOUTAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_MACHINE_CONFIGURED_VIDEO_
SETTINGS
BROKER_MACHINE_NOT_READYWARNINGUnable to launch from Pool ${DesktopId}
BROKER_MACHINE_OPERATION_DELETEDINFOmachine ${MachineName} has been
BROKER_MACHINE_PROTOCOL_NOT_
SUPPORTED
BROKER_MACHINE_PROTOCOL_
UNAVAILABLE
AUDIT_FAILUnable to launch from Pool ${DesktopId}
for user ${UserDisplayName}: Requested
protocol ${ProtocolId} is not supported
${DesktopId}
handling events
events
WARNINGOld anchor snapshot deletion task failed
for Machine ${MachineName}. Error
message: ${LocalModeMessage}
AUDIT_FAILLocal Mode Operation
${LocalModeOperation} failed for Desktop
${MachineName}, ID: ${DesktopId}. Error
message: ${LocalModeMessage}
ERRORLocal Mode Operation
${LocalModeOperation} failed for Desktop
${MachineName}, ID: ${DesktopId}. Error
message: ${LocalModeMessage}
AUDIT_SUCCESS${LocalModeOperation} has completed for
Desktop ${MachineName}, ID:
${DesktopId}.
${DesktopId}, allocated machine
${MachineName}
AUDIT_FAILUnable to launch from Pool ${DesktopId}
for user ${UserDisplayName}: Assigned
machine ${MachineName} is unavailable
for user ${UserDisplayName}: Failed to
connect to Machine ${MachineName} using
${ProtocolId}
for user ${UserDisplayName}: VM
${MachineName} is currently checked out
on a client device
INFOSuccessfully configured video settings for
Machine VM ${MachineName} in Pool
${DesktopId}
for user ${UserDisplayName}: Machine
${MachineName} is not ready to accept
connections
deleted
AUDIT_FAILUnable to launch from Pool ${DesktopId}
for user ${UserDisplayName}: Machine
${MachineName} does not support
protocol ${ProtocolId}
AUDIT_FAILUnable to launch from Pool ${DesktopId}
for user ${UserDisplayName}: Machine
${MachineName} did not report protocol
${ProtocolId} as ready
12VMware, Inc.
Chapter 2 Integrating with the Event Database
Tabl e 2-4. Connection Broker Events (Continued)
EventTypeSeverityModuleAndEventText
BROKER_MACHINE_REJECTED_SESSIONWARNINGUnable to launch from Pool ${DesktopId}
BROKER_MACHINE_SESSION_TIMEDOUTWARNINGSession for user ${UserDisplayName}
BROKER_MULTIPLE_DESKTOPS_FOR_KIOSK_
WARNINGUser ${UserDisplayName} is entitled to
USER
BROKER_POOL_CANNOT_ASSIGNAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_COMANAGER_REQUIREDAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_EMPTYAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_NO_MACHINE_ASSIGNEDAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_NO_RESPONSESAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_OVERLOADEDAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_POLICY_VIOLATIONAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_PROTOCOL_NOT_
AUDIT_FAILUnable to launch from Pool ${DesktopId}
SUPPORTED
BROKER_POOL_PROTOCOL_UNAVAILABLEAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_POOL_TUNNEL_NOT_SUPPORTEDAUDIT_FAILUnable to launch from Pool ${DesktopId}
BROKER_PROVISIONING_ERROR_CONFIG_
INFOThe previously reported configuration
CLEARED
BROKER_PROVISIONING_ERROR_CONFIG_
ERRORProvisioning error occurred on Pool
SET
BROKER_PROVISIONING_ERROR_DISK_
INFOThe previously reported disk problem is no
CLEARED
BROKER_PROVISIONING_ERROR_DISK_LC_
INFOThe previously reported error due to
RESERVATION_CLEARED
for user ${UserDisplayName}: Machine
${MachineName} rejected the start session
request
timed out
multiple desktop pools
for user ${UserDisplayName}: There are no
machines available to assign the user to
for user ${UserDisplayName}: No
co-management availability for protocol
${ProtocolId}
for user ${UserDisplayName}: The Desktop
Pool is empty
for user ${UserDisplayName}: No machine
assigned to this user
for user ${UserDisplayName}: No
machines in the Desktop Pool are
responsive
for user ${UserDisplayName}: All
responding machines are currently in use
for user ${UserDisplayName}: This
Desktop Pool does not allow online
sessions
for user ${UserDisplayName}: There were
no machines available that support
protocol ${ProtocolId}
for user ${UserDisplayName}: There were
no machines available that reported
protocol ${ProtocolId} as ready
for user ${UserDisplayName}: Tunnelling
is not supported for protocol ${ProtocolId}
problem is no longer present on Pool
${DesktopId}
${DesktopId} because of a configuration
problem
longer present on Pool ${DesktopId}
available free disk space reserved for linked
clones is no longer present on Pool
${DesktopId}