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-001484-00
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
View Integration7
1Introduction9
View Components 9
Integration Interfaces to View 10
Start the PowerShell Console with View PowerCLI Loaded 32
Displaying Help for a View PowerCLI cmdlet 32
Error Handling 33
Error When Piping and Specifying Objects at the Same Time 33
View Composer Maintenance Task Types 41
Examples of Using View PowerCLI Cmdlets 41
Displaying Information About a View Connection Server Instance 41
Updating the Configuration of a View Connection Server Instance 41
Managing the Configuration of vCenter Servers in View 42
Managing Desktop Pools 42
Creating and Updating Automatically Provisioned Desktop Pools 42
Creating and Updating Linked-Clone Desktop Pools 43
Creating and Updating Manually Provisioned Desktop Pools 43
Creating Manual Unmanaged Desktop Pools 44
Creating and Updating Desktops Provisioned by RDS Hosts 44
Obtaining Information About Users and Groups from Active Directory 44
Managing Desktop Entitlements 44
Managing Remote Sessions 45
Managing Virtual Machines 45
VMware, Inc.3
View Integration
Displaying Information About Physical Computers 45
Updating the Ownership of Machines 46
Displaying Information About Events 46
Managing the Global Configuration of View 46
Managing View Licenses 46
Examples of Using View PowerCLI for Enhanced Functionality 47
Checking if a View Connection Server Instance Is Running 47
Resize Automatic and Linked-Clone Desktop Pools 48
Determining Paths to vSphere Inventory Objects 49
Determining Paths to vSphere Datastore Objects 49
Adding and Removing Datastores 50
Assign Multiple Network Labels to a Desktop Pool 51
Obtain NIC and Network Label Information in a Configuration File 52
Edit the Network Label Configuration File 54
Deploy a Desktop Pool with Network Label Assignments 55
Display the Network Label Assignments for an Existing Pool or Desktop 56
Disable Automatic Network Label Assigments 58
4Customizing LDAP Data59
LDAP Configuration Data 59
Export LDAP Configuration Data 60
Modify LDAP Configuration Data 60
Import LDAP Configuration Data 63
Import LDAP Configuration Data Using the LDIFDE Command 64
5Integrating with SCOM65
View Management Packs 65
Name a View Connection Server Group 66
Import the View MPs 66
View Discovery Script 66
Run the Discovery Script 67
Display Discovered Objects 67
Display Managed Objects 68
Views and Monitors 68
Performance Data Collection Settings 69
Enable a Proxy Agent on a Server 70
Display Performance Data 70
Display Information About an Alert 70
Restart a Service 70
Exclude a Domain from Connectivity Monitoring 70
Close Alerts 71
Class and Relationship Definitions 71
6Examining PCoIP Session Statistics75
Usage Notes for Recorded Statistics 75
General Session Statistics 76
Audio Statistics 76
Imaging Statistics 77
Network Statistics 78
USB Statistics 79
Examples of Using PowerShell to Examine PCoIP Statistics 79
4VMware, Inc.
7Dynamically Setting Desktop Policies with Start Session Scripts81
Overview of Configuring Start Session Scripts 81
Example Start Session Scripts 82
Enable the VMware View Script Host Service 83
Configure a User Account to Run the Start Session Script 83
Add Windows Registry Entries for a Start Session Script 83
Index85
Contents
VMware, Inc.5
View Integration
6VMware, Inc.
View Integration
This guide describes how to integrate 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. 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.7
View Integration
8VMware, Inc.
1
Introduction
With View, system administrators can provision desktops and control user access to these desktops. Client
software connects users to virtual machines running in VMware vSphere™, or to physical systems running
within your network environment. In addition, View administrators can configure Remote Desktop Services
(RDS) hosts to provide View desktop and application sessions to client devices.
This chapter includes the following topics:
“View Components” on page 9
“Integration Interfaces to View” on page 10
View Components
You can use View with VMware vCenter Server to create desktops from virtual machines that are running on
VMware ESX
RDS hosts to deploy desktops and applications to end users. View uses your existing Active Directory
infrastructure for user authentication and management.
After you create a desktop or application, authorized end users can use Web-based or locally installed client
software to securely connect to centralized virtual machines, back-end physical systems, or Remote Desktop
Services (RDS) hosts.
®
or VMware ESXi™ hosts and deploy these desktops to end users. You can also install View on
1
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 machine, physical system, or Remote
Desktop Services (RDS) host.
View Agent – a software service that is installed on all guest virtual machines, physical systems, or RDS
hosts in order to allow them to be managed by View. The agent provides features such as connection
monitoring, Virtual Printing, USB support, and single sign-on.
Horizon Client – a software application that communicates with View Connection Server to allow users
to connect to their desktops.
View Administrator – a Web application that allows View administrators to configure View Connection
Server, deploy desktop and application pools, manage machines, 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 View to rapidly deploy
multiple linked-clone desktops from a single centralized base image.
VMware, Inc.9
View Integration
Integration Interfaces to View
You can use several interfaces to integrate View with external applications.
Event database – you can configure 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 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.
10VMware, Inc.
2w
Integrating with the Event Database
You can configure View to record events to a Microsoft SQL Server or Oracle database. View records events
such as the following examples:
End-user actions such as logging in and starting a desktop or application session.
Administrator actions such as adding entitlements and creating desktop or application 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 11
“Connection Broker Events” on page 13
“View Agent Events” on page 19
“View Administrator Events” on page 19
“Event Message Attributes” on page 26
2
“Sample Database Queries and Views” on page 28
Event Database Tables and Schemas
Tab le 2-1 shows the tables that implement the event database in 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 View Installation document for more information.
IMPORTANT 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.11
View Integration
View records details about events to all the database tables. After a certain period of time has elapsed since
writing an event record, 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 View Installation document for more information.
N
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 View records in the event and event_historical
tables. 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 View acknowledged the event.
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
OTE It is possible for events to be lost if you restart View Connection Server instances while the event
Oracle
Data Type
SQLServer
Data TypeDescription
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.
12VMware, 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_DESKTOP_SESSIONS event reports the maximum number of concurrent
desktop sessions over a 24-hour period. If a user runs multiple desktop sessions concurrently, each desktop
session is counted separately. The BROKER_DAILY_MAX_APP_USERS event reports the maximum number
of concurrent application users over a 24-hour period. If a user runs multiple applications concurrently, the
user is counted only once. 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 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_APPLICATION_LAUNCH_FAILUREERRORUnable to launch from Pool ${PoolId} for
BROKER_APPLICATION_MISSINGWARNINGAt least ${ApplicationMissingCount}
${MachineName} has not responded to
queries, marking it as offline
${MachineName} is responding again, but
did not send a startup message
user ${UserDisplayName}: The broker
encountered an error while processing the
request, please contact support for
assistance.
applications, including
${ApplicationExecutable}, are not installed
on ${MachineName} in Pool ${PoolId}
VMware, Inc.13
View Integration
Tabl e 2-4. Connection Broker Events (Continued)
EventTypeSeverityModuleAndEventText
BROKER_APPLICATION_NOT_ENTITLEDAUDIT_FAILUnable to launch from Pool ${PoolId} for
License Inventory monitoring was disabled
as all Hosts have desktop licenses
server ${VCAddress}
${VCAddress}
Event Message Attributes
Tab le 2-7 shows the attributes that ModuleAndEventText messages use. To determine the data type of an
attribute, you can examine the value of the Type column in the event_data or event_data_historical table.
Tabl e 2-7. Attributes Used with ModuleAndEventText Messages
Attribute NameDescription
AdminFolderNameName of a folder requiring privileged access.
AdminPermissionEntityName of an object requiring privileged access.
AdminPrivilegeNameName of an administrative privilege.
AdminRoleNameName of an administrative role.
AdminRoleNewNameNew name of an administrative role.
AttrChangeTypeType of change that was applied to a generic attribute.
AttrNameName of a generic attribute.
AttrValueValue of a generic attribute.
BrokerIdIdentifier of a View Connection Server instance.
BrokerNameName of a View Connection Server instance.
DesktopDisplayNameDisplay name of a desktop pool.
DesktopIdIdentifier of a desktop pool.
26VMware, Inc.
Chapter 2 Integrating with the Event Database
Tabl e 2-7. Attributes Used with ModuleAndEventText Messages (Continued)
Attribute NameDescription
EntitlementDisplayDisplay name of a desktop entitlement.
MachineIdIdentifier of a physical or virtual machine.
MachineNameName of a physical or virtual machine.
MaintenanceModeMaintenance mode state.
ObjectIDIdentifier of an inventory object.
ObjectTypeType of an inventory object.
PolicyDisplayNameDisplay name of a policy.
PolicyObjectIdentifier of a policy object.
PolicyValueValue of a policy object.
ProtocolIdIdentifier of a display protocol.
SecurityServerIdIdentifier of a security server.
SVIAdminFqdnFQDN of a QuickPrep domain.
SVIAdminIDIdentifier of a QuickPrep domain.
SVIAdminNameName of a QuickPrep domain.
SVIDeploymentGroupIDIdentifier of a View Composer deployment group.
SVIOperationName of a View Composer operation.
SVIParentVMParent virtual machine in View Composer.
SVIPathPath of an object in View Composer.
SVISnapshotSnapshot in View Composer.
SVIVMIDIdentifier of a virtual machine in View Composer.
ThinAppDisplayNameDisplay name of a ThinApp object.
ThinAppIdIdentifier of a ThinApp object.
ThinAppRepositoryNameName of a ThinApp repository.
ThinAppRepositoryPathPath of a ThinApp repository.
TimeDate and time value.
UserCountMaximum number of desktop users over a 24-hour period.
UserDiskNameName of a user data disk.
UserDisplayNameUser name in the form DOMAIN\username.
UserNameName of a user in Active Directory.
VCAddressURL of a vCenter Server.
VMware, Inc.27
View Integration
Sample Database Queries and Views
NOTE Replace the dbo.VE_ prefix in the examples with the appropriate prefix for your event database server.
Display all error events from the event_historical table.
CREATE VIEW error_events AS
(
SELECT ev.EventID, ev.Time, ev.Module, ev.EventType, ev.ModuleAndEventText
FROM dbo.VE_event_historical AS ev
WHERE ev.Severity = ‘ERROR’
);
Display all warning events from the event_historical table.
CREATE VIEW warning_events AS
(
SELECT ev.EventID, ev.Time, ev.Module, ev.EventType, ev.ModuleAndEventText
FROM dbo.VE_event_historical AS ev
WHERE ev.Severity = ‘WARNING’
);
List all recent events that are associated with the user fred in the domain MYDOM.
CREATE VIEW user_fred_events AS
(
SELECT ev.EventID, ev.Time, ev.Module, ev.EventType, ev.Severity, ev.Acknowledged
FROM dbo.VE_event_historical AS ev,
dbo.VE_event_data_historical AS ed
WHERE ev.EventID = ed.EventID AND ed.Name = 'UserDisplayName' AND ed.StrValue =
);
List all recent events where the agent on a machine shut down.
‘MYDOM\fred’
CREATE VIEW agent_shutdown_events AS
(
SELECT ev.EventID, ev.Time, ed.StrValue
FROM dbo.VE_event_historical AS ev,
WHERE ev.EventID = ed.EventID AND ev.EventType = ‘AGENT_SHUTDOWN’ AND
);
dbo.VE_event_data_historical AS ed
ed.Name = ‘MachineName’
List all recent events where a desktop failed to launch because the desktop pool was empty.
CREATE VIEW desktop_launch_failure_events AS
(
SELECT ev.EventID, ev.Time, ed1.StrValue, ed2.StrValue
FROM dbo.VE_event_historical AS ev,
dbo.VE_event_data_historical AS ed1,
dbo.VE_event_data_historical AS ed2
WHERE ev.EventID = ed1.EventID AND ev.EventID = ed2.EventID AND
ev.EventType = ‘BROKER_POOL_EMPTY’ AND
ed1.Name = ‘UserDisplayName’ AND ed2.Name = ‘DesktopId’
);
List all recent events where an administrator removed a desktop pool.
CREATE VIEW desktop_pool_removed_events AS
(
SELECT ev.EventID, ev.Time, ed1.StrValue, ed2.StrValue
FROM dbo.VE_event_historical AS ev,
WHERE ev.EventID = ed1.EventID AND ev.EventID = ed2.EventID AND
);
dbo.VE_event_data_historical AS ed1,
dbo.VE_event_data_historical AS ed2
ev.EventType = ‘ADMIN_DESKTOP_REMOVED’ AND
ed1.Name = ‘UserDisplayName’ AND ed2.Name = ‘DesktopId’
28VMware, Inc.
Loading...
+ 64 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.