View45 Integration Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 70

VMware View Integration Guide

View 4.5
View Manager 4.5
View Composer 2.5

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-000376-00
VMware View Integration Guide

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:
[email protected] 

Copyright © 2010 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. VMware products are covered by one or more patents listed at
http://www.vmware.com/go/patents.
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

2 VMware, Inc.
Contents

About This Book 5

1 Introduction 7
VMware View Components 7
Integration Interfaces to VMware View 8

2 Integrating with the Event Database 9
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

3 Using View PowerCLI 29
Introduction to View PowerCLI 29
Start the PowerShell Console with View PowerCLI Loaded 29
Displaying Help for a View PowerCLI cmdlet 30
Error When Piping and Specifying Objects at the Same Time 30
Escaping Characters in vCenter Pathnames 30
View PowerCLI Cmdlets 31
View Administrator, View PowerCLI Cmdlet, and vdmadmin Operations 33
View PowerCLI Cmdlet Parameters 35
Default Display Protocol Settings 35
Deletion Policy Settings 35
Flash Quality Settings 36
Flash Throttling Settings 36
LDAP Backup Frequency 36
Pool Type Settings 37
Power Policy Settings 37
Refresh Policy Settings 38
Smart Card Authentication Settings 38
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 41
Managing Local Desktops 42

VMware, Inc. 3
VMware View Integration Guide

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

4 Customizing LDAP Data 45
LDAP Configuration Data 45
Export LDAP Configuration Data 46
Modify LDAP Configuration Data 46
Import LDAP Configuration Data 49
Import LDAP Configuration Data Using the LDIFDE Command 50

5 Integrating with SCOM 51
View Management Packs 51
Name a View Connection Server Group 52
Import the View MPs 52
View Discovery Script 52
Run the Discovery Script 53
Display Discovered Objects 53
Display Managed Objects 53
Views and Monitors 53
Performance Data Collection Settings 55
Enable a Proxy Agent on a Server 55
Display Performance Data 56
Display Information About an Alert 56
Restart a Service 56
Exclude a Domain from Connectivity Monitoring 56
Close Alerts 57
Class and Relationship Definitions 57

Index 61

4 VMware, 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 Technical Publications Glossary


VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions 
of terms as they are used in VMware technical documentation go to http://www.vmware.com/support/pubs.

Document Feedback
VMware welcomes your suggestions for improving our documentation. If you have comments, send your 
feedback to [email protected]

Technical Support and Education Resources


The following sections describe the technical support resources available to you. To access the current version 
of this book and other books, go to http://www.vmware.com/support/pubs.

Online and Telephone Support


To use online support to submit technical support requests, view your product and contract information, and 
register your products, go to http://www.vmware.com/support.

Customers with appropriate support contracts should use telephone support for the fastest response on 
priority 1 issues. Go to http://www.vmware.com/support/phone_support.

Support Offerings
To find out how VMware support offerings can help meet your business needs, go to 
http://www.vmware.com/support/services.

VMware, Inc. 5
VMware View Integration Guide

VMware Professional Services


VMware Education Services courses offer extensive hands‐on labs, case study examples, and course materials 
designed to be used as on‐the‐job reference tools. Courses are available onsite, in the classroom, and live 
online. For onsite pilot programs and implementation best practices, VMware Consulting Services provides 
offerings to help you assess, plan, build, and manage your virtual environment. To access information about 
education classes, certification programs, and consulting services, go to http://www.vmware.com/services. 

6 VMware, Inc.
1

Introduction 1
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™ servers and deploy these desktops to end users. In addition, 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.

 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 VMware ESX servers 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 Guide

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.

8 VMware, Inc.
2

Integrating with the Event Database 2


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

 “Event Message Attributes” on page 25
 “Sample Database Queries and Views” on page 27

Event Database Tables and Schemas


Table 2‐1 shows the tables that implement the event database in VMware View.

Table 2-1. Event Database Tables


Table Name Description

event Metadata and search optimization data for recent events.
event_data Data values for recent events.

event_data_historical Data values for all events.

event_historical Metadata 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 Guide 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 Guide

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 Guide for more information.

NOTE   It 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.

Table 2‐2 shows the schema for the event and event_historical tables.

Table 2-2. Schema for the event and event_historical Tables


Oracle SQLServer
Column Name Data Type Data Type Description
Acknowledged SMALLINT tinyint Whether VMware View acknowledged the 
event.
0 = false
1 = true

DesktopId NVARCHAR2(512) nvarchar(512) Desktop ID of the associated pool.

EventID INTEGER int Unique primary key for the event.


EventType NVARCHAR2(512) nvarchar(512) Event name that corresponds to an item in 
the message catalog. For example, 
BROKER_USERLOGGEDIN.

FolderPath NVARCHAR2(512) nvarchar(512) Full path of the folder that contains the 


associated object.

GroupId NVARCHAR2(512) nvarchar(512) SID of the associated group in Active 


Directory.

LUNId NVARCHAR2(512) nvarchar(512) ID of the LUN that stores the associated 


object.

MachineId NVARCHAR2(512) nvarchar(512) ID of the associated physical or virtual 


machine.

Module NVARCHAR2(512) nvarchar(512) View component that raised the event. For 


example, Admin, Broker, Tunnel, 
Framework, Client, or Agent.

ModuleAndEventText NVARCHAR2(512) nvarchar(512) Event message with values substituted for 


attribute parameters.

Node NVARCHAR2(512) nvarchar(512) Name of the virtual device node.

Severity NVARCHAR2(512) nvarchar(512) Severity level. For example, INFO, 


WARNING, ERROR, AUDIT_SUCCESS, 
AUDIT_FAIL.

Source NVARCHAR2(512) nvarchar(512) Identifier for the source of the event.

ThinAppId NVARCHAR2(512) nvarchar(512) ID of the associated ThinApp™ object.

Time TIMESTAMP datetime Time at which the event occurred, 


measured from the epoch (January 1, 1970).

UserDiskPathId NVARCHAR2(512) nvarchar(512) ID of the user disk.

UserSID NVARCHAR2(512) nvarchar(512) SID of the associated user in Active 


Directory.

10 VMware, Inc.
Chapter 2 Integrating with the Event Database

Table 2‐3 shows the schema for the event_data and event_data_historical tables.

Table 2-3. Schema for the event_data and event_data_historical Tables


Oracle SQLServer
Column Name Data Type Data Type Description

BooleanValue SMALLINT tinyint Value of a Boolean attribute.


0 = false
1 = true

EventID INTEGER int Unique primary key for the event.

IntValue INTEGER int Value of an integer attribute.

Name NVARCHAR2(512) nvarchar(512) Attribute name (for example, 


UserDisplayName).

StrValue NVARCHAR2(512) nvarchar(512) Value of a string attribute. For other types 


of attributes, this column contains an 
interpretation of the data type as a string.

TimeValue TIMESTAMP datetime Value of a date and time attribute.

Type SMALLINT tinyint The data type of the attribute.


0 = StrValue
1 = IntValue
2 = TimeValue
3 = BooleanValue

Connection Broker Events


Table 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.

Table 2-4. Connection Broker Events


EventType Severity ModuleAndEventText

BROKER_AGENT_OFFLINE WARNING The agent running on machine 


${MachineName} has not responded to 
queries, marking it as offline

BROKER_AGENT_ONLINE WARNING The agent running on machine 


${MachineName} is responding again, but 
did not send a startup message

BROKER_DAILY_MAX_USERS INFO ${Time}: Over the past 24 hours, the 


maximum number of users with 
concurrent desktop sessions was 
${UserCount}

BROKER_DESKTOP_LAUNCH_FAILURE ERROR Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: The broker 
encountered an error while processing the 
request, please contact support for 
assistance

BROKER_DESKTOP_NOT_ENTITLED AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: User is not 
entitled to this Pool

VMware, Inc. 11
VMware View Integration Guide

Table 2-4. Connection Broker Events (Continued)


EventType Severity ModuleAndEventText

BROKER_DESKTOP_PROTOCOL_NOT_ AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


SUPPORTED for user ${UserDisplayName}: Requested 
protocol ${ProtocolId} is not supported

BROKER_DESKTOP_REQUEST INFO User ${UserDisplayName} requested Pool 


${DesktopId}

BROKER_EVENT_HANDLING_STARTED INFO Broker ${BrokerName} has started 


handling events

BROKER_EVENT_HANDLING_STOPPED INFO ${BrokerName} has stopped handling 


events

BROKER_LOCALMODE_OLD_ANCHOR_ WARNING Old anchor snapshot deletion task failed 


DELETE_FAILURE for Machine ${MachineName}.  Error 
message: ${LocalModeMessage}

BROKER_LOCALMODE_OPERATION_AUDIT_ AUDIT_FAIL Local Mode Operation 


FAILURE ${LocalModeOperation} failed for Desktop 
${MachineName}, ID: ${DesktopId}.  Error 
message: ${LocalModeMessage}

BROKER_LOCALMODE_OPERATION_ ERROR Local Mode Operation 


FAILURE ${LocalModeOperation} failed for Desktop 
${MachineName}, ID: ${DesktopId}. Error 
message: ${LocalModeMessage}

BROKER_LOCALMODE_OPERATION_ AUDIT_SUCCESS ${LocalModeOperation} has completed for 


SUCCESS Desktop ${MachineName}, ID: 
${DesktopId}.
BROKER_MACHINE_ALLOCATED INFO User ${UserDisplayName} requested Pool 
${DesktopId}, allocated machine 
${MachineName}
BROKER_MACHINE_ASSIGNED_ AUDIT_FAIL Unable to launch from Pool ${DesktopId} 
UNAVAILABLE for user ${UserDisplayName}: Assigned 
machine ${MachineName} is unavailable

BROKER_MACHINE_CANNOT_CONNECT AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: Failed to 
connect to Machine ${MachineName} using 
${ProtocolId}

BROKER_MACHINE_CHECKEDOUT AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: VM 
${MachineName} is currently checked out 
on a client device

BROKER_MACHINE_CONFIGURED_VIDEO_ INFO Successfully configured video settings for 


SETTINGS Machine VM ${MachineName} in Pool 
${DesktopId}

BROKER_MACHINE_NOT_READY WARNING Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: Machine 
${MachineName} is not ready to accept 
connections
BROKER_MACHINE_OPERATION_DELETED INFO machine ${MachineName} has been 
deleted

BROKER_MACHINE_PROTOCOL_NOT_ AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


SUPPORTED for user ${UserDisplayName}: Machine 
${MachineName} does not support 
protocol ${ProtocolId}
BROKER_MACHINE_PROTOCOL_ AUDIT_FAIL Unable to launch from Pool ${DesktopId} 
UNAVAILABLE for user ${UserDisplayName}: Machine 
${MachineName} did not report protocol 
${ProtocolId} as ready

12 VMware, Inc.
Chapter 2 Integrating with the Event Database

Table 2-4. Connection Broker Events (Continued)


EventType Severity ModuleAndEventText

BROKER_MACHINE_REJECTED_SESSION WARNING Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: Machine 
${MachineName} rejected the start session 
request
BROKER_MACHINE_SESSION_TIMEDOUT WARNING Session for user ${UserDisplayName} 
timed out

BROKER_POOL_CANNOT_ASSIGN AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: There are no 
machines available to assign the user to

BROKER_POOL_EMPTY AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: The Desktop 
Pool is empty

BROKER_POOL_NO_MACHINE_ASSIGNED AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: No machine 
assigned to this user

BROKER_POOL_NO_RESPONSES AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: No 
machines in the Desktop Pool are 
responsive
BROKER_POOL_OVERLOADED AUDIT_FAIL Unable to launch from Pool ${DesktopId} 
for user ${UserDisplayName}: All 
responding machines are currently in use

BROKER_POOL_POLICY_VIOLATION AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: This 
Desktop Pool does not allow online 
sessions

BROKER_POOL_PROTOCOL_NOT_ AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


SUPPORTED for user ${UserDisplayName}: There were 
no machines available that support 
protocol ${ProtocolId}

BROKER_POOL_PROTOCOL_UNAVAILABLE AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: There were 
no machines available that reported 
protocol ${ProtocolId} as ready

BROKER_POOL_TUNNEL_NOT_SUPPORTED AUDIT_FAIL Unable to launch from Pool ${DesktopId} 


for user ${UserDisplayName}: Tunnelling 
is not supported for protocol ${ProtocolId}

BROKER_PROVISIONING_ERROR_CONFIG_ INFO The previously reported configuration 


CLEARED problem is no longer present on Pool 
${DesktopId}

BROKER_PROVISIONING_ERROR_CONFIG_ ERROR Provisioning error occurred on Pool 


SET ${DesktopId} because of a configuration 
problem

BROKER_PROVISIONING_ERROR_DISK_ INFO The previously reported disk problem is no 


CLEARED longer present on Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_DISK_LC_ INFO The previously reported error due to 


RESERVATION_CLEARED available free disk space reserved for linked 
clones is no longer present on Pool 
${DesktopId}

BROKER_PROVISIONING_ERROR_DISK_LC_ ERROR Provisioning error occurred on Pool 


RESERVATION_SET ${DesktopId} because available free disk 
space is reserved for linked clones

BROKER_PROVISIONING_ERROR_DISK_SET WARNING Provisioning error occurred on Pool 


${DesktopId} because of a disk problem

VMware, Inc. 13
VMware View Integration Guide

Table 2-4. Connection Broker Events (Continued)


EventType Severity ModuleAndEventText

BROKER_PROVISIONING_ERROR_LICENCE_ INFO The previously reported licencing problem 


CLEARED is no longer present on Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_LICENCE_ ERROR Provisioning error occurred on Pool 


SET ${DesktopId} because of a licencing 
problem

BROKER_PROVISIONING_ERROR_ INFO The previously reported networking 


NETWORKING_CLEARED problems with a View Agent are no longer 
present on Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_ ERROR Provisioning error occurred on Pool 


NETWORKING_SET ${DesktopId} because of a networking 
problem with a View Agent

BROKER_PROVISIONING_ERROR_RESOURCE_ INFO The previously reported resource problem 


CLEARED is no longer present on Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_RESOURCE_ ERROR Provisioning error occurred on Pool 


SET ${DesktopId} because of a resource 
problem

BROKER_PROVISIONING_ERROR_TIMEOUT_ INFO The previously reported timeout while 


CUSTOMIZATION_CLEARED customizing is no longer present on Pool 
${DesktopId}
BROKER_PROVISIONING_ERROR_TIMEOUT_ ERROR Provisioning error occurred on Pool 
CUSTOMIZATION_SET ${DesktopId} because of a timeout while 
customizing

BROKER_PROVISIONING_ERROR_VM_ ERROR Provisioning error occurred for Machine 


CLONING ${MachineName}: Cloning failed for 
Machine

BROKER_PROVISIONING_ERROR_VM_ ERROR Provisioning error occurred for Machine 


CUSTOMIZATION_ERROR ${MachineName}: Customization failed for 
Machine

BROKER_PROVISIONING_ERROR_VM_ ERROR Provisioning error occurred for Machine 


CUSTOMIZATION_NETWORKING ${MachineName}: Customization error due 
to no network communication between the 
View agent and Connection Server

BROKER_PROVISIONING_ERROR_VM_ ERROR Provisioning error occurred for Machine 


CUSTOMIZATION_TIMEOUT ${MachineName}: Customization 
operation timed out
BROKER_PROVISIONING_SVI_ERROR_ ERROR Provisioning error occurred for Machine 
COMPOSER_AGENT_INIT_FAILED ${MachineName}: View Composer agent 
initialization failed

BROKER_PROVISIONING_SVI_ERROR_ ERROR Provisioning error occurred for Machine 


RECONFIG_FAILED ${MachineName}: Reconfigure operation 
failed

BROKER_PROVISIONING_SVI_ERROR_REFIT_ ERROR Provisioning error occurred for Machine 


FAILED ${MachineName}: Refit operation 
${SVIOperation} failed

BROKER_PROVISIONING_SVI_ERROR_ ERROR Provisioning error occurred for Machine 


REMOVING_VM ${MachineName}: Unable to remove 
Machine from inventory

BROKER_PROVISIONING_VERIFICATION_ WARNING Provisioning verification failed for 


FAILED_USER_ASSIGNED Machine ${MachineName}: User is already 
assigned to a machine in Pool ${DesktopId}
BROKER_PROVISIONING_VERIFICATION_ WARNING Provisioning verification failed for 
FAILED_USER_CANNOT_BE_ASSIGNED Machine ${MachineName}: A user cannot 
be assigned because Pool ${DesktopId} is 
not persistent

14 VMware, Inc.
Chapter 2 Integrating with the Event Database

Table 2-4. Connection Broker Events (Continued)


EventType Severity ModuleAndEventText

BROKER_PROVISIONING_VERIFICATION_ WARNING Provisioning verification failed for 


FAILED_VMNAME_IN_USE Machine ${MachineName}: A machine 
already exists in Pool ${DesktopId} with 
name ${MachineName}
BROKER_SECURITY_SERVER_ADD_FAILED AUDIT_FAIL Failed to add security server 
${SecurityServerId}

BROKER_SECURITY_SERVER_ADD_FAILED_ AUDIT_FAIL Failed to add security server 


PASSWORD_EXPIRED ${SecurityServerId}, pairing password 
expired

BROKER_SECURITY_SERVER_ADD_FAILED_ AUDIT_FAIL Failed to add security server 


PASSWORD_INCORRECT ${SecurityServerId}, pairing password 
incorrect

BROKER_SECURITY_SERVER_ADD_FAILED_ AUDIT_FAIL Failed to add security server 


PASSWORD_NOT_SET ${SecurityServerId}, pairing password not 
set

BROKER_SECURITY_SERVER_ADDED AUDIT_SUCCESS Security server ${SecurityServerId} added

BROKER_SVI_ARCHIVE_UDD_FAILED AUDIT_FAIL Failed to archive user data disk 


${UserDiskName} to location ${SVIPath}

BROKER_SVI_ARCHIVE_UDD_SUCCEEDED AUDIT_SUCCESS Archived user data disk ${UserDiskName} 


to location ${SVIPath}

BROKER_SVI_ATTACH_UDD_FAILED AUDIT_FAIL Failed to attach user data disk 


${UserDiskName} to VM ${SVIVMID}

BROKER_SVI_ATTACH_UDD_SUCCEEDED AUDIT_SUCCESS Attached user data disk ${UserDiskName} 


to VM ${SVIVMID}

BROKER_SVI_DETACH_UDD_FAILED AUDIT_FAIL Failed to detach user data disk 


${UserDiskName} from VM ${SVIVMID}

BROKER_SVI_DETACH_UDD_SUCCEEDED AUDIT_SUCCESS Detached user data disk ${UserDiskName} 


from VM ${SVIVMID}

BROKER_USER_AUTHFAILED_ACCOUNT_ AUDIT_FAIL User ${UserDisplayName} failed to 


DISABLED authenticate because the account is 
disabled

BROKER_USER_AUTHFAILED_ACCOUNT_ AUDIT_FAIL User ${UserDisplayName} failed to 


EXPIRED authenticate because the account has 
expired

BROKER_USER_AUTHFAILED_ACCOUNT_ AUDIT_FAIL User ${UserDisplayName} failed to 


LOCKED_OUT authenticate because the account is locked 
out

BROKER_USER_AUTHFAILED_ACCOUNT_ AUDIT_FAIL User ${UserDisplayName} failed to 


RESTRICTION authenticate because of an account 
restriction

BROKER_USER_AUTHFAILED_BAD_USER_ AUDIT_FAIL User ${UserDisplayName} failed to 


PASSWORD authenticate because of a bad username or 
password

BROKER_USER_AUTHFAILED_GENERAL AUDIT_FAIL User ${UserDisplayName} failed to 


authenticate

BROKER_USER_AUTHFAILED_NO_LOGON_ AUDIT_FAIL User ${UserDisplayName} failed to 


SERVERS authenticate because there are no logon 
servers

BROKER_USER_AUTHFAILED_PASSWORD_ AUDIT_FAIL User ${UserDisplayName} failed to 


EXPIRED authenticate because the password has 
expired

VMware, Inc. 15
VMware View Integration Guide

Table 2-4. Connection Broker Events (Continued)


EventType Severity ModuleAndEventText

BROKER_USER_AUTHFAILED_PASSWORD_ AUDIT_FAIL User ${UserDisplayName} failed to 


MUST_CHANGE authenticate because the password must 
change

BROKER_USER_AUTHFAILED_SECUREID_ AUDIT_FAIL SecurID access denied for user 


ACCESS_DENIED ${UserDisplayName}

BROKER_USER_AUTHFAILED_SECUREID_ AUDIT_FAIL SecurID access denied for user 


NEWPIN_REJECTED ${UserDisplayName} because new pin was 
rejected

BROKER_USER_AUTHFAILED_SECUREID_ AUDIT_FAIL SecurID access denied for user 


WRONG_NEXTTOKEN ${UserDisplayName} because wrong next 
token entered

BROKER_USER_AUTHFAILED_SECUREID_ AUDIT_FAIL SecurID access denied for user 


WRONG_STATE ${UserDisplayName} because of incorrect 
state

BROKER_USER_AUTHFAILED_TIME_ AUDIT_FAIL User ${UserDisplayName} failed to 


RESTRICTION authenticate because of a time restriction

BROKER_USER_NOT_AUTHORIZED AUDIT_FAIL User ${UserDisplayName} has 


authenticated, but is not authorized to 
perform the operation
BROKER_USER_NOT_ENTITLED AUDIT_FAIL User ${UserDisplayName} has 
authenticated, but is not entitled to any 
Pools

BROKER_USERCHANGEDPASSWORD AUDIT_SUCCESS Password for ${UserDisplayName} has 


been changed by the user

BROKER_USERLOGGEDIN AUDIT_SUCCESS User ${UserDisplayName} has logged in

BROKER_USERLOGGEDOUT AUDIT_SUCCESS User ${UserDisplayName} has logged out

BROKER_VC_DISABLED INFO vCenter at address ${VCAddress} has been 


temporarily disabled

BROKER_VC_ENABLED INFO vCenter at address ${VCAddress} has been 


enabled

BROKER_VC_STATUS_CHANGED_CANNOT_ WARNING Cannot log in to vCenter at address 


LOGIN ${VCAddress}
BROKER_VC_STATUS_CHANGED_DOWN INFO vCenter at address ${VCAddress} is down

BROKER_VC_STATUS_CHANGED_INVALID_ WARNING vCenter at address ${VCAddress} has 


CREDENTIALS invalid credientials

BROKER_VC_STATUS_CHANGED_NOT_YET_ INFO Not yet connected to vCenter at address 


CONNECTED ${VCAddress}

BROKER_VC_STATUS_CHANGED_ INFO Reconnecting to vCenter at address 


RECONNECTING ${VCAddress}

BROKER_VC_STATUS_CHANGED_UNKNOWN WARNING The status of vCenter at address 


${VCAddress} is unknown

BROKER_VC_STATUS_CHANGED_UP INFO vCenter at address ${VCAddress} is up

MULTIPLE_DESKTOPS_FOR_KIOSK_USER WARNING User ${UserDisplayName} is entitled to 


multiple desktop pools

16 VMware, Inc.
Chapter 2 Integrating with the Event Database

View Agent Events


Table 2‐5 shows the event types for View Agent.

Table 2-5. View Agent Events


EventType Severity ModuleAndEventText

AGENT_CONNECTED INFO User ${UserDisplayName} has logged in to a new session on 


machine ${MachineName}

AGENT_DISCONNECTED INFO User ${UserDisplayName} has disconnected from machine 


${MachineName}

AGENT_ENDED INFO User ${UserDisplayName} has logged off machine 


${MachineName}

AGENT_PENDING INFO The agent running on machine ${MachineName} has accepted an 


allocated session for user ${UserDisplayName}

AGENT_PENDING_ WARNING The pending session on machine ${MachineName} for user 


EXPIRED ${UserDisplayName} has expired

AGENT_RECONFIGURED INFO Machine ${MachineName} has been successfully reconfigured

AGENT_RECONNECTED INFO User ${UserDisplayName} has reconnected to machine 


${MachineName}

AGENT_RESUME INFO The agent on machine ${MachineName} sent a resume message

AGENT_SHUTDOWN INFO The agent running on machine ${MachineName} has shut down, 


this machine will be unavailable

AGENT_STARTUP INFO The agent running on machine ${MachineName} has contacted the 


connection server and sent a startup message

AGENT_SUSPEND INFO The agent on machine ${MachineName} sent a suspend message

View Administrator Events


Table 2‐6 shows the event types for View Administrator.

Table 2-6. View Administrator Events


EventType Severity ModuleAndEventText

ADMIN_ADD_DESKTOP_ENTITLEMENT AUDIT_SUCCESS ${EntitlementDisplay} was entitled to Pool 


${DesktopId} by ${UserDisplayName}
ADMIN_ADD_LICENSE AUDIT_SUCCESS ${UserDisplayName} added license

ADMIN_ADD_LICENSE_FAILED AUDIT_FAIL ${UserDisplayName} failed to add license

ADMIN_ADD_PM AUDIT_SUCCESS ${UserDisplayName} added physical 


machine ${MachineName} to Pool  
${DesktopId}

ADMIN_ADD_PM_FAILED AUDIT_FAIL ${UserDisplayName} failed to add physical 


machine ${MachineName} to Pool  
${DesktopId}

ADMIN_ADD_THINAPP_ENTITLEMENT AUDIT_SUCCESS Application ${ThinAppDisplayName} was 


assigned to Desktop ${MachineName} by 
${UserDisplayName}

ADMIN_ADD_THINAPP_ENTITLEMENT_ AUDIT_FAIL ${UserDisplayName} failed to add 


FAILED Application entitlement

ADMIN_ADD_THINAPP_POOL_ AUDIT_SUCCESS Application ${ThinAppDisplayName} was 


ENTITLEMENT assigned to Pool ${DesktopId} by 
${UserDisplayName}

ADMIN_ADMINSTRATOR_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove all 


permissions for Administrator 
${AdminPermissionEntity}

VMware, Inc. 17
VMware View Integration Guide

Table 2-6. View Administrator Events (Continued)


EventType Severity ModuleAndEventText

ADMIN_ADMINSTRATOR_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed all 


permissions for Administrator 
${AdminPermissionEntity}

ADMIN_CONFIGURE_TRANSFER_SERVER_ INFO Configure a local Transfer Server 


LOCAL_REPO Repository. Path ${PathName}

ADMIN_CONFIGURE_TRANSFER_SERVER_ INFO Configure a network Transfer Server 


NETWORK_REPO Repository. Path: ${PathName}, domain: 
${DomainName}, user name 
${DomainUser}

ADMIN_CONNECTION_BROKER_UPDATE_ AUDIT_FAIL ${UserDisplayName} failed to update 


FAILED connection broker ${BrokerId}

ADMIN_CONNECTION_BROKER_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated connection 


broker ${BrokerId}: (${AttrChangeType}: 
${AttrName} = ${AttrValue})

ADMIN_CONNECTION_SERVER_BACKUP_ AUDIT_FAIL ${UserDisplayName} failed to initiate a 


FAILED backup of connection broker ${BrokerId}
ADMIN_CONNECTION_SERVER_BACKUP_ AUDIT_SUCCESS ${UserDisplayName} initiated a backup of 
INITIATED connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_DISABLE_ AUDIT_FAIL ${UserDisplayName} failed to disable 


FAILED connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_DISABLED AUDIT_SUCCESS ${UserDisplayName} is disabling 


connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_ENABLE_ AUDIT_FAIL ${UserDisplayName} failed to enable 


FAILED connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_ENABLED AUDIT_SUCCESS ${UserDisplayName} is enabling 


connection broker ${BrokerId}
ADMIN_DATABASE_CONFIGURATION_ADD_ AUDIT_FAIL ${UserDisplayName} failed to add 
FAILED database configuration

ADMIN_DATABASE_CONFIGURATION_ AUDIT_SUCCESS ${UserDisplayName} has added database 


ADDED configuration

ADMIN_DATABASE_CONFIGURATION_ AUDIT_FAIL ${UserDisplayName} failed to delete 


DELETE_FAILED database configuration

ADMIN_DATABASE_CONFIGURATION_ AUDIT_SUCCESS ${UserDisplayName} has deleted database 


DELETE_FAILED configuration

ADMIN_DATABASE_CONFIGURATION_ AUDIT_FAIL ${UserDisplayName} failed to update 


UPDATE_FAILED database configuration

ADMIN_DATABASE_CONFIGURATION_ AUDIT_SUCCESS ${UserDisplayName} has updated 


UPDATED database configuration

ADMIN_DEFAULT_DESKTOPPOOL_ASSIGN AUDIT_SUCCESS ${UserDisplayName} assigned Pool 


${DesktopId} for default desktop to 
${UserName}
ADMIN_DEFAULT_DESKTOPPOOL_ASSIGN_ AUDIT_FAIL ${UserDisplayName} failed to assign Pool 
FAILED ${DesktopId} for default desktop to 
${UserName}

ADMIN_DEFAULT_DESKTOPPOOL_ AUDIT_SUCCESS ${UserDisplayName} removed pool 


UNASSIGN assignment for default desktop to 
${UserName}

ADMIN_DEFAULT_DESKTOPPOOL_ AUDIT_FAIL ${UserDisplayName} failed to remove Pool 


UNASSIGN_FAILED assignment for default desktop to 
${UserName}

ADMIN_DELETE_PACKAGE INFO Delete transfer package ${PackageName}

18 VMware, Inc.
Chapter 2 Integrating with the Event Database

Table 2-6. View Administrator Events (Continued)


EventType Severity ModuleAndEventText

ADMIN_DESKTOP_ADDED AUDIT_SUCCESS ${UserDisplayName} added Pool 


${DesktopId}

ADMIN_DESKTOP_ASSIGN AUDIT_SUCCESS ${UserDisplayName} assigned Desktop 


${MachineName} to ${UserName}

ADMIN_DESKTOP_ASSIGN_FAILED AUDIT_FAIL ${UserDisplayName} failed to assign 


Desktop ${MachineName} to ${UserName}

ADMIN_DESKTOP_EDITED AUDIT_SUCCESS ${UserDisplayName} edited Pool 


${DesktopId} (${AttrChangeType}: 
${AttrName} = ${AttrValue})

ADMIN_DESKTOP_MAINTENANCE_MODE_ AUDIT_FAIL ${UserDisplayName} failed to update 


UPDATE_FAILED desktop ${MachineName} to 
${MaintenanceMode} maintenance mode

ADMIN_DESKTOP_MAINTENANCE_MODE_ AUDIT_SUCCESS ${UserDisplayName} updated desktop 


UPDATED ${MachineName} to ${MaintenanceMode} 
maintenance mode

ADMIN_DESKTOP_UNASSIGN AUDIT_SUCCESS ${UserDisplayName} removed assignment 


for Desktop ${MachineName}

ADMIN_DESKTOP_UNASSIGN_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove 


assignment for Desktop ${MachineName}

ADMIN_ENABLE_DESKTOP_FAILED AUDIT_FAIL ${UserDisplayName} failed to set Pool 


${DesktopId} to ${EnableStatus}

ADMIN_ENABLE_DESKTOP_SUCCEEDED AUDIT_SUCCESS ${UserDisplayName} set Pool ${DesktopId} 


to ${EnableStatus}
ADMIN_ENABLED_DESKTOP_PROVISION_ AUDIT_FAIL ${UserDisplayName} failed to set 
FAILED provisioning for Pool ${DesktopId} to 
${EnableStatus}
ADMIN_ENABLED_DESKTOP_PROVISION_ AUDIT_SUCCESS ${UserDisplayName} set provisioning for 
SUCCEEDED Pool ${DesktopId} to ${EnableStatus}

ADMIN_EVENT_CONFIGURATION_UPDATE_ AUDIT_FAIL ${UserDisplayName} failed to update 


FAILED event configuration

ADMIN_EVENT_CONFIGURATION_UPDATED AUDIT_SUCCESS ${UserDisplayName} has updated global 


configuration
ADMIN_FOLDER_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add folder 
${AdminFolderName}

ADMIN_FOLDER_ADDED AUDIT_SUCCESS ${UserDisplayName} added folder 


${AdminFolderName}

ADMIN_FOLDER_CHANGE_FAILED AUDIT_FAIL ${UserDisplayName} failed to change 


object ${ObjectID}(type=${ObjectType}) to 
folder ${AdminFolderName}

ADMIN_FOLDER_CHANGED AUDIT_SUCCESS ${UserDisplayName} changed object 


${ObjectID}(type=${ObjectType}) to folder 
${AdminFolderName}

ADMIN_FOLDER_DELETE_FAILED AUDIT_FAIL ${UserDisplayName} failed to delete folder 


${AdminFolderName}

ADMIN_FOLDER_DELETED AUDIT_SUCCESS ${UserDisplayName} deleted folder 


${AdminFolderName}

ADMIN_GLOBAL_CONFIGURATION_ AUDIT_FAIL ${UserDisplayName} failed to update 


UPDATE_FAILED global configuration

ADMIN_GLOBAL_CONFIGURATION_ AUDIT_SUCCESS ${UserDisplayName} updated global 


UPDATED configuration (${AttrChangeType}: 
${AttrName} = ${AttrValue})

VMware, Inc. 19
VMware View Integration Guide

Table 2-6. View Administrator Events (Continued)


EventType Severity ModuleAndEventText

ADMIN_GLOBAL_POLICY_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update 


global policies

ADMIN_GLOBAL_POLICY_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated global 


policy (${AttrChangeType}: ${AttrName} = 
${AttrValue})

ADMIN_LOCALMODE_INITIATE_ INFO Inititate replication for Machine 


REPLICATION ${MachineName}

ADMIN_LOCALMODE_LOCK_MACHINE INFO Lock Machine ${MachineName} on 


vCenter

ADMIN_LOCALMODE_LOCK_MACHINE_ WARNING Lock Machine ${MachineName} failed on 


FAILED vCenter

ADMIN_LOCALMODE_ROLLBACK_DESKTOP INFO Machine ${MachineName} has been rolled 


back

ADMIN_LOCALMODE_UNLOCK_MACHINE INFO Unlock Machine ${MachineName} on 


vCenter

ADMIN_LOCALMODE_UNLOCK_MACHINE_ WARNING Unlock Machine ${MachineName} failed 


FAILED on vCenter

ADMIN_PERFMON_CONFIGURATION_ AUDIT_FAIL ${UserDisplayName} failed to update 


UPDATE_FAILED performance monitoring configuration

ADMIN_PERFMON_CONFIGURATION_ AUDIT_SUCCESS ${UserDisplayName} has updated 


UPDATED performance monitoring configuration

ADMIN_PERMISSION_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add 


Permission to ${AdminPermissionEntity} 
with Role ${AdminRoleName} on Folder 
${AdminFolderName}

ADMIN_PERMISSION_ADDED AUDIT_SUCCESS ${UserDisplayName} added Permission to 


${AdminPermissionEntity} with Role 
${AdminRoleName} on Folder 
${AdminFolderName}

ADMIN_PERMISSION_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove 


Permission to ${AdminPermissionEntity} 
with Role ${AdminRoleName} on Folder 
${AdminFolderName}

ADMIN_PERMISSION_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed Permission 


to ${AdminPermissionEntity} with Role 
${AdminRoleName} on Folder 
${AdminFolderName}

ADMIN_POOL_POLICY_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update Pool 


${DesktopId} policies

ADMIN_POOL_POLICY_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated Pool 


${DesktopId} policy (${AttrChangeType}: 
${AttrName} = ${AttrValue})

ADMIN_PUBLISH_PACKAGE INFO Publish transfer package ${PackageName}

ADMIN_REMOVE_DESKTOP_ENTITLEMENT AUDIT_SUCCESS ${EntitlementDisplay} was unentitled from 


Pool ${DesktopId} by ${UserDisplayName}

ADMIN_REMOVE_DESKTOP_FAILED AUDIT_FAIL ${UserDisplayName} failed to removed 


Pool ${DesktopId}

ADMIN_REMOVE_DESKTOP_SUCCEEDED AUDIT_SUCCESS ${UserDisplayName} removed Pool 


${DesktopId}

ADMIN_REMOVE_THINAPP_ENTITLEMENT AUDIT_SUCCESS Application ${ThinAppDisplayName} was 


unassigned from Desktop 
${MachineName} by ${UserDisplayName}

20 VMware, Inc.
Chapter 2 Integrating with the Event Database

Table 2-6. View Administrator Events (Continued)


EventType Severity ModuleAndEventText

ADMIN_REMOVE_THINAPP_ENTITLEMENT_ AUDIT_FAIL ${UserDisplayName} failed to remove 


FAILED Application entitlement

ADMIN_REMOVE_THINAPP_POOL_ AUDIT_SUCCESS Application ${ThinAppDisplayName} was 


ENTITLEMENT unassigned from Pool ${DesktopId} by 
${UserDisplayName}

ADMIN_RESET_THINAPP_STATE AUDIT_SUCCESS Application ${ThinAppDisplayName} 


state are reset for Desktop 
${DesktopDisplayName} by 
${UserDisplayName}

ADMIN_RESET_THINAPP_STATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to reset 


Application state for 
${ThinAppDisplayName}

ADMIN_ROLE_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add Role 


${AdminRoleName} with privileges 
${AdminPrivilegeName}

ADMIN_ROLE_ADDED AUDIT_SUCCESS ${UserDisplayName} added Role 


${AdminRoleName} with privileges 
${AdminPrivilegeName}

ADMIN_ROLE_PRIV_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update Role 


${AdminRoleName} to privileges 
${AdminPrivilegeName}

ADMIN_ROLE_PRIV_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated Role 


${AdminRoleName} to privileges 
${AdminPrivilegeName}

ADMIN_ROLE_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove Role 


${AdminRoleName}

ADMIN_ROLE_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed Role 


${AdminRoleName}

ADMIN_ROLE_RENAME_FAILED AUDIT_FAIL ${UserDisplayName} failed to rename Role 


${AdminRoleName} to 
${AdminRoleNewName}

ADMIN_ROLE_RENAMED AUDIT_SUCCESS ${UserDisplayName} renamed Role 


${AdminRoleName} to 
${AdminRoleNewName}

ADMIN_SECURITY_SERVER_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add security 


server ${SecurityServerId}

ADMIN_SECURITY_SERVER_ADDED AUDIT_SUCCESS ${UserDisplayName} added security server 


${SecurityServerId}
ADMIN_SECURITY_SERVER_EDIT_FAILED AUDIT_FAIL ${UserDisplayName} failed to edit security 
server ${SecurityServerId}

ADMIN_SECURITY_SERVER_EDITED AUDIT_SUCCESS ${UserDisplayName} edited security server 


${SecurityServerId} (${AttrChangeType}: 
${AttrName} = ${AttrValue})

ADMIN_SECURITY_SERVER_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove 


security server ${SecurityServerId}

ADMIN_SECURITY_SERVER_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed security 


server ${SecurityServerId}
ADMIN_SESSION_SENDMSG AUDIT_SUCCESS ${UserDisplayName} sent message 
(${SessionMessage}) to session (User 
${UserName}, Desktop ${MachineName})
ADMIN_SESSION_SENDMSG_FAILED AUDIT_FAIL ${UserDisplayName} failed to send 
message (${SessionMessage}) to session 
${ObjectId}

VMware, Inc. 21
VMware View Integration Guide

Table 2-6. View Administrator Events (Continued)


EventType Severity ModuleAndEventText

ADMIN_SVI_ADD_DEPLOYMENT_GROUP_ AUDIT_FAIL Failed to add deployment group for 


FAILED ${SVIParentVM} : ${SVISnapshot}

ADMIN_SVI_ADD_DEPLOYMENT_GROUP_ AUDIT_SUCCESS Added deployment group 


SUCCEEDED ${SVIDeploymentGroupID} for 
${SVIParentVM} : ${SVISnapshot}

ADMIN_SVI_ADD_UDD_FAILED AUDIT_FAIL Failed to add user data disk 


${UserDiskName}

ADMIN_SVI_ADD_UDD_SUCCEEDED AUDIT_SUCCESS Added user data disk ${UserDiskName}

ADMIN_SVI_ADMIN_ADDED AUDIT_SUCCESS ${UserDisplayName} added SVI 


QuickPrep domain 
${SVIAdminFqdn}(${SVIAdminName})

ADMIN_SVI_ADMIN_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed SVI 


QuickPrep domain (id=${SVIAdminID})

ADMIN_SVI_ADMIN_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated SVI 


QuickPrep domain 
${SVIAdminFqdn}(${SVIAdminName})
ADMIN_SVI_ATTACH_UDD_FAILED AUDIT_FAIL Failed to request attach user data disk 
${UserDiskName} to VM ${SVIVMID}

ADMIN_SVI_ATTACH_UDD_SUCCEEDED AUDIT_SUCCESS Requested attach user data disk 


${UserDiskName} to VM ${SVIVMID}

ADMIN_SVI_DELETE_UDD_FAILED AUDIT_FAIL Failed to delete user data disk 


${UserDiskName}

ADMIN_SVI_DELETE_UDD_SUCCEEDED AUDIT_SUCCESS Deleted user data disk ${UserDiskName}


ADMIN_SVI_DETACH_UDD_FAILED AUDIT_FAIL Failed to request detach user data disk 
${UserDiskName} from VM ${SVIVMID}

ADMIN_SVI_DETACH_UDD_SUCCEEDED AUDIT_SUCCESS Requested detach user data disk 


${UserDiskName} from VM ${SVIVMID}

ADMIN_SVI_REBALANCE_VM_FAILED AUDIT_FAIL Failed to rebalance VM ${SVIVMID}

ADMIN_SVI_REBALANCE_VM_SUCCEEDED AUDIT_SUCCESS Rebalanced VM ${SVIVMID}


ADMIN_SVI_REFRESH_VM_FAILED AUDIT_FAIL Failed to refresh VM ${SVIVMID}

ADMIN_SVI_REFRESH_VM_SUCCEEDED AUDIT_SUCCESS Refreshed VM ${SVIVMID}

ADMIN_SVI_RESYNC_VM_FAILED AUDIT_FAIL Failed to resync VM ${SVIVMID} to 


deployment group 
${SVIDeploymentGroupID}

ADMIN_SVI_RESYNC_VM_SUCCEEDED AUDIT_SUCCESS Resyncd VM ${SVIVMID} to deployment 


group ${SVIDeploymentGroupID}

ADMIN_SVI_UPDATE_POOL_DEPLOYMENT_ AUDIT_FAIL Failed to update pool ${DesktopId} to 


GROUP_FAILED deployment group 
${SVIDeploymentGroupID}

ADMIN_SVI_UPDATE_POOL_DEPLOYMENT_ AUDIT_SUCCESS Updated pool ${DesktopId} to deployment 


GROUP_SUCCEEDED group ${SVIDeploymentGroupID}
ADMIN_SVI_UPDATE_UDD_FAILED AUDIT_FAIL Failed to update user data disk 
${UserDiskName}

ADMIN_SVI_UPDATE_UDD_SUCCEEDED AUDIT_SUCCESS Set user data disk ${UserDiskName} pool 


to ${DesktopId} and user to ${UserName}

ADMIN_THINAPP_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add 


Application ${ThinAppDisplayName}

ADMIN_THINAPP_ADDED AUDIT_SUCCESS ${UserDisplayName} added Application 


${ThinAppDisplayName}

22 VMware, Inc.
Chapter 2 Integrating with the Event Database

Table 2-6. View Administrator Events (Continued)


EventType Severity ModuleAndEventText

ADMIN_THINAPP_DESKTOP_AVAILABLE AUDIT_SUCCESS Application ${ThinAppDisplayName} is 


now available on Desktop 
${DesktopDisplayName}

ADMIN_THINAPP_DESKTOP_REMOVED AUDIT_SUCCESS Application ${ThinAppDisplayName} has 


been removed from Desktop 
${DesktopDisplayName}

ADMIN_THINAPP_EDITED AUDIT_SUCCESS ${UserDisplayName} edited Application 


${ThinAppDisplayName}

ADMIN_THINAPP_FAILED_DESKTOP_ AUDIT_FAIL Failed to deliver Application 


DELIVERY ${ThinAppDisplayName} to Desktop 
${DesktopDisplayName}

ADMIN_THINAPP_FAILED_DESKTOP_ AUDIT_FAIL Failed to remove Application 


REMOVAL ${ThinAppDisplayName} from Desktop 
${DesktopDisplayName}

ADMIN_THINAPP_GROUP_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add 


Application Template 
${ThinAppGroupName}

ADMIN_THINAPP_GROUP_ADDED AUDIT_SUCCESS ${UserDisplayName} added Application 


Template ${ThinAppGroupName} with 
Applications 
${ThinAppGroupApplications}

ADMIN_THINAPP_GROUP_EDIT_FAILED AUDIT_FAIL ${UserDisplayName} failed to edit 


Application Template 
${ThinAppGroupName}

ADMIN_THINAPP_GROUP_EDITED AUDIT_SUCCESS ${UserDisplayName} edited Application 


Template ${ThinAppGroupName} with 
Applications 
${ThinAppGroupApplications}

ADMIN_THINAPP_GROUP_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove 


Application Template 
${ThinAppGroupName}

ADMIN_THINAPP_GROUP_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed Application 


Template ${ThinAppGroupName}

ADMIN_THINAPP_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove 


Application ${ThinAppDisplayName}

ADMIN_THINAPP_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed Application 


${ThinAppDisplayName}

ADMIN_THINAPP_REPO_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add 


Repository ${ThinAppRepositoryName}, 
path ${ThinAppRepositoryPath}

ADMIN_THINAPP_REPO_ADDED AUDIT_SUCCESS ${UserDisplayName} added Repository 


${ThinAppRepositoryName}, path 
${ThinAppRepositoryPath}

ADMIN_THINAPP_REPO_EDIT_FAILED AUDIT_FAIL ${UserDisplayName} failed to edit 


Repository ${ThinAppRepositoryName}, 
path ${ThinAppRepositoryPath}

ADMIN_THINAPP_REPO_EDITED AUDIT_SUCCESS ${UserDisplayName} edited Repository 


${ThinAppRepositoryName}, path 
${ThinAppRepositoryPath}

ADMIN_THINAPP_REPO_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed Repository 


${ThinAppRepositoryName}

ADMIN_TRANSFER_SERVER_ADDED AUDIT_SUCCESS ${UserDisplayName} added transfer server 


${TransferServerDisplay}

VMware, Inc. 23
VMware View Integration Guide

Table 2-6. View Administrator Events (Continued)


EventType Severity ModuleAndEventText

ADMIN_TRANSFER_SERVER_ENTER_ AUDIT_SUCCESS Transfer server ${TransferServerDisplay} 


MAINTENANCE enters maintenance mode

ADMIN_TRANSFER_SERVER_EXIT_ AUDIT_SUCCESS Transfer server ${TransferServerDisplay} 


MAINTENANCE exits maintenance mode

ADMIN_TRANSFER_SERVER_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed transfer 


server ${TransferServerDisplay}

ADMIN_UNREGISTER_PM AUDIT_SUCCESS ${UserDisplayName} unregistered 


physical machine ${MachineName})

ADMIN_UNREGISTER_PM_FAILED AUDIT_FAIL ${UserDisplayName} fails to unregister 


physical machine ${MachineName})

ADMIN_USER_INFO_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update user 


info with AD server for ${UserName}

ADMIN_USER_INFO_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated user info 


with AD server for ${UserName}

ADMIN_USER_POLICY_DELETE_FAILED AUDIT_FAIL ${UserDisplayName} failed to delete Pool 


${DesktopId} override policies for user 
${UserName}

ADMIN_USER_POLICY_DELETED AUDIT_SUCCESS ${UserDisplayName} deleted Pool 


${DesktopId} override policy for user 
${UserName} (${AttrChangeType}: 
${AttrName} = ${AttrValue})

ADMIN_USER_POLICY_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update Pool 


${DesktopId} policies for user 
${UserName}

ADMIN_USER_POLICY_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated Pool 


${DesktopId} policy for user ${UserName} 
(${AttrChangeType}: ${AttrName} = 
${AttrValue})

ADMIN_USERLOGGEDIN AUDIT_SUCCESS User ${UserDisplayName} has logged in to 


View Administrator

ADMIN_USERLOGGEDOUT AUDIT_SUCCESS User ${UserDisplayName} has logged out 


from View Administrator

ADMIN_VC_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add VC 


server ${VCAddress}

ADMIN_VC_ADDED AUDIT_SUCCESS ${UserDisplayName} added VC server 


${VCAddress}

ADMIN_VC_EDITED AUDIT_SUCCESS ${UserDisplayName} edited VC server 


${VCAddress} (${AttrChangeType}: 
${AttrName} = ${AttrValue})

ADMIN_VC_LICINV_ALARM_DISABLED AUDIT_SUCCESS Alarm on VC server ${VCAddress} for 


License Inventory monitoring was disabled 
as all Hosts have desktop licenses 

ADMIN_VC_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove VC 


server ${VCAddress}

ADMIN_VC_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed VC server 


${VCAddress}

24 VMware, Inc.
Chapter 2 Integrating with the Event Database

View Transfer Server Events


Table 2‐7 shows the event types for View Transfer Server.

Table 2-7. View Transfer Server Events


EventType Severity ModuleAndEventText

TRANSFER_SERVER_PACKAGE_ WARNING Transfer package ${PackageName} was not 


DISPLACEMENT published on current Transfer Server 
Repository

TRANSFER_SERVER_PACKAGE_MISSING WARNING Transfer package ${PackageName} was 


missing on current Transfer Server 
Repository

TRANSFER_SERVER_PACKAGE_RECOVERY INFO Transfer package ${PackageName} 


recovered

TRANSFER_SERVER_PUBLISH_PACKAGE_ ERROR Failed to publish transfer package 


FAILURE ${PackageName} on TransferServer 
${TransferServerDisplay}

TRANSFER_SERVER_REAPER_FAILED ERROR Failed to clean up disk ${DiskPath} on 


TransferServer ${TransferServerDisplay}
TRANSFER_SERVER_STATE_CHANGED INFO TransferServer ${TransferServerDisplay} 
state has changed from 
${TransferServerOldState} to 
${TransferServerNewState} on 
${TransferServerStateInput}.

Event Message Attributes


Table 2‐8 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.

Table 2-8. Attributes Used with ModuleAndEventText Messages


Attribute Name Description
AdminFolderName Name of a folder requiring privileged access.

AdminPermissionEntity Name of an object requiring privileged access.

AdminPrivilegeName Name of an administrative privilege.
AdminRoleName Name of an administrative role.

AdminRoleNewName New name of an administrative role.

AttrChangeType Type of change that was applied to a generic attribute.

AttrName Name of a generic attribute.

AttrValue Value of a generic attribute.

BrokerId Identifier of a View Connection Server instance.

BrokerName Name of a View Connection Server instance.

DesktopDisplayName Display name of a desktop pool.

DesktopId Identifier of a desktop pool.

DiskPath Path of a View Transfer Server package.

DomainName Domain name for a remote View Transfer Server repository.

DomainUser User name with access to a remote View Transfer Server repository.

EntitlementDisplay Display name of a desktop entitlement.

LocalModeMessage Message for a local desktop operation.

LocalModeOperation Name of a local desktop operation.

VMware, Inc. 25
VMware View Integration Guide

Table 2-8. Attributes Used with ModuleAndEventText Messages (Continued)


Attribute Name Description

MachineId Identifier of a physical or virtual machine.

MachineName Name of a physical or virtual machine.

MaintenanceMode Maintenance mode state.

ObjectID Identifier of an inventory object.

ObjectType Type of an inventory object.

PackageName Name of a View Transfer Server package.

PathName Path of a View Transfer Server repository.

PolicyDisplayName Display name of a policy.

PolicyObject Identifier of a policy object.

PolicyValue Value of a policy object.

ProtocolId Identifier of a display protocol.

SecurityServerId Identifier of a security server.

SVIAdminFqdn FQDN of a QuickPrep domain.
SVIAdminID Identifier of a QuickPrep domain.

SVIAdminName Name of a QuickPrep domain. 

SVIDeploymentGroupID Identifier of a View Composer deployment group.

SVIOperation Name of a View Composer operation.

SVIParentVM Parent virtual machine in View Composer.

SVIPath Path of an object in View Composer.

SVISnapshot Snapshot in View Composer.

SVIVMID Identifier of a virtual machine in View Composer.

ThinAppDisplayName Display name of a ThinApp object.

ThinAppId Identifier of a ThinApp object.
ThinAppRepositoryName Name of a ThinApp repository.

ThinAppRepositoryPath Path of a ThinApp repository.

Time Date and time value.

TransferServerDisplay Display name of View Transfer Server.

TransferServerNewState Current state of View Transfer Server.

TransferServerOldState Previous state of View Transfer Server.
TransferServerStateInput Input event causing a View Transfer Server to change state.

UserCount Maximum number of desktop users over a 24‐hour period.

UserDiskName Name of a user data disk.

UserDisplayName User name in the form DOMAIN\username.

UserName Name of a user in Active Directory.

VCAddress URL of a vCenter Server.

26 VMware, Inc.
Chapter 2 Integrating with the Event Database

Sample Database Queries and Views


List all recent events that are associated with the user fred in the domain MYDOM.
CREATE VIEW user_events AS
(
SELECT ev.EventID, ev.Time, ev.Module, ev.EventType, ev.Severity, ev.Acknowledged
FROM ViewEvents.dbo.VE_event_historical AS ev,
ViewEvents.dbo.VE_event_data_historical AS ed
WHERE ev.EventID = ed.EventID AND ed.Name = 'UserDisplayName' AND ed.StrValue =
‘MYDOM\fred’
);

List all recent events where the agent on a machine shut down.
CREATE VIEW agent_shutdown_events AS
(
SELECT ev.EventID, ev.Time, ed.StrValue
FROM ViewEvents.dbo.VE_event_historical AS ev,
ViewEvents.dbo.VE_event_data_historical AS ed
WHERE ev.EventID = ed.EventID AND ev.EventType = ‘AGENT_SHUTDOWN’ AND
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 ViewEvents.dbo.VE_event_historical AS ev,
ViewEvents.dbo.VE_event_data_historical AS ed1,
ViewEvents.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 ViewEvents.dbo.VE_event_historical AS ev,
ViewEvents.dbo.VE_event_data_historical AS ed1,
ViewEvents.dbo.VE_event_data_historical AS ed2
WHERE ev.EventID = ed1.EventID AND ev.EventID = ed2.EventID AND
ev.EventType = ‘ADMIN_DESKTOP_REMOVED’ AND
ed1.Name = ‘UserDisplayName’ AND ed2.Name = ‘DesktopId’
);

List all recent events where an administrator added a ThinApp repository.
CREATE VIEW thinapp_repository_added_events AS
(
SELECT ev.EventID, ev.Time, ed1.StrValue, ed2.StrValue, ed3.StrValue
FROM ViewEvents.dbo.VE_event_historical AS ev,
ViewEvents.dbo.VE_event_data_historical AS ed1,
ViewEvents.dbo.VE_event_data_historical AS ed2,
ViewEvents.dbo.VE_event_data_historical AS ed3
WHERE ev.EventID = ed1.EventID AND ev.EventID = ed2.EventID AND ev.EventID = ed3.EventID
AND
ev.EventType = ‘ADMIN_THINAPP_REPO_ADDED’ AND
ed1.Name = ‘UserDisplayName’ AND ed2.Name = ‘ThinAppRepositoryName’ AND
ed3.Name = ‘ThinAppRepositoryPath’
);

VMware, Inc. 27
VMware View Integration Guide

28 VMware, Inc.
3

Using View PowerCLI 3


View PowerCLI provides an easy‐to‐use PowerShell interface to VMware View. You can use the View 
PowerCLI cmdlets to perform various administration tasks on View components.

This chapter includes the following topics:

 “Introduction to View PowerCLI” on page 29

 “View PowerCLI Cmdlets” on page 31

 “View PowerCLI Cmdlet Parameters” on page 35

 “Examples of Using View PowerCLI Cmdlets” on page 39

Introduction to View PowerCLI


Windows PowerShell is a command‐line and scripting environment that is designed for Microsoft Windows. 
PowerShell uses the .NET object model and provides administrators with management and automation 
capabilities. As with any other console environment, you work with PowerShell by running commands, which 
are called cmdlets in PowerShell.

VMware View 4.5 includes 45 View PowerCLI cmdlets. You can use these cmdlets in conjunction with the 
vSphere PowerCLI cmdlets, which provide an administrative interface to the VMware vSphere product. You 
can also use the View PowerCLI cmdlets to examine the configuration of vCenter Servers in VMware View.

The command‐line syntax for the View PowerCLI cmdlets is the same as generic PowerShell syntax. See the 
Microsoft documentation for more information about using PowerShell.

The View PowerCLI cmdlets are located in the PowershellServiceCmdlets.dll file in the directory 
C:\Program Files\VMware\VMware View\Server\bin. This file constitutes the VMware.View.Broker 
snapin. The script configuration file for the View PowerCLI cmdlets is named InitViewCmdlets.ps1, and 
this file is located in the Extras folder in the View installation directory. You can edit and extend the script to 
define cmdlet aliases, to configure the environment, or to set startup actions.

Start the PowerShell Console with View PowerCLI Loaded


You can run the View PowerCLI cmdlets directly on a View Connections Server host that has the following 
software installed.

 VMware View 4.5 or later
 Microsoft .NET framework

 Windows PowerShell 1.0

To use the View PowerCLI cmdlets to change the configuration of View, you must be logged into a View 
Connection Server instance as a user in a role with sufficient privileges, such as the Administrators role. If your 
role is a read‐only role, you cannot update configuration data. For more information, see the VMware View 
Administrator’s Guide.

VMware, Inc. 29
VMware View Integration Guide

To start the PowerShell console with View PowerCLI loaded

1 Select Start > All Programs > VMware > View PowerCLI.

2 If you see an error message stating that the script configuration file cannot be loaded because the 
execution of scripts is disabled, type the following PowerShell command and restart the PowerShell 
console.

Set-ExecutionPolicy Unrestricted

Displaying Help for a View PowerCLI cmdlet


To list all View PowerCLI cmdlets, type this command in the PowerShell console.

Get-Command -PSSnapin VMware.View.Broker | more

You can get help for a specific cmdlet by using the Get-Help cmdlet in the PowerShell console. For example, 
to get help on the Add-ViewVC cmdlet.

Get-Help Add-ViewVC | more

For more detailed information, add the -full parameter.

Get-Help Add-ViewVC -full | more

Alternatively, you can use the help alias for Get-Help.

help Add-ViewVC -full | more

Error When Piping and Specifying Objects at the Same Time


If you attempt to pipe an object into a cmdlet and specify an object of the same type to that cmdlet, the cmdlet 
fails with the following error.
The input object cannot be bound to any parameters for the command either because the command
does not take pipeline input or the input and its properties do not match any of the parameters
that take pipeline input.

For example, the following cmdlet usage would produce this error.
Get-Pool -pool_id Pool1 | Update-ManualPool -pool_id Pool2 -displayName “Manual Pool 2”

Escaping Characters in vCenter Pathnames


If you specify a path to a vCenter folder that includes certain special characters in the name of an entity, you 
must escape these characters. Table 3‐1 shows the escape sequences for special characters.

Table 3-1. Escape Sequences for Special Characters


Special Character Escape Sequence

% %25

/ %2f

\ %5c

Do not escape the slashes in the pathname itself. For example, you would represent the path to the folder 
/datacenter_01/vm/img%-12 as /datacenter_01/vm/img%25-12.

30 VMware, Inc.
Chapter 3 Using View PowerCLI

Table 3‐2 lists the cmdlets and parameters that require you to use escape sequences in entity names.

Table 3-2. Cmdlet Parameters Requiring Escape Sequences


Cmdlet Parameters Requiring Escape Sequences

Add-AutomaticLinkedClonePool -datastoreSpecs
Update-AutomaticLinkedClonePool -parentVMPath
-resourcePoolPath
-vmfolderPath

Add-AutomaticPool -datastorePaths
Update-AutomaticPool -resourcePoolPath
-templatePath
-vmfolderPath

Send-LinkedCloneRecompose -parentVMPath

View PowerCLI Cmdlets


You can use View PowerCLI cmdlets to administer VMware View on a View Connection Server instance. You 
can use the Get-Help cmdlet to obtain more help about a View PowerCLI cmdlet as described in “Displaying 
Help for a View PowerCLI cmdlet” on page 30.

Table 3‐3 lists the available View PowerCLI cmdlets ordered by noun.

Table 3-3. View PowerCLI Cmdlets Ordered by Noun


Cmdlet Description

Add-AutomaticLinkedClonePool Adds an automatically provisioned linked‐clone desktop pool.
Update-AutomaticLinkedClonePool Updates an automatically provisioned linked‐clone desktop pool.

Add-AutomaticPool Adds an automatically provisioned full virtual machine desktop pool.

Update-AutomaticPool Updates an automatically provisioned full virtual machine desktop pool.
Get-ComposerDomain Returns information about View Composer.

Get-ConnectionBroker Returns information about View Connection Server and security server 
instances.
Update-ConnectionBroker Updates the configuration of a View Connection Server or security server 
instance.

Get-DesktopPhysicalMachine Returns a list of physical machines that are available for use with 
unmanaged desktop pools.

Get-DesktopVM Returns information about virtual machines.

Get-EventReport Returns an event report for a specified view.

Get-EventReportList Returns the views that are available for use with the Get-EventReport 
cmdlet.

Get-GlobalSetting Returns global configuration information about the VMware View 
environment.

Update-GlobalSetting Updates global configuration information about the VMware View 
environment.

Get-License Returns the VMware View licenses on a View Connection Server instance.

Set-License Sets a VMware View license on a View Connection Server instance.

Send-LinkedCloneRebalance Rebalances linked‐clone desktops among the available logical drives.

Send-LinkedCloneRecompose Recomposes linked‐clone desktops from a snapshot of their parent virtual 
machine.

Send-LinkedCloneRefresh Refreshes the operating system disks of linked‐clone desktops to their 
original state and size.

Get-LocalSession Returns information about local desktops.

VMware, Inc. 31
VMware View Integration Guide

Table 3-3. View PowerCLI Cmdlets Ordered by Noun (Continued)


Cmdlet Description

Send-LocalSessionRollback Rolls back a local desktop.

Add-ManualPool Adds a manually provisioned pool of managed desktops.

Update-ManualPool Updates a manually provisioned pool of managed desktops.

Add-ManualUnmanagedPool Adds a manually provisioned pool of unmanaged desktops.

Update-ManualUnmanagedPool Updates a manually provisioned pool of unmanaged desktops.

Get-Monitor Returns a list of health monitors for View services.

Get-Pool Returns information about desktop pools.

Remove-Pool Removes a desktop pool.

Add-PoolEntitlement Creates desktop pool entitlements for users.

Get-PoolEntitlement Returns information about the users who are entitled to use desktop pools.

Remove-PoolEntitlement Removes desktop pool entitlement from users.

Get-ProfileDisk Returns information about persistent user data disks.

Get-RemoteSession Returns information about active remote sessions.
Send-SessionDisconnect Disconnects an active remote session.

Send-SessionLogoff Logs out an active remote session.

Get-TerminalServer Returns information about registered Terminal Servers.

Add-TerminalServerPool Adds a desktop pool from Terminal Server sources.

Update-TerminalServerPool Updates a desktop pool that has Terminal Server sources.

Get-User Returns information about users.

Remove-UserOwnership Removes the ownership of a virtual machine.
Update-UserOwnership Assigns a user (specified as a SID) to a virtual machine. This cmdlet does 
not support the assignment of users to physical machines.

Add-ViewVC Adds a vCenter Server to VMware View.
Get-ViewVC Returns information about vCenter Servers.

Remove-ViewVC Removes a vCenter Server from VMware View.

Update-ViewVC Updates the configuration of a vCenter Server in VMware View.
Send-VMReset Resets a virtual machine.

32 VMware, Inc.
Chapter 3 Using View PowerCLI

View Administrator, View PowerCLI Cmdlet, and vdmadmin Operations


Table 3‐4 compares the operations that are supported by View Administrator, View PowerCLI cmdlets, and 
the vdmadmin command on various View objects. For information about View Administrator and the 
vdmadmin command, see the VMware View Administrator’s Guide.

Table 3-4. View Administrator, View PowerCLI Cmdlet, and vdmadmin Operations
View Administrator View PowerCLI Cmdlet vdmadmin Command
Object Operations Operations Operations

Desktop pool Add Add


Assign dedicated
Assign ThinApp
Disable Disable
Enable Enable
Entitle user Entitle user
Get information Get information
Get unentitled policies Get unentitled policies
Get unentitled users Get unentitled users
Remove Remove
Remove assignment
Remove entitlement Remove entitlement
Restrict entitlement
Set policy Set policy
Update Update

Domain filter Get information
Remove filter
Set filter

Events Get list Get list Get list


Get report Get report

Folder Add
Get information
Move
Remove
Kiosk mode Add client account
Disable authentication
Enable authentication
Get information
Get defaults
Remove client account
Set defaults

Linked‐clone desktop Rebalance Rebalance


Recompose Recompose
Recreate
Refresh Refresh
Restore
Set storage overcommit Set storage overcommit

Local desktop Decrypt virtual machine
Get information Get information
Lock checked‐out
Roll back Roll back
Unlock checked‐out

Permission Add
Get information
Remove

VMware, Inc. 33
VMware View Integration Guide

Table 3-4. View Administrator, View PowerCLI Cmdlet, and vdmadmin Operations (Continued)
View Administrator View PowerCLI Cmdlet vdmadmin Command
Object Operations Operations Operations
Persistent user data disk Attach
Delete
Detach
Get information Get information
Replace

Physical computer (with View Agent) Get information Get information Get information

Remote session Disconnect Disconnect


Get information Get information
Log out Log out

Role Add
Modify
Remove

Terminal Server Get information Get information

User Configure policy
Create administrator
Get information Get information Get information
Remove administrator
Update FSP

vCenter Server Add Add


Get information Get information
Remove Remove
Update Update

View Agent Create DCT bundle
Get copy of log file
Get list of log files
Get logging level
Get status
Get version
Override IP address
Set logging level

View Composer domain Get information

View Connection Server Back up configuration
Get information Get information
Remove from group
Restore configuration
Update Update

View Connection Server group Get GUID of group
Set name of group

View Global Setting Get information Get information


Update Update

View service health monitor Get information Get information Get information

34 VMware, Inc.
Chapter 3 Using View PowerCLI

Table 3-4. View Administrator, View PowerCLI Cmdlet, and vdmadmin Operations (Continued)
View Administrator View PowerCLI Cmdlet vdmadmin Command
Object Operations Operations Operations
View Transfer Server Add
Configure repository
Get information
Get state
Lock virtual machine
Migrate repository
Remove
Replicate local desktop
Set maintenance mode
Unlock virtual machine

View Transfer Server package Add
Remove
Get split limit
Get status
Publish
Set path to repository
Set split limit

Virtual machine (with View Agent) Get information Get information Get information


Remove ownership Remove ownership
Reset Reset
Update ownership Update ownership

VMware View license Get information Get information


Set license Set license

View PowerCLI Cmdlet Parameters


Some View PowerCLI cmdlet parameters accept arguments that are chosen from a limited set.

Default Display Protocol Settings


Table 3‐5 shows the settings that you can use with the -defaultProtocol parameter to specify the default 
display protocol for a desktop pool.

Table 3-5. Default Display Protocol Settings


Default Display Protocol Description

PCOIP Specifies VMware PCoIP.

RDP Specifies Microsoft RDP.

RGS Specifies HP RGS (where applicable).

Deletion Policy Settings


Table 3‐6 shows the settings that you can use with the -deletePolicy parameter to specify a deletion policy 
for automatically provisioned floating and linked‐clone desktop pools.

Table 3-6. Deletion Policy Settings


Deletion Policy Description
Default Specifies that the desktop is not deleted when the user logs out.

DeleteOnUse Specifies that the desktop is deleted when the user logs out.

RefreshOnUse Specifies that the desktop is refreshed when the user logs out. This setting 
applies only to linked‐clone desktop pools.

VMware, Inc. 35
VMware View Integration Guide

Flash Quality Settings


Table 3‐7 shows the settings that you can use with the -flashQuality parameter to specify a maximum 
allowable quality for Adobe Flash content. This value overrides the setting on a Web page. If the Flash quality 
for a Web page is higher than the maximum value allowed, the client reduces the quality to the specified 
maximum. Lowering the quality of Flash content causes it to use less bandwidth.

Table 3-7. Flash Quality Settings


Flash Quality Description

HIGH Specifies that low, medium, or high quality Flash content is allowed.

LOW Specifies that only low quality Flash content is allowed.

MEDIUM Specifies that low or medium quality Flash content is allowed.

NO_CONTROL Allows the Web page settings to determine quality.

Flash Throttling Settings


Table 3‐8 shows the settings that you can use with the -flashThrottling parameter to specify how often 
Adobe Flash should refresh what it shows onscreen. Throttling Flash to increase the refresh interval reduces 
the frame rate. This reduction causes Flash content to use less bandwidth, but it might also cause Flash to drop 
frames.

Table 3-8. Flash Throttling Settings


Flash Throttling Description
AGGRESSIVE Sets the interval to 2500 milliseconds. This results in the highest number of 
dropped frames. The speed of audio transmission is unaffected.

CONSERVATIVE Sets the interval to 100 milliseconds. This results in the lowest number of 
dropped frames. The speed of audio transmission is unaffected.

DISABLED Disables Flash content entirely including the audio component.

MODERATE Sets the interval to 500 milliseconds. The speed of audio transmission is 
unaffected.

LDAP Backup Frequency


Table 3‐9 shows the settings that you can use with the -ldapBackupFrequency parameter to specify the LDAP 
backup frequency for a View Connection Server instance.

Table 3-9. LDAP Backup Frequency Settings


LDAP Backup Frequency Description

Every12Hour Backs up the LDAP database once every 12 hours.

Every2Day Backs up the LDAP database once every two days.

Every2Week Backs up the LDAP database once every two weeks.

Every6Hour Backs up the LDAP database once every six hours.

EveryDay Backs up the LDAP database once per day.
EveryHour Backs up the LDAP database once per hour.

EveryWeek Backs up the LDAP database once per week.

Never Turns off backup for the LDAP database.

36 VMware, Inc.
Chapter 3 Using View PowerCLI

Pool Type Settings


Table 3‐10 shows the settings that you can use with the -poolType parameter to specify the type of a desktop 
pool.

Table 3-10. Pool Type Settings


Pool Type Description

IndividualUnmanaged Specifies a pool containing an individual unmanaged desktop.

IndividualVC Specifies a pool containing an individual desktop that is managed and configured 
by a vCenter Server.
Manual Specifies a pool of manually configured floating (nonpersistent) desktops that are 
managed and configured by a vCenter Server.

ManualUnmanagedNonPersistent Specifies a pool of manually configured floating (nonpersistent) desktops that are 
not managed.

ManualUnmanagedPersistent Specifies a pool of manually configured dedicated (persistent) desktops that are not 
managed.

ManualVCPersistent Specifies a pool of manually configured dedicated (persistent) desktops that are 
managed by a vCenter Server.

NonPersistent (AutomaticPool) Specifies a pool of automatically configured floating 
(nonpersistent) desktops that are provisioned, managed, and configured by a 
vCenter Server.

OnRequestSviNonPersistent (AutomaticPool) Specifies a pool of floating (nonpersistent) desktops that are 
provisioned, managed, and configured by a vCenter Server and View Composer 
when requested. 

OnRequestSviPersistent (AutomaticPool) Specifies a pool of dedicated (persistent) desktops that are 
provisioned, managed, and configured by a vCenter Server and View Composer 
when requested.

OnRequestVcNonPersistent (AutomaticPool) Specifies a pool of floating (nonpersistent) desktops that are 
provisioned, managed, and configured by a vCenter Server when requested.

OnRequestVcPersistent (AutomaticPool) Specifies a pool of dedicated (persistent) desktops that are 
provisioned, managed, and configured by a vCenter Server when requested.

Persistent (AutomaticPool) Specifies a pool of automatically configured dedicated (persistent) 
desktops that are provisioned, managed, and configured by a vCenter Server.

SVINonPersistent (AutomaticPool) Specifies a pool of floating (nonpersistent) desktops that are 
provisioned, managed, and configured by a vCenter Server and View Composer.
SVIPersistent (AutomaticPool) Specifies a pool of dedicated (persistent) desktops that are 
provisioned, managed, and configured by a vCenter Server and View Composer.

TerminalService Specifies a pool of desktops that are managed and configured by a terminal server.

TransferServer Specifies a pool of desktops that are managed and configured by a transfer server.

Power Policy Settings


Table 3‐11 shows the settings that you can use with the -powerPolicy parameter to specify the power policy 
for a desktop pool.

Table 3-11. Power Policy


Power Policy Setting Description

AlwaysOn Configures a desktop to remain powered on, even when no one is using it. If 
you shut down the desktop, it restarts immediately.

RemainOn Starts a desktop when required if it is powered down. The desktop then remains 
powered on until you shut it down.

PowerOff Shuts down a desktop when no one is using it.

Suspend Suspends a desktop when no one is using it.

VMware, Inc. 37
VMware View Integration Guide

Refresh Policy Settings


Table 3‐13 shows the settings that you can use with the -refreshPolicyType parameter to specify a refresh 
policy for the OS disks of automatically provisioned dedicated and linked‐clone desktop pools.

Table 3-12. Refresh Policy Settings


Refresh Policy Description

Always Specifies that an OS disk is always refreshed when the user logs out.

Conditional Specifies that an OS disk is refreshed when the user logs out if certain conditions 
are met. Use the -refreshpolicyDays and -refreshPolicyUsage 
parameters to specify the refresh interval in days and the percentage of the 
maximum allowable size for the disk.

Never Specifies that an OS disk is never refreshed when the user logs out.

Smart Card Authentication Settings


Table 3‐13 shows the settings that you can use with the -smartCardSetting parameter to specify how users 
with smart cards are authenticated. These settings apply to Update-ConnectionBroker, and do not have any 
effect unless you also specify -UseSSLClient $true with Update-GlobalSetting.

Table 3-13. Smart Card Authentication Settings


Refresh Policy Description

NotAllowed Specifies that smart card authentication is disabled.
Optional Specifies that users can use smart card authentication or password 
authentication to connect to the View Connection Server instance. If smart card 
authentication fails, the user must provide a password.
Required Specifies that users must use smart card authentication when connecting to the 
View Connection Server instance. Smart card authentication replaces Windows 
password authentication only. If SecureID is enabled, users are required to 
authenticate by using both SecureID and smart card authentication.

View Composer Maintenance Task Types


Table 3‐14 shows the settings that you can use with the -composerTask parameter to specify a View 
Composer maintenance task type that is scheduled on a virtual machine.

Table 3-14. View Composer Maintenance Task Types


Task Type Description

attachUdd Specifies a scheduled task to attach a persistent disk.

detachUdd Specifies a scheduled task to detach a persistent disk.

mkChkPoint Specifies a scheduled task to create a checkpoint snapshot.

rebalance Specifies a scheduled task to rebalance a linked‐clone desktop.

refresh Specifies a scheduled task to refresh a linked‐clone desktop.
replaceUdd Specifies a scheduled task to replace a persistent disk.

resync Specifies a scheduled task to recompose a linked‐clone desktop.

38 VMware, Inc.
Chapter 3 Using View PowerCLI

Examples of Using View PowerCLI Cmdlets


The View PowerCLI cmdlets allow you to perform View operations from the command line or from scripts 
instead of using View Administrator. The following sections contain examples that you can adapt and apply 
to your own systems.

Displaying Information About a View Connection Server Instance


Display the configuration settings of a View Connection Server instance.
Get-ConnectionBroker -displayName connsvr1

Updating the Configuration of a View Connection Server Instance


Update the settings for direct connections and secureID on a View Connection Server instance.
Update-ConnectionBroker -displayName connsvr1 -directConnect $false -secureIdEnabled $true
-ldapBackupFrequency EveryWeek

Managing the Configuration of vCenter Servers in VMware View


Add an entry for a vCenter Server to the View configuration.
Add-ViewVC -serverName vc01.mydom.int -username Administrator -password clydenw
-displayName "VC-01" -createRampFactor 5 -deleteRampFactor 5

Return information about a vCenter Server.
Get-ViewVC -serverName vc01.mydom.int

Return information about all vCenter Servers in a specified DNS domain.
Get-ViewVC -serverName *.mycorp.com

Change the values of the ramp factors for the vCenter Server that is configured on server svr11.
Get-ViewVC -serverName svr11.mycorp.com | Update-ViewVC -createRampFactor 5 -deleteRampFactor 10

Change the value of the create ramp factor for the vCenter Servers that are configured in the DNS domain 
mycorp.com.
Get-ViewVC -serverName *.mycorp.com | Update-ViewVC -createRampFactor 5

Remove an entry for a vCenter Server from the configuration.
Get-ViewVC -serverName vc02.mydom.int | Remove-ViewVC

Managing Desktop Pools


Return information about the desktop pool mypool.
Get-Pool -poolDisplayName mypool

Return information about all desktop pools with the prefix mypool‐.
Get-Pool -pool_id mypool-*

Return information about all desktop pools that are configured to use the PCoIP protocol.
Get-Pool -protocol PCOIP

Return information about all individual unmanaged desktop pools.
Get-Pool -poolType IndividualUnmanaged

Remove the desktop pool dtpool‐10.
Remove-Pool -pool_id dtpool-10

Remove the desktop pool dtpool‐12, terminating any active session, but without deleting the image from disk.
Remove-Pool -pool_id dtpool-12 -TerminateSession $true -DeleteFromDisk $false

VMware, Inc. 39
VMware View Integration Guide

Remove the desktop pool mydesktop, and delete its image from disk.
Get-Pool -pool_id mydesktop | Remove-Pool -DeleteFromDisk $true

Creating and Updating Automatically Provisioned Desktop Pools


Add the automatically provisioned desktop pool auto1, which is managed by the vCenter Server 
vc.mydom.int.
Get-ViewVC -serverName vc.mydom.int | Add-AutomaticPool -pool_id auto1 -displayName "ADP1"
-namePrefix "adp1-{n:fixed=4}" -vmFolderPath /AutoConfig/vm
-resourcePoolPath /AutoConfig/host/Resources -templatePath /AutoConfig/vm/ADP_template
-dataStorePaths /host/datastore_1/lun10 -customizationSpecName "Windows 7 Variation 3"
-minimumCount 4 -maximumCount 10

NOTE   To provision all the desktops in advance of their use, set -minimumCount and -maximumCount to the 
same value.

Update the configuration of the automatically provisioned desktop pool auto1.
Update-AutomaticPool -pool_id auto1 -displayName "Automatic Desktop Pool 1"
-isProvisioningEnabled $false -dataStorePaths /host/datastore_1/lun10;/host/datastore_1/lun12

The datastores that you specify as arguments to -datastorePaths override the previous setting. You must 
specify the existing datastores to retain them for use by the pool.

Creating and Updating Linked-Clone Desktop Pools


Add the linked‐clone desktop pool lcdpool_1, which is managed by View Composer on the vCenter Server 
vc.mydom.int.
Get-ViewVC -serverName vc.mydom.int | Get-ComposerDomain -domain VCDOM |
Add-AutomaticLinkedCLonePool -pool_id lcdpool_1 -displayName "LCD Pool 1"
-namePrefix "lcp1-{n}-dt" -parentVMPath /AutoPoolVMs/parent
-parentSnaphotPath /AutoPoolSnapshots/parent1_snapshot -vmFolderPath /AutoConfig/VM_folder
-resourcePoolPath /AutoConfig/host/Resources
-datastoreSpecs [Aggressive,os,data]/host/datastore_1/lun04;/host/datastore_2/lun16
-dataDiskLetter "D" -dataDiskSize 100 -minimumCount 4 -maximumCount 10

NOTE   To provision all the desktops in advance of their use, set -minimumCount and -maximumCount to the 
same value.

If you specify a persistent data disk, use an uppercase letter for the drive. Do not use a letter that already exists 
on the parent virtual machine for a drive such as A, B, or C, or that conflicts with a network‐mounted drive.

Update the configuration of the linked‐clone desktop pool lcdpool_1.
Get-ViewVC -serverName vc.mydom.int | Get-ComposerDomain -domain VCDOM |
Update-AutomaticLinkedCLonePool -pool_id lcdpool_1 -datastoreSpecs
[Conservative,os,data]/host/datastore_1/lun04;/host/datastore_2/lun16;/host/datastore_2/lun22
-minimumCount 4 -maximumCount 20 -headroomCount 2 -powerPolicy Suspend -defaultProtocol PCOIP
-isUserResetAllowed $true

The datastores that you specify as arguments to -datastoreSpecs override the previous setting. You must 
specify the existing datastores to retain them for use by the pool.

Rebalance desktops in the linked‐clone desktop pool lcdpool_2 among the available datastores.
Get-DesktopVM -pool_id lcdpool_2 | Send-LinkedCloneRebalance -schedule 2011-05-10:01:00:00
-forceLogoff $false -stopOnError $true

Refresh the operating system disk of each linked‐clone desktop by restoring it to its original state and size.
Get-DesktopVM -pool_id lcdpool_2 | Send-LinkedCloneRefresh -schedule "May 12 2011 01:15"
-forceLogoff $true -stopOnError $true

Recompose all linked‐clone desktops from a snapshot of their parent virtual machine.

40 VMware, Inc.
Chapter 3 Using View PowerCLI

Get-DesktopVM -pool_id lcdpool_2 | Send-LinkedCloneRecompose -schedule ((Get-Date).AddHours(8))


-parentVMPath /AutoPoolVMs/parent2 -parentSnapshotPath /AutoPoolSnapshots/parent2_snapshot
-forceLogoff $true -stopOnError $true

Creating and Updating Manually Provisioned Desktop Pools


Create the manually provisioned desktop pool man1 from the desktops listed by the vCenter Server 
vc.mydom.int.
Get-ViewVC -serverName vc.mydom.int | Get-DesktopVM | Add-ManualPool -pool_id man1
-isUserResetAllowed $true

Update the configuration of the manually provisioned desktop pool man1.
Update-ManualPool -pool_id man1 -displayName "Manual Desktop 1" -isUserResetAllowed $false

Creating Manual Unmanaged Desktop Pools


Create the unmanaged desktop pool unman1 that contains the physical machines pm01 and pm02.
Add-ManualUnmanagedPool -pool_id unman1 -pm_id_list pm01;pm02 -isUserResetAllowed $true

Update the configuration of the unmanaged desktop pool unman1.
Update-ManualUnmanagedPool -pool_id unman1 -displayName "Unmanaged Desktop 1"
-isUserResetAllowed $false

Creating and Updating Desktops Provisioned by Terminal Servers


Return information about a terminal server.
Get-TerminalServer -hostname tsvr01

Add the desktop pool tsd1 using a machine that is provided by the terminal server at a specified IP address.
Get-TerminalServer -hostname tsvr01 | Add-TerminalServerPool -id tsd1 -displayName "Terminal
Server Desktop 1" -allowProtocolOverride $true

Update the configuration of the desktop pool tsd1, which uses a machine provided by a terminal server.
Get-TerminalServer -hostname tsvr01 | Update-TerminalServerPool -id tsd1 -displayName "Terminal
Server Desktop 1" -allowProtocolOverride $false -autoLogoffTime 1

Obtaining Information About Users and Groups from Active Directory


Return information about users in the domain mydom.
Get-User -domain mydom

Return information about the user fred in the domain mydom and exclude any information about the user’s 
group.
Get-User -name fred -domain mydom -includeGroup $false

Managing Desktop Entitlements


Add an entitlement for the user fred in the domain mydom to use desktop pool dtop‐12.
Get-User -name mydom\fred | Add-PoolEntitlement -pool_id dtop-12

Add an entitlement to all desktop pools for a user specified by an SID.
Get-Pool | Add-PoolEntitlement -sid S-1-5-21-7623811015-3361044348-030300820-1512

Return information about all entitlements to desktop pools.
Get-PoolEntitlement

Return information about the users who are entitled to use desktop pool dtop‐1.
Get-PoolEntitlement -pool_id dtop-1

VMware, Inc. 41
VMware View Integration Guide

Return information about the users who are entitled to use desktop pools whose IDs start with dtpool‐.
Get-Pool -pool_id dtpool-* | Get-PoolEntitlement

Remove the entitlement to use desktop pool dtpool‐11.
Get-PoolEntitlement -pool_id dtpool-11 | Remove-PoolEntitlement

If you want to remove all entitlements from the system, specify the -forceRemove parameter set to $true .
Get-PoolEntitlement | Remove-PoolEntitlement -forceRemove $true

If you do not specify the-forceRemove parameter, you can use the command to find out information about 
the entitlements that would be removed.

Managing Local Desktops


Return information about the local desktop for the specified IP address.
Get-LocalSession -hostIP 10.20.54.65

Return information about the local desktops for a range of IP addresses.
Get-LocalSession -hostIP 10.20.222.*

Roll back the local desktop with a specified host IP address.
Get-LocalSession -host_ip 10.20.54.36 | Send-LocalSessionRollback

Roll back the local desktops for a range of host IP addresses.
Get-LocalSession -hostIP 10.20.222.* | Send-LocalSessionRollback

Roll back the local desktop with the virtual machine ID vmcn11.
Send-LocalSessionRollback -machine_id vmcn11

Managing Remote Sessions


Return the list of active remote sessions for the user fred in the domain mydom.
Get-RemoteSession -username mydom\fred

Disconnect the active remote sessions on which the user fred is logged in.
Get-RemoteSession -username mydom\fred | Send-SessionDisconnect

Log out the active remote sessions on which the user fred is logged in.
Get-RemoteSession -username mydom\fred | Send-SessionLogoff -session_id

Log out the active remote sessions that are using the RDP protocol.
Get-RemoteSession -protocol RDP | Send-SessionLogoff

Managing Virtual Machines

NOTE   View Agent must be running on the virtual machines.

Return information about the virtual machine for the desktop pool dtpool‐3.
Get-DesktopVM -pool_id dtpool-3

Return information about the virtual machines that are configured on the vCenter Server vc03.
Get-DesktopVM -vc_id vc03

Return information about the virtual machines that are managed by the same vCenter Server that provisions 
the desktop pool dtpool‐1.
Get-ViewVC -pool_id dtpool-1 | Get-DesktopVM

42 VMware, Inc.
Chapter 3 Using View PowerCLI

Return information about all virtual machines that are managed by the vCenter Server that is configured on 
the server vc01.mydom.int.
Get-ViewVC -serverName vc01.mydom.int | Get-DesktopVM

Return information about the virtual machines that are configured as manual desktop pools, and which are 
managed by vCenter Servers that are configured on servers in the DNS domain mycorp.com.
Get-ViewVC -serverName *.mycorp.com -DesktopType Manual | Get-DesktopVM

Return a list of active persistent user data disks for the virtual machine vm01.
Get-ProfileDisk -VMname vm01

Reset the virtual machines for the desktop pool dtpool‐05.
Get-Pool -pool_id dtpool-05 | Get-DesktopVM | Send-VMReset

Reset the virtual machine for the desktop pool with the display name dtp1.
Get-Pool -displayName dtp1 | Get-DesktopVM | Send-VMReset

Displaying Information About Physical Computers

NOTE   View Agent must be running on the computers.

Return information about the computer at a specified IP address.
Get-DesktopPhysicalMachine -hostname myhost01

Updating the Ownership of Machines


Update the ownership of the virtual machine vm04.
Update-UserOwenership -machine_id vm04 -sid S-1-5-21-7623811015-3361044348-030300820-1013

Remove the ownership of a virtual machine.
Remove-UserOwenership -machine_id vm22

Displaying Information About Events


Display the views that are available for reporting events.
Get-EventReportList

Display configuration change events that have occurred since the specified date.
Get-EventReport -viewName config_changes -startDate 2011-05-20:00:00:00

Display user events that occurred between two specified dates.
Get-EventReport -viewName user_events -startDate 2011-12-01:00:00:00 -endDate 2011-12-02:00:00:00

Display user events for the last 24 hours.
Get-EventReport -viewName user_events -startDate ((Get-Date).AddDays(-1))

Display user events for the current year.
Get-EventReport -viewName user_events -startDate (Get-Date -Day 01 -Month 01 -Hour 0 -Minute 0
-Second 0)

Managing the Global Configuration of VMware View


Display the global configuration settings.
Get-GlobalSetting

Set the session timeout to 30 minutes.
Update-GlobalSetting -SessionTimeout 30

VMware, Inc. 43
VMware View Integration Guide

Set the forced logout warning message and delay period.
Update-GlobalSetting -DisplayLogoffWarning $true -ForcedLogoffAfter $logoutdelay
-ForcedLogoffMessage "Forced log out will occur in $logoutdelay minutes"

Require clients to use SSL to connect and set the prelogin message.
Update-GlobalSetting -UseSSLClient $true -PreLoginMessage "Insert disclaimer and other notices
here."

Managing View Licenses


Display the installed View license keys.
Get-License

Add a license key.
Set-License -key "08A25-0212B-0212C-4D42E"

44 VMware, Inc.
4

Customizing LDAP Data 4


You can use VMware and Microsoft command tools to export and import LDAP configuration data in LDAP 
Data Interchange Format (LDIF) files from and into VMware View. These commands are intended for use by 
advanced administrators who want to use scripts to update configuration data without using View 
Administrator. If you want to create scripts to update the View configuration, VMware recommends that you 
use View PowerCLI rather than LDAP commands.

This chapter includes the following topics:

 “LDAP Configuration Data” on page 45

 “Export LDAP Configuration Data” on page 46

 “Modify LDAP Configuration Data” on page 46

 “Import LDAP Configuration Data” on page 49

 “Import LDAP Configuration Data Using the LDIFDE Command” on page 50

LDAP Configuration Data


All View configuration data is stored in an LDAP directory. Each View Connection Server standard or replica 
instance contains a local LDAP configuration repository and a replication agreement between each of the View 
Connection Server instances. This arrangement ensures that changes to one repository are automatically 
replicated to all the other repositories.

When you use View Administrator to modify the configuration of VMware View, the appropriate LDAP data 
in the repository is updated. For example, if you add a desktop pool, VMware View stores information about 
users, user groups, and entitlements in LDAP. The View Connection Server instances manage other LDAP 
configuration data automatically, and they use the information in the repository to control View operations.

You can use LDIF files to perform a number of tasks.

 To transfer configuration data between View Connection Server instances.

 To define a large number of View objects, such as desktop pools, and add these to your View Connection 
Server instances without using View Administrator to do this manually.

 To back up your View configuration so that you can restore the state of a View Connection Server instance.

In View Manager 3.1 and later, regular backups of the LDAP repository are made automatically.

LDAP configuration data is transferred as plain ASCII text and conforms to the Internet Engineering Task 
Force (IETF) RFC 2849 standard.

VMware, Inc. 45
VMware View Integration Guide

Export LDAP Configuration Data


You can export configuration data from a standard or replica View Connection Server instance to an LDIF file 
by running the vdmexport command‐line utility. 

By default, the vdmexport command‐line utility is installed in the C:\Program Files\VMware\VMware
View\Server\tools\bin directory. 

In View Manager 3.1 and earlier, you must be logged into a standard or replica instance View Connection 
Server instance as an administrator and be a member of the Local Administrators user group.

In VMware View 4.5, you must be logged in to a View Connection Server instance as a user in the 
Administrators or Administrators (Read only) role to export configuration data successfully from the View 
configuration repository.

To export configuration data from a View Connection Server instance

1 Select Start > Command Prompt.

2 At the command prompt, type the vdmexport command and redirect the output to a file.
vdmexport > myexport.LDF

In VMware View 4.5, you can specify the output file name as an argument to the -f option.
vdmexport -f myexport.LDF

The command writes the configuration of your View Connection Server instance to the file that you 
specify. The command displays errors if your role has insufficient privileges to view the data in the 
configuration repository.

Modify LDAP Configuration Data


You can modify the LDAP configuration data that you have exported from a View Connection Server instance 
to an LDIF file and use the modified file to perform automatic bulk configuration operations on View 
Connection Server instances.

You can obtain an example of the LDIF syntax for any item of LDAP configuration data in VMware View. For 
example, you can extract the data for a desktop pool and use this as a template to create a large number of 
desktop pools.

To modify LDAP configuration data

1 Use View Administrator to add a single desktop pool with the default attribute values that you require. 

If required, you can modify these values when you create your customized configuration file.

2 Use the vdmexport command to export the configuration data as an LDIF file.

See “Export LDAP Configuration Data” on page 46.

3 Examine the contents of the LDIF file to find the entry definitions of the desktop pool that you created.

You can use this entry as a template for adding a large number of desktop pools.

Use the vdmimport command to import your customized LDIF file and update the configuration of the View 
Connection Server instance. See “Import LDAP Configuration Data” on page 49.

You must add the following entries to an LDIF file to define a desktop pool:

 A Virtual Desktop VM entry for each virtual desktop in the desktop pool.

 A VM Pool entry for each desktop pool.

 A Desktop Application entry that defines the entitlement of the desktop pool.

Each VM Pool entry must be associated with one Desktop Application entry in a one‐to‐one relationship. A 
Desktop Application entry cannot be shared between VM Pool entries, and a VM Pool entry can only be 
associated with one Desktop Application entry.

46 VMware, Inc.
Chapter 4 Customizing LDAP Data

The following extract from an LDIF file shows sample entries for a desktop pool named Pool1, which contains 
two virtual desktops named VM1 and VM2. The desktop pool entry is paired with the Desktop Application 
entry, which is also named Pool1.
#
# Virtual Desktop VM entry VM1
#

DN: CN=vm1,OU=Servers,DC=vdi,DC=vmware,DC=int
changetype: add
objectClass: top
objectClass: pae-Server
objectClass: pae-WinServer
objectClass: pae-ThinWinServer
objectClass: pae-VM
cn: vm1
description: sample virtual desktop entry
pae-VmSuspended:: IA==
pae-OptIgnoreProcessList: 0
pae-MOID: vm-1
pae-VmState: READY
pae-ServerManaged: 1
pae-SSOEnabled: 1
pae-DisplayName: virtual desktop 1
pae-TunneledConnection: 1
pae-pwdEncryption: KERB5
ipHostNumber: vm1
pae-ClientProtVersion: 1
pae-WinDomain: NULL
pae-thinProto: XP_RDP
pae-Services: SESSION |, HEARTBEAT |, EVENTS |, USED |
pae-VmPath: /New Datacenter/vm/vm-1
pae-OptSuspendTimeout: 0
pae-OptDisconnectLimitTimeout: 0
pae-OptMaximumSessions: 0
pae-Disabled: 0

#
# Virtual Desktop VM entry VM2
#

DN: CN=vm2,OU=Servers,DC=vdi,DC=vmware,DC=int
changetype: add
objectClass: top
objectClass: pae-Server
objectClass: pae-WinServer
objectClass: pae-ThinWinServer
objectClass: pae-VM
cn: vm2
description: sample virtual desktop entry
pae-VmSuspended:: IA==
pae-OptIgnoreProcessList: 0
pae-MOID: vm-2
pae-VmState: READY
pae-ServerManaged: 1
pae-SSOEnabled: 1
pae-DisplayName: virtual desktop 2
pae-TunneledConnection: 1
pae-pwdEncryption: KERB5
ipHostNumber: vm2
pae-ClientProtVersion: 1
pae-WinDomain: NULL
pae-thinProto: XP_RDP
pae-Services: SESSION |, HEARTBEAT |, EVENTS |, USED |
pae-VmPath: /New Datacenter/vm/vm-2
pae-OptSuspendTimeout: 0
pae-OptDisconnectLimitTimeout: 0
pae-OptMaximumSessions: 0

VMware, Inc. 47
VMware View Integration Guide

pae-Disabled: 0

#
# Further Virtual Desktop VM entries as required
#

#
# VM Pool entry Pool1
#

DN: CN=Pool1,OU=Server Groups,DC=vdi,DC=vmware,DC=int


changetype: add
objectClass: top
objectClass: pae-ServerPool
cn: Pool1
pae-VCDN: CN=b180b93b-2dd3-4b58-8a81-b8534a4b7565,OU=VirtualCenter,OU=Properties,DC=vdi,
DC=vmware,DC=int
pae-MemberDN: CN=vm1,OU=Servers,DC=vdi,DC=vmware,DC=int
pae-MemberDN: CN=vm2,OU=Servers,DC=vdi,DC=vmware,DC=int
pae-VmPowerPolicy: remainon
pae-VmProvEnabled: 1
pae-VmProvSuspendOnError: 1
pae-VmStartClone: 1
pae-VmPoolCalculatedValues: 1
pae-ServerPoolType: 0
pae-VmMinimumCount: 0
pae-VmHeadroomCount: 0
pae-VmMaximumCount: 0
pae-Disabled: 0

#
# Desktop Application entry Pool1 -- one entry is required for each VM Pool
#

DN: CN=Pool1,OU=Applications,DC=vdi,DC=vmware,DC=int
changetype: add
objectClass: top
objectClass: pae-Entity
objectClass: pae-App
objectClass: pae-WinApp
objectClass: pae-ThinWinApp
objectClass: pae-DesktopApplication
cn: Pool1
member:: PFNJRD1TLTEtMi0zLTQ+IA==
pae-Icon: /thinapp/icons/desktop.gif
pae-URL: \
pae-Servers: CN=Pool1,OU=Server Groups,DC=vdi,DC=vmware,DC=int
pae-ServerProtocolLevel: OSX_NETOP
pae-ServerProtocolLevel: OS2_NETOP
pae-ServerProtocolLevel: NT4_NETOP
pae-ServerProtocolLevel: WIN2K_NETOP
pae-ServerProtocolLevel: NT4_RDP
pae-ServerProtocolLevel: WIN2K_RDP
pae-ServerProtocolLevel: XP_RDP
pae-Disabled: 0

48 VMware, Inc.
Chapter 4 Customizing LDAP Data

Table 4‐1 lists the attributes that are important when you modify a desktop pool definition.

Table 4-1. Important Attributes for Defining a Desktop Pool


Entry Attribute Description

Virtual Desktop VM cn Specifies the common name of an entry. If you require names to be 
VM Pool generated automatically, specify globally unique identifier (GUID) 
strings. You can use any reliable GUID generator, such as the 
Desktop Application
mechanism provided by .NET (for example, by calling 
System.Guid.NewGuid().ToString() in Visual Basic).

Desktop Application member Specifies a list of Active Directory (AD) users and groups who are 


entitled to access the desktop pool. The attribute is specified in the 
form of a Windows Security Identifier (SID) reference. A member 
value of <SID=S-1-2-3-4> represents an AD user or group with the 
SID value S-1-2-3-4. In LDIF format, the left angle (<) character is 
reserved, so you must place two colons (::) after the attribute name 
and specify the SID value in base 64 format (for example, 
PFNJRD1TLTEtMi0zLTQ+IA==). Because this attribute is 
multivalued, you can use it on multiple lines to represent each entry 
in a list of SIDs.

In a similar manner to desktop pools, you can create customized LDIF files for other objects that are defined 
in the LDAP repository, for example:

 Global configuration settings.

 Configuration settings for a specific View Connection Server instance or security server.

 Configuration settings for a specific user.

Import LDAP Configuration Data


You can import configuration data from an LDIF file into a standard or replica View Connection Server by 
running the vdmimport command.

The vdmimport command is available fromVMware View 4.5. In previous releases, you must use the LDIFDE 
command instead. See “Import LDAP Configuration Data Using the LDIFDE Command” on page 50.

By default, the vdmimport command‐line utility is installed in the C:\Program Files\VMware\VMware
View\Server\tools\bin directory.

The vdmimport command does not update, create, or delete any LDAP records that are not defined in the LDIF 
file. This allows you to customize an LDIF file so that only selected records are affected when you import the 
file. 

You must be logged into a View Connection Server instance as a user in the Administrators role to import 
configuration data successfully into the View configuration repository.

To import configuration data into a View Connection Server instance

1 Select Start > Command Prompt.

2 At the command prompt, type the vdmimport command and specify an existing LDIF file as an argument 
to the -f option.
vdmimport -f myexport.LDF

The configuration of your View Connection Server instance is updated with the data from the file, and the 
number of records that have been successfully updated is displayed. Errors are displayed if some records 
could not be updated because your role has insufficient privileges.

VMware, Inc. 49
VMware View Integration Guide

Import LDAP Configuration Data Using the LDIFDE Command


You can import configuration data from an LDIF file into a standard or replica View Connection Server by 
running the Microsoft LDIFDE command.

In release 4.5, you should use the vdmimport command to import configuration data. The vdmimport 
command does not display the large number of error messages that are produced by running the LDIFDE 
command. See “Import LDAP Configuration Data” on page 49.

The LDIFDE command does not update, create, or delete any LDAP records that are not defined in the LDIF 
file. This allows you to customize an LDIF file so that only selected records are affected when you import the 
file.

For more information about using the LDIFDE command, go to http://support.microsoft.com/kb/237677.

In View Manager 3.1 or earlier, you must be logged into a View Connection Server instance as an 
administrator, and be a member of the Local Administrators user group.

In VMware View 4.5, you must be logged into a View Connection Server instance as a user in the 
Administrators role to import configuration data successfully into the View configuration repository.

To import configuration data into a View Connection Server instance using LDIFDE
1 Select Start > All Programs > ADAM > ADAM Tools Command Prompt.

2 At the command prompt, type the LDIFDE command and specify an existing LDIF file as an argument to 
the -f option.
LDIFDE -i -f myexport.LDF -s 127.0.0.1 -z

Enter the other options to the LDIFDE command as shown in the example.

The configuration of your View Connection Server instance is updated with the data from the file, and the 
number of records that have been successfully updated is displayed. A large number of error messages 
are displayed that indicate whenever an existing entry in the repository has been overwritten. Such errors 
can be ignored. Errors are also displayed if some records could not be updated because your role has 
insufficient privileges.

50 VMware, Inc.
5

Integrating with SCOM 5


You can use Microsoft System Center Operations Manager (SCOM) to monitor the state of VMware View 
components, including View Connection Server instances and security servers and View services running on 
these hosts.

This chapter includes the following topics:

 “View Management Packs” on page 51

 “Name a View Connection Server Group” on page 52

 “Import the View MPs” on page 52

 “View Discovery Script” on page 52

 “Run the Discovery Script” on page 53

 “Display Discovered Objects” on page 53

 “Display Managed Objects” on page 53

 “Views and Monitors” on page 53

 “Enable a Proxy Agent on a Server” on page 55

 “Display Performance Data” on page 56

 “Display Information About an Alert” on page 56
 “Restart a Service” on page 56

 “Exclude a Domain from Connectivity Monitoring” on page 56

 “Close Alerts” on page 57

 “Class and Relationship Definitions” on page 57

View Management Packs


The View management packs (MPs) require the default System MP that is installed with Microsoft SCOM and 
the MP for Microsoft Windows Server Base OS System Center Operations Manager 2007.

The View MPs consists of four individual MPs:

 VMware.View.Discovery.mp contains the agent that discovers instances of View Server installations. See 
“View Discovery Script” on page 52.

 VMware.View.Monitoring.mp contains the views and monitors that you can use with View in the 
Operations Manager console. See “Views and Monitors” on page 53.

VMware, Inc. 51
VMware View Integration Guide

 VMware.View.Library.mp contains class and relationship definitions for the managed objects in View. 
See “Class and Relationship Definitions” on page 57.

 VMware.View.Image.Library.mp contains the graphics that represent the classes that are defined in 
VMware.View.Library.mp.

Name a View Connection Server Group


You can assign a name to a group of one or more View Connection Server hosts and security servers. The 
Operations Manager console displays this name to help you identify the group within SCOM.

To name the View Connection Server group

On one of the View Connection Server hosts in the group, use the -C and -c options with the vdmadmin 
command.
vdmadmin -C -c <group>

For example, set the name of a View Connection Server group to VCSG01.
vdmadmin -C -c VCSG01

Import the View MPs


When you install the View Connection Server software, the View MPs are also loaded onto the View 
Connection Server instance or security server. You can copy the View MPs to a SCOM server and use the 
Import Management Packs wizard from the Operations Manager console to import them.

NOTE   There is a known problem with McAfee VirusScan Enterprise 8.0i blocking the operation of Visual Basic 
scripts that are used by SCOM. For more information and details of the available patch, go to 
http://support.microsoft.com/kb/890736/en‐us.

To import the View MPs on a SCOM server

1 Copy the View MPs from their installation directory (usually C:\Program Files\VMware\VMware
View\Server\extras\ManagementPacks) on a View Connection Server instance or security server to 
the SCOM server.

2 In the Operations Manager console, right click Administration\Management Packs, and select Import 
Management Packs.

3 Use the Import Management Packs wizard to import the View MPs.

4 (Optional) Run the discovery script manually for the systems on which the VMware View software is 
installed.
More more information, see “Run the Discovery Script” on page 53.

View Discovery Script


The VMware.View.Discovery MP contains a script that finds View installed systems. The discovery script 
probes the registries of Windows servers for entries that indicate the version of the View software, the type of 
server, and the name and ID of the View Connection Server group. If the script detects that a View server is 
installed on a computer, it creates instances of the object classes that are defined in the VMware.View.Library 
MP and establishes the relationships between these managed objects.

The script can only discover a Windows server if you have used the Operations Manager console to enable the 
proxy agent for the server. See “Enable a Proxy Agent on a Server” on page 55.

The discovery script is scheduled to run once every hour. You can also perform the discovery manually from 
the Operations Manager console. See “Run the Discovery Script” on page 53.

You can verify the objects that the discovery agent has created for a server by viewing them in the Operations 
Manager console. See “Display Discovered Objects” on page 53.

52 VMware, Inc.
Chapter 5 Integrating with SCOM

The agent discovers the following managed objects for a Connection Server.

 VMware.View.Cluster

 VMware.View.Cluster.Node.V0405

 VMware.View.ConnectionServerRole.V0405

 VMware.View.Component.ConnectionServer.V0405
 VMware.View.Component.Framework.V0405

 VMware.View.Component.Web.V0405

 VMware.View.Component.Directory.V0405

 VMware.View.Component.SecureGateway.V0405

 VMware.View.Component.MessageBus.V0405

The agent discovers the following managed objects for a Security Server.

 VMware.View.Cluster

 VMware.View.Cluster.Node.V0405

 VMware.View.SecurityServerRole.V0405

 VMware.View.Component.SecurityServer.V0405

 VMware.View.Component.Framework.V0405

 VMware.View.Component.SecureGateway.V0405

For a description of View object classes and their relationships, see“Class and Relationship Definitions” on 
page 57.

Run the Discovery Script


The discovery script is scheduled to run once every hour. You can run the script manually to discover a system 
that you have added.

To run the discovery script

In the Operations Manager console, go to Monitoring\Windows Computers, select a computer system, and 
click the VMware View Run Discovery Probe action.

Display Discovered Objects


You can display the View objects that the discovery script has created for a server.

To display the objects that the discovery script has created for a server

In the Operations Manager console, go to Monitoring\Discovery Inventory.

Display Managed Objects


You can display the View objects that SCOM manages, and the relationships between these objects.

To display managed objects in View and their relationships

In the Operations Manager console, go to Monitoring\VMware View, and select the required view.

Views and Monitors


The VMware.View.Monitoring MP contains the views and monitors that you can use with View in the 
Operations Manager console. Table 5‐1 lists the views that you can use to examine discovered View objects.

VMware, Inc. 53
VMware View Integration Guide

Table 5-1. Views Available for View


View Description

Active Alerts Displays critical View alerts.

Node State Displays the state of all discovered members of all View Connection Server 
groups.

Group State Displays the state of the discovered View Connection Server groups.

Groups Displays a diagram of all discovered View Connection Server groups, members, 
roles, and components. You can obtain details about objects and their 
relationships by clicking the icons and the connectors.

Connection Server Role Performance  Displays the following data sets:
Data  All Sessions
 All Sessions High
 Checked out VMs
 Checked out VMs High
 SVI Sessions
 SVI Sessions High

Secure Gateway Role Performance  Displays the following data sets:
Data  Secure Gateway Sessions
 Secure Gateway Sessions High

You can find the Active Alerts, Group State, Groups, and Node State views under Monitoring\VMware View 
and the Connection Server Role Performance Data and Secure Gateway Role Performance Data views under 
Monitoring\VMware View\Performance in the Operations Manager console.

The VMware.View.Monitoring MP provides the following monitor types:

 Performance monitor – collects system data and return this data to the SCOM performance database and 
data warehouse. You can examine the data graphically in the Connection Server Role Performance Data 
and Secure Gateway Role Performance Data views. See “Performance Data Collection Settings” on 
page 55 and “Display Performance Data” on page 56.

 Service component monitors – collect information about the state of the View component services. If a 
monitored service is not running, SCOM sets its state to error and raises an alert. If a component is in the 
error state, the affected View Connection Server group and its members also enter the error state. See 
“Display Information About an Alert” on page 56, “Restart a Service” on page 56, and “Close Alerts” on 
page 57.

Table 5‐2 shows the service component monitors that are provided for a View Connection Server instance.

Table 5-2. View Service Component Monitors for a View Connection Server instance
Monitor Display Name Monitored Service

ConnectionServerServiceCheck Connection Server Service Health VMware View Connection Server


FrameworkServiceCheck Base Framework Service Health VMware View Framework 
Component

MessageBusServiceCheck Message Bus Service Health VMware View Message Bus 


Component

SecureGatewayCheck Security Gateway Service Health VMware View Security Gateway 


Component
WebServiceCheck Web Service Health VMware View Web Component

DirectoryServiceCheck Directory Service Health VMwareVDMDS

Table 5‐3 shows the service component monitors that are provided for a security server.

54 VMware, Inc.
Chapter 5 Integrating with SCOM

Table 5-3. View Service Component Monitors for a Security Server


Monitor Display Name Monitored Service

SecureGatewayServerServiceCheck Security Server Service Health VMware View Security Server

FrameworkServiceCheck Base Framework Service Health VMware View Framework 


Component

SecureGatewayCheck Security Gateway Service Health VMware View Security Gateway 


Component

 Domain connectivity monitor – verifies that a Connection Server can bind to all the domains of which it 
is a member. The monitor queries the status of the Web component on a Connection Server every 3 
minutes. If a Connection Server cannot bind to a domain, SCOM sets its state to error and raises an alert. 
See “Display Information About an Alert” on page 56, “Exclude a Domain from Connectivity 
Monitoring” on page 56, and “Close Alerts” on page 57.

 Event database connectivity monitor – checks that the event database is configured and that events are 
writable to the database. The monitor queries the Web component every 3 minutes for this information 
and raises an alert if the event database is not connected.

 Virtual Center (vCenter) connectivity monitor – checks that a View Connection Server instance can 
connect to the configured vCenter servers. The monitor queries the Web component every 3 minutes for 
this information and raises an alert if a vCenter server is not available.

Performance Data Collection Settings


To save storage space, the System.Performance.OptimizedDataProvider module is configured to store 
performance data in the SCOM database when the value of a sampled item has changed by more than a 
specified tolerance. For more information, see http://msdn.microsoft.com/en‐us/library/ee809318.aspx.

Table 5‐4 shows the performance data collection settings for the data sets.

Table 5-4. Performance Data Collection Settings


Data set Frequency Tolerance Maximum Sample Separation

All Sessions 15 minutes 5% 4
All Sessions High 60 minutes 5% 4

Checked Out VMs 15 minutes 5% 4

Checked Out VMs High 60 minutes 5% 4
Secure Gateway Sessions 15 minutes 5% 4

Secure Gateway Sessions High 60 minutes 5% 4

SVI Sessions 15 minutes 5% 4

SVI Sessions High 60 minutes 5% 4

Enable a Proxy Agent on a Server


You must enable the proxy agent on each View Connection Server host or security server that you want to 
monitor.

To enable the proxy agent on a server

1 In the Operations Manager console, go to Administration\Agent Managed, select the server, and click 
Properties.

2 Under the Security tab, select the option Allow this agent to act as a proxy and discover managed objects 
on other computers.

3 Click OK.

VMware, Inc. 55
VMware View Integration Guide

Display Performance Data


You can display graphical information about the performance of a View Connection Server instance or security 
server.

To display performance data for a View Connection Server instance or security server

In the Operations Manager console, go to Monitoring\VMware View\Performance, select the Connection 
Server Role Performance Data or Secure Gateway Role Performance Data view, and select the required data 
sets.

Display Information About an Alert


You can use the Health Explorer to display information about alerts that the health monitors have raised for a 
View Connection Server group.

To display active alerts for View components

1 In the Operations Manager console, go to Monitoring\VMware View and select the Active Alerts view.

2 Select an alert ( ) to display the knowledge article for that alert.

Restart a Service
The service component monitors alert you if a View component service stops working. You can restart a 
service from the Health Explorer.

To restart a service following an alert

1 In the Operations Manager console, go to Monitoring\VMware View and select the Group State view or 
the Group Node State view.

2 Right click on a View Connection Server group or member that is in the alert state ( ) and select 
Open > Health Explorer.

3 In the Health Explorer, select the alert and click Restart the service in the knowledge article.

Exclude a Domain from Connectivity Monitoring


The Domain Connectivity Health monitor checks the connectivity between a View Connection Server host’s 
domain and any trusted domains. To avoid seeing alerts for a domain, you can exclude the domain from being 
monitored.

To exclude a domain from being monitored for connectivity

1 In the Operations Manager console, go to Monitoring\VMware View, and select the Group State view or 
the Group Node State view.

2 Right click on the connection server, and select Open > Health Explorer.

3 Right click on the Domain Connectivity Health entry for the Connection Server in the Health Explorer 
and select Monitor Properties.

4 Under the Overrides tab, click Override and select the option for all objects of the same class.

5 In the Override Properties window, select the Override check box for the DomainExcludeList parameter, 
enter the name of the excluded domain in the Override Setting field, and select the Enforced check box. 
If you want to exclude more than one domain, use spaces to separate the domain names.

6 Click Apply and OK.

56 VMware, Inc.
Chapter 5 Integrating with SCOM

Close Alerts
You can close an alert without taking any action. This method does not prevent the alert from being raised 
again if the underlying cause persists.

To close alerts

1 In the Operations Manager console, go to Monitoring\VMware View and select the Active Alerts view.

2 Select the alert and click the Close Alert action.

Class and Relationship Definitions


The VMware.View.Library MP contains the class and relationship definitions for the View MPs. A class can 
have properties, such as a name or an ID. The relationships between classes describe their hierarchy. For 
example, the relationship contains exists between VMware.View.Clusters and VMware.View.Cluster, 
and between VMware.View.Cluster and VMware.View.Cluster.Node

Table 5‐5 shows the View Connection Server group classes that are defined in the VMware.View.Library MP.

Table 5-5. View Library View Connection Server Group Classes


Class Name Description

VMware.View.Cluster Represents a View Connection Server group. This class has 
the properties ClusterID and DisplayName (the name of 
the group).

VMware.View.Clusters Represents a singleton class that contains instances of 
VMware.View.Cluster.

Table 5‐6 shows the abstract base classes that are defined in the VMware.View.Library MP.

Table 5-6. View Library Base Classes


Class Name Description

VMware.View.Cluster.Node Represents a member of a View Connection Server group. 
This class has the properties ClusterID, ClusterName, 
ProductVersion, and InstallPath.

VMware.View.Component Represents a View component that has been installed on a 
member of a View Connection Server group. This class has 
the property Name.

VMware.View.Component.ConnectionServer Represents the Connection Server component that has 
been installed on a member of a View Connection Server 
group. This class inherits its properties from 
VMware.View.Component.

VMware.View.Component.Directory Represents the Directory component that has been 
installed on a member of a View Connection Server group. 
This class inherits its properties from 
VMware.View.Component.

VMware.View.Component.Framework Represents the Framework component that has been 
installed on a member of a View Connection Server group. 
This class inherits its properties from 
VMware.View.Component.

VMware.View.Component.MessageBus Represents the Message Bus component that has been 
installed on a member of a View Connection Server group. 
This class inherits its properties from 
VMware.View.Component.
VMware.View.Component.SecurityGateway Represents the Security Gateway component that has been 
installed on a member of a View Connection Server group. 
This class inherits its properties from 
VMware.View.Component.

VMware, Inc. 57
VMware View Integration Guide

Table 5-6. View Library Base Classes (Continued)


Class Name Description

VMware.View.Component.SecurityServer Represents the Security Server component that has been 
installed on a member of a View Connection Server group. 
This class inherits its properties from 
VMware.View.Component.
VMware.View.Component.Web Represents the Web component that has been installed on 
a member of a View Connection Server group. This class 
inherits its properties from VMware.View.Component.
VMware.View.ConnectionServerRole Represents a member of a View Connection Server group 
with the Connection Server installed on it. This class 
inherits its properties from VMware.View.NodeRole.

VMware.View.NodeRole Represents the role of a member of a View Connection 
Server group.

VMware.View.SecurityServerRole Represents a member of a View Connection Server group 
with the Security Server installed on it. This class inherits 
its properties from VMware.View.NodeRole.

Only version 4.5 instances that are derived from these classes are currently supported. Table 5‐7 shows the 
version 4.5 concrete classes that are defined in the VMware.View.Library MP.

Table 5-7. View Library version 4.5 Concrete Classes


Class Name Description

VMware.View.Cluster.Node.V0405 Represents a View Connection Server group member that 
has version 4.5 of View installed. This class inherits its 
properties from VMware.View.Cluster.Node.

VMware.View.Component.ConnectionServer.V0405 Represents version 4.5 of the Connection Server 
component that has been installed on a member of a View 
Connection Server group. This class inherits its properties 
from VMware.View.Component.Connection
Server.

VMware.View.Component.Directory.V0405 Represents version 4.5 of the Directory component that has 
been installed on a member of a View Connection Server 
group. This class inherits its properties from 
VMware.View.Component.Directory.

VMware.View.Component.Framework.V0405 Represents version 4.5 of the Framework component that 
has been installed on a member of a View Connection 
Server group. This class inherits its properties from 
VMware.View.Component.Framework.

VMware.View.Component.MessageBus.V0405 Represents version 4.5 of the Message Bus component that 
has been installed on a member of a View Connection 
Server group. This class inherits its properties from 
VMware.View.Component.MessageBus.

VMware.View.Component.SecurityGateway.V0405 Represents version 4.5 of the Security Gateway component 
that has been installed on a member of a View Connection 
Server group. This class inherits its properties from 
VMware.View.Component.SecureGateway.

VMware.View.Component.SecurityServer.V0405 Represents version 4.5 of the Security Server component 
that has been installed on a member of a View Connection 
Server group. This class inherits its properties from 
VMware.View.Component.SecurityServer.
VMware.View.Component.Web.V0405 Represents version 4.5 of the Web component that has been 
installed on a member of a View Connection Server group. 
This class inherits its properties from 
VMware.View.Component.Web.

58 VMware, Inc.
Chapter 5 Integrating with SCOM

Table 5-7. View Library version 4.5 Concrete Classes (Continued)


Class Name Description

VMware.View.ConnectionServerRole.V0405 Represents a member of a View Connection Server group 
with version 4.5 of the Connection Server installed on it. 
This class inherits its properties from 
VMware.View.NodeRole.
VMware.View.SecurityServerRole.V0405 Represents a member of a View Connection Server group 
with version 4.5 of the Security Server installed on it. This 
class inherits its properties from VMware.View.NodeRole.

The VMware.View.Library MP also contains friendly name strings for classes and properties. The SCOM 
console displays friendly names in preference to class and property names.

VMware, Inc. 59
VMware View Integration Guide

60 VMware, Inc.
Index

A ADMIN_DATABASE_CONFIGURATION_
Acknowledged column 10 UPDATED 18
Active Alerts view 54 ADMIN_DEFAULT_DESKTOPPOOL_ASSIGN 18
Add-AutomaticLinkedClonePool cmdlet 31 ADMIN_DEFAULT_DESKTOPPOOL_ASSIGN_
FAILED 18
Add-AutomaticPool cmdlet 31
ADMIN_DEFAULT_DESKTOPPOOL_
Add-ManualPool cmdlet 32
UNASSIGN 18
Add-ManualUnmanagedPool cmdlet 32
ADMIN_DEFAULT_DESKTOPPOOL_UNASSIGN_
Add-PoolEntitlement cmdlet 32 FAILED 18
Add-TerminalServerPool cmdlet 32 ADMIN_DELETE_PACKAGE 18
Add-ViewVC cmdlet 32 ADMIN_DESKTOP_ADDED 19
ADMIN 21 ADMIN_DESKTOP_ASSIGN 19
ADMIN_ADD_DESKTOP_ENTITLEMENT 17 ADMIN_DESKTOP_ASSIGN_FAILED 19
ADMIN_ADD_LICENSE 17 ADMIN_DESKTOP_EDITED 19
ADMIN_ADD_LICENSE_FAILED 17 ADMIN_DESKTOP_MAINTENANCE_MODE_
ADMIN_ADD_PM 17 UPDATE_FAILED 19
ADMIN_ADD_PM_FAILED 17 ADMIN_DESKTOP_MAINTENANCE_MODE_
ADMIN_ADD_THINAPP_ENTITLEMENT 17 UPDATED 19
ADMIN_ADD_THINAPP_ENTITLEMENT_ ADMIN_DESKTOP_UNASSIGN 19
FAILED 17 ADMIN_DESKTOP_UNASSIGN_FAILED 19
ADMIN_ADD_THINAPP_POOL_ ADMIN_ENABLE_DESKTOP_FAILED 19
ENTITLEMENT 17 ADMIN_ENABLE_DESKTOP_SUCCEEDED 19
ADMIN_ADMINSTRATOR_REMOVE_FAILED 17 ADMIN_ENABLED_DESKTOP_PROVISION_
ADMIN_ADMINSTRATOR_REMOVED 18 FAILED 19
ADMIN_CONFIGURE_TRANSFER_SERVER_ ADMIN_ENABLED_DESKTOP_PROVISION_
LOCAL_REPO 18 SUCCEEDED 19
ADMIN_CONFIGURE_TRANSFER_SERVER_ ADMIN_EVENT_CONFIGURATION_UPDATE_
NETWORK_REPO 18 FAILED 19
ADMIN_CONNECTION_BROKER_UPDATE_ ADMIN_EVENT_CONFIGURATION_UPDATED 19
FAILED 18 ADMIN_FOLDER_ADD_FAILED 19
ADMIN_CONNECTION_BROKER_UPDATED 18 ADMIN_FOLDER_ADDED 19
ADMIN_CONNECTION_SERVER_BACKUP_ ADMIN_FOLDER_CHANGE_FAILED 19
FAILED 18
ADMIN_FOLDER_CHANGED 19
ADMIN_CONNECTION_SERVER_BACKUP_
ADMIN_FOLDER_DELETE_FAILED 19
INITIATED 18
ADMIN_FOLDER_DELETED 19
ADMIN_CONNECTION_SERVER_DISABLE_
FAILED 18 ADMIN_GLOBAL_CONFIGURATION_UPDATE_
FAILED 19
ADMIN_CONNECTION_SERVER_DISABLED 18
ADMIN_GLOBAL_CONFIGURATION_
ADMIN_CONNECTION_SERVER_ENABLE_
UPDATED 19
FAILED 18
ADMIN_GLOBAL_POLICY_UPDATE_FAILED 20
ADMIN_CONNECTION_SERVER_ENABLED 18
ADMIN_GLOBAL_POLICY_UPDATED 20
ADMIN_DATABASE_CONFIGURATION_ADD_
FAILED 18 ADMIN_LOCALMODE_INITIATE_
REPLICATION 20
ADMIN_DATABASE_CONFIGURATION_
ADDED 18 ADMIN_LOCALMODE_LOCK_MACHINE 20
ADMIN_DATABASE_CONFIGURATION_DELETE_ ADMIN_LOCALMODE_LOCK_MACHINE_
FAILED 18 FAILED 20
ADMIN_DATABASE_CONFIGURATION_UPDATE_ ADMIN_LOCALMODE_ROLLBACK_DESKTOP 20
FAILED 18 ADMIN_LOCALMODE_UNLOCK_MACHINE 20

VMware, Inc. 61
VMware View Integration Guide

ADMIN_LOCALMODE_UNLOCK_MACHINE_ ADMIN_SVI_DETACH_UDD_SUCCEEDED 22
FAILED 20 ADMIN_SVI_REBALANCE_VM_FAILED 22
ADMIN_PERFMON_CONFIGURATION_UPDATE_ ADMIN_SVI_REBALANCE_VM_SUCCEEDED 22
FAILED 20 ADMIN_SVI_REFRESH_VM_FAILED 22
ADMIN_PERFMON_CONFIGURATION_ ADMIN_SVI_REFRESH_VM_SUCCEEDED 22
UPDATED 20
ADMIN_SVI_RESYNC_VM_FAILED 22
ADMIN_PERMISSION_ADD_FAILED 20
ADMIN_SVI_RESYNC_VM_SUCCEEDED 22
ADMIN_PERMISSION_ADDED 20
ADMIN_SVI_UPDATE_POOL_DEPLOYMENT_
ADMIN_PERMISSION_REMOVE_FAILED 20 GROUP_FAILED 22
ADMIN_PERMISSION_REMOVED 20 ADMIN_SVI_UPDATE_POOL_DEPLOYMENT_
ADMIN_POOL_POLICY_UPDATE_FAILED 20 GROUP_SUCCEEDED 22
ADMIN_POOL_POLICY_UPDATED 20 ADMIN_SVI_UPDATE_UDD_FAILED 22
ADMIN_PUBLISH_PACKAGE 20 ADMIN_SVI_UPDATE_UDD_SUCCEEDED 22
ADMIN_REMOVE_DESKTOP_ENTITLEMENT 20 ADMIN_THINAPP_ADD_FAILED 22
ADMIN_REMOVE_DESKTOP_FAILED 20 ADMIN_THINAPP_ADDED 22
ADMIN_REMOVE_DESKTOP_SUCCEEDED 20 ADMIN_THINAPP_DESKTOP_AVAILABLE 23
ADMIN_REMOVE_THINAPP_ENTITLEMENT 20 ADMIN_THINAPP_DESKTOP_REMOVED 23
ADMIN_REMOVE_THINAPP_ENTITLEMENT_ ADMIN_THINAPP_EDITED 23
FAILED 21 ADMIN_THINAPP_FAILED_DESKTOP_
ADMIN_REMOVE_THINAPP_POOL_ DELIVERY 23
ENTITLEMENT 21 ADMIN_THINAPP_FAILED_DESKTOP_
ADMIN_RESET_THINAPP_STATE 21 REMOVAL 23
ADMIN_RESET_THINAPP_STATE_FAILED 21 ADMIN_THINAPP_GROUP_ADD_FAILED 23
ADMIN_ROLE_ADD_FAILED 21 ADMIN_THINAPP_GROUP_ADDED 23
ADMIN_ROLE_ADDED 21 ADMIN_THINAPP_GROUP_EDIT_FAILED 23
ADMIN_ROLE_PRIV_UPDATE_FAILED 21 ADMIN_THINAPP_GROUP_EDITED 23
ADMIN_ROLE_PRIV_UPDATED 21 ADMIN_THINAPP_GROUP_REMOVE_FAILED 23
ADMIN_ROLE_REMOVE_FAILED 21 ADMIN_THINAPP_GROUP_REMOVED 23
ADMIN_ROLE_REMOVED 21 ADMIN_THINAPP_REMOVE_FAILED 23
ADMIN_ROLE_RENAME_FAILED 21 ADMIN_THINAPP_REMOVED 23
ADMIN_ROLE_RENAMED 21 ADMIN_THINAPP_REPO_ADD_FAILED 23
ADMIN_SECURITY_SERVER_ADD_FAILED 21 ADMIN_THINAPP_REPO_ADDED 23
ADMIN_SECURITY_SERVER_ADDED 21 ADMIN_THINAPP_REPO_EDIT_FAILED 23
ADMIN_SECURITY_SERVER_EDIT_FAILED 21 ADMIN_THINAPP_REPO_EDITED 23
ADMIN_SECURITY_SERVER_EDITED 21 ADMIN_THINAPP_REPO_REMOVED 23
ADMIN_SECURITY_SERVER_REMOVE_ ADMIN_TRANSFER_SERVER_ADDED 23
FAILED 21 ADMIN_TRANSFER_SERVER_ENTER_
ADMIN_SECURITY_SERVER_REMOVED 21 MAINTENANCE 24
ADMIN_SESSION_SENDMSG 21 ADMIN_TRANSFER_SERVER_EXIT_
ADMIN_SESSION_SENDMSG_FAILED 21 MAINTENANCE 24
ADMIN_SVI_ADD_DEPLOYMENT_GROUP_ ADMIN_TRANSFER_SERVER_REMOVED 24
FAILED 22 ADMIN_UNREGISTER_PM 24
ADMIN_SVI_ADD_DEPLOYMENT_GROUP_ ADMIN_UNREGISTER_PM_FAILED 24
SUCCEEDED 22 ADMIN_USER_INFO_UPDATE_FAILED 24
ADMIN_SVI_ADD_UDD_FAILED 22 ADMIN_USER_INFO_UPDATED 24
ADMIN_SVI_ADD_UDD_SUCCEEDED 22 ADMIN_USER_POLICY_DELETE_FAILED 24
ADMIN_SVI_ADMIN_ADDED 22 ADMIN_USER_POLICY_DELETED 24
ADMIN_SVI_ADMIN_REMOVED 22 ADMIN_USER_POLICY_UPDATE_FAILED 24
ADMIN_SVI_ADMIN_UPDATED 22 ADMIN_USER_POLICY_UPDATED 24
ADMIN_SVI_ATTACH_UDD_FAILED 22 ADMIN_USERLOGGEDIN 24
ADMIN_SVI_ATTACH_UDD_SUCCEEDED 22 ADMIN_USERLOGGEDOUT 24
ADMIN_SVI_DELETE_UDD_FAILED 22 ADMIN_VC_ADD_FAILED 24
ADMIN_SVI_DELETE_UDD_SUCCEEDED 22 ADMIN_VC_ADDED 24
ADMIN_SVI_DETACH_UDD_FAILED 22

62 VMware, Inc.
Index

ADMIN_VC_EDITED 24 BROKER_MACHINE_CONFIGURED_VIDEO_
ADMIN_VC_LICINV_ALARM_DISABLED 24 SETTINGS 12
ADMIN_VC_REMOVE_FAILED 24 BROKER_MACHINE_NOT_READY 12
ADMIN_VC_REMOVED 24 BROKER_MACHINE_OPERATION_DELETED 12
AdminFolderName attribute 25 BROKER_MACHINE_PROTOCOL_NOT_
AdminPermissionEntity attribute 25 SUPPORTED 12
AdminPrivilegeName attribute 25 BROKER_MACHINE_PROTOCOL_
UNAVAILABLE 12
AdminRoleName attribute 25
BROKER_MACHINE_REJECTED_SESSION 13
AdminRoleNewName attribute 25
BROKER_MACHINE_SESSION_TIMEDOUT 13
AGENT_CONNECTED 17
BROKER_POOL_CANNOT_ASSIGN 13
AGENT_DISCONNECTED 17
BROKER_POOL_EMPTY 13
AGENT_ENDED 17
BROKER_POOL_NO_MACHINE_ASSIGNED 13
AGENT_PENDING 17
BROKER_POOL_NO_RESPONSES 13
AGENT_PENDING_EXPIRED 17
BROKER_POOL_OVERLOADED 13
AGENT_RECONFIGURED 17
BROKER_POOL_POLICY_VIOLATION 13
AGENT_RECONNECTED 17
BROKER_POOL_PROTOCOL_NOT_
AGENT_RESUME 17
SUPPORTED 13
AGENT_SHUTDOWN 17
BROKER_POOL_PROTOCOL_UNAVAILABLE 13
AGENT_STARTUP 17
BROKER_POOL_TUNNEL_NOT_
AGENT_SUSPEND 17 SUPPORTED 13
alerts BROKER_PROVISIONING_ERROR_CONFIG_
closing 57 CLEARED 13
displaying information about 56 BROKER_PROVISIONING_ERROR_CONFIG_
excluding domains from SCOM monitoring 56 SET 13
AttrChangeType attribute 25 BROKER_PROVISIONING_ERROR_DISK_
attributes, event database 25 CLEARED 13
AttrName attribute 25 BROKER_PROVISIONING_ERROR_DISK_LC_
RESERVATION_CLEARED 13
AttrValue attribute 25
BROKER_PROVISIONING_ERROR_DISK_LC_
B RESERVATION_SET 13
BROKER_PROVISIONING_ERROR_DISK_
BooleanValue column 11
SET 13
BROKER_AGENT_OFFLINE 11
BROKER_PROVISIONING_ERROR_LICENCE_
BROKER_AGENT_ONLINE 11 CLEARED 14
BROKER_DAILY_MAX_USERS 11 BROKER_PROVISIONING_ERROR_LICENCE_
BROKER_DESKTOP_LAUNCH_FAILURE 11 SET 14
BROKER_DESKTOP_NOT_ENTITLED 11 BROKER_PROVISIONING_ERROR_
BROKER_DESKTOP_PROTOCOL_NOT_ NETWORKING_CLEARED 14
SUPPORTED 12 BROKER_PROVISIONING_ERROR_
BROKER_DESKTOP_REQUEST 12 NETWORKING_SET 14
BROKER_EVENT_HANDLING_STARTED 12 BROKER_PROVISIONING_ERROR_
BROKER_EVENT_HANDLING_STOPPED 12 RESOURCE_CLEARED 14
BROKER_LOCALMODE_OLD_ANCHOR_ BROKER_PROVISIONING_ERROR_
DELETE_FAILURE 12 RESOURCE_SET 14
BROKER_LOCALMODE_OPERATION_AUDIT_ BROKER_PROVISIONING_ERROR_TIMEOUT_
FAILURE 12 CUSTOMIZATION_CLEARED 14
BROKER_LOCALMODE_OPERATION_ BROKER_PROVISIONING_ERROR_TIMEOUT_
FAILURE 12 CUSTOMIZATION_SET 14
BROKER_LOCALMODE_OPERATION_ BROKER_PROVISIONING_ERROR_VM_
SUCCESS 12 CLONING 14
BROKER_MACHINE_ALLOCATED 12 BROKER_PROVISIONING_ERROR_VM_
BROKER_MACHINE_ASSIGNED_ CUSTOMIZATION_ERROR 14
UNAVAILABLE 12 BROKER_PROVISIONING_ERROR_VM_
BROKER_MACHINE_CANNOT_CONNECT 12 CUSTOMIZATION_NETWORKING 14
BROKER_MACHINE_CHECKEDOUT 12

VMware, Inc. 63
VMware View Integration Guide

BROKER_PROVISIONING_ERROR_VM_ BROKER_USER_AUTHFAILED_TIME_
CUSTOMIZATION_TIMEOUT 14 RESTRICTION 16
BROKER_PROVISIONING_SVI_ERROR_ BROKER_USER_NOT_AUTHORIZED 16
COMPOSER_AGENT_INIT_FAILED 14 BROKER_USER_NOT_ENTITLED 16
BROKER_PROVISIONING_SVI_ERROR_ BROKER_USERCHANGEDPASSWORD 16
RECONFIG_FAILED 14 BROKER_USERLOGGEDIN 16
BROKER_PROVISIONING_SVI_ERROR_REFIT_ BROKER_USERLOGGEDOUT 16
FAILED 14
BROKER_VC_DISABLED 11, 16
BROKER_PROVISIONING_SVI_ERROR_
BROKER_VC_ENABLED 11, 16
REMOVING_VM 14
BROKER_VC_STATUS_CHANGED_CANNOT_
BROKER_PROVISIONING_VERIFICATION_
LOGIN 16
FAILED_USER_ASSIGNED 14
BROKER_VC_STATUS_CHANGED_DOWN 16
BROKER_PROVISIONING_VERIFICATION_
FAILED_USER_CANNOT_BE_ BROKER_VC_STATUS_CHANGED_INVALID_
ASSIGNED 14 CREDENTIALS 16
BROKER_PROVISIONING_VERIFICATION_ BROKER_VC_STATUS_CHANGED_NOT_YET_
FAILED_VMNAME_IN_USE 15 CONNECTED 16
BROKER_SECURITY_SERVER_ADD_FAILED 15 BROKER_VC_STATUS_CHANGED_
RECONNECTING 16
BROKER_SECURITY_SERVER_ADD_FAILED_
PASSWORD_EXPIRED 15 BROKER_VC_STATUS_CHANGED_
UNKNOWN 16
BROKER_SECURITY_SERVER_ADD_FAILED_
PASSWORD_INCORRECT 15 BROKER_VC_STATUS_CHANGED_UP 16
BROKER_SECURITY_SERVER_ADD_FAILED_ BrokerId attribute 25
PASSWORD_NOT_SET 15 BrokerName attribute 25
BROKER_SECURITY_SERVER_ADDED 15
BROKER_SVI_ARCHIVE_UDD_FAILED 15 C
BROKER_SVI_ARCHIVE_UDD_SUCCEEDED 15 class definitions in View MPs 57
BROKER_SVI_ATTACH_UDD_FAILED 15 cmdlets 29
BROKER_SVI_ATTACH_UDD_SUCCEEDED 15 columns in event database tables 10
BROKER_SVI_DETACH_UDD_FAILED 15 -composerTask parameter 38
BROKER_SVI_DETACH_UDD_SUCCEEDED 15 configuration changes, displaying for VMware
View 43
BROKER_USER_AUTHFAILED_ACCOUNT_
DISABLED 15 configuration settings
BROKER_USER_AUTHFAILED_ACCOUNT_ displaying for View Connection Server 39
EXPIRED 15 updating for View Connection Server 39
BROKER_USER_AUTHFAILED_ACCOUNT_ connection broker events 11
LOCKED_OUT 15 Connection Server Role Performance Data view 54
BROKER_USER_AUTHFAILED_ACCOUNT_ ConnectionServerServiceCheck monitor 54
RESTRICTION 15
BROKER_USER_AUTHFAILED_BAD_USER_ D
PASSWORD 15 data disks, displaying for virtual machines 43
BROKER_USER_AUTHFAILED_GENERAL 15 -defaultProtocol parameter 35
BROKER_USER_AUTHFAILED_NO_LOGON_ -deletePolicy parameter 35
SERVERS 15
deletion policy, setting default 35
BROKER_USER_AUTHFAILED_PASSWORD_
desktop entitlements
EXPIRED 15
adding 41
BROKER_USER_AUTHFAILED_PASSWORD_
MUST_CHANGE 16 displaying information about 41
BROKER_USER_AUTHFAILED_SECUREID_ removing 42
ACCESS_DENIED 16 desktop pools 39
BROKER_USER_AUTHFAILED_SECUREID_ adding provisioned by terminal servers 41
NEWPIN_REJECTED 16 creating 40
BROKER_USER_AUTHFAILED_SECUREID_ displaying information about virtual machines
WRONG_NEXTTOKEN 16 in 42
BROKER_USER_AUTHFAILED_SECUREID_ removing 39
WRONG_STATE 16 resetting virtual machines in 43

64 VMware, Inc.
Index

setting type of 37 event_data table 9


updating 40 event_data_historical table 9
updating provisioned by terminal servers 41 event_historical table 9
DesktopDisplayName attribute 25 EventID column 10, 11
DesktopId events
attribute 25 connection broker 11
column 10 displaying available views for reporting 43
desktops displaying configuration changes 43
creating manually provisioned 41 displaying user events 43
creating manually unmanaged 41 View Administrator 17
updating manually provisioned 41 View Agent 17
updating manually unmanaged 41 EventType column 10
DirectoryServiceCheck monitor 54 execution policy, setting to unrestricted for View
discovery script PowerCLIcmdlets 30
displaying discovered objects 53 exporting LDAP configuration data 46
operation of 52
running 53
F
DiskPath attribute 25 Flash
display protocol, setting default 35 setting default quality 36
displaying setting default throttling 36
discovered objects for SCOM 53 -flashQuality parameter 36
information about alerts in SCOM 56 -flashThrottling parameter 36
managed objects for SCOM 53 FolderPath column 10
View performance data in SCOM 56 FrameworkServiceCheck monitor 54, 55
displaying help for View PowerCLI cmdlets 30
G
displaying information about 39
Get-ComposerDomain cmdlet 31
domain connectivity monitor 55
Get-ConnectionBroker cmdlet 31
DomainName attribute 25
Get-DesktopPhysicalMachine cmdlet 31
domains
Get-DesktopVM cmdlet 31
displaying information about users and
groups 41 Get-EventReport cmdlet 31
excluding from SCOM monitoring 56 Get-EventReportList cmdlet 31
DomainUser attribute 25 Get-GlobalSetting cmdlet 31
Get-Help cmdlet 30
E Get-License cmdlet 31
enabling proxy agent for SCOM 55 Get-LocalSession cmdlet 31
EntitlementDisplay attribute 25 Get-Monitor cmdlet 32
entitlements Get-Pool cmdlet 32
adding 41 Get-PoolEntitlement cmdlet 32
displaying information about 41 Get-ProfileDisk cmdlet 32
removing 42 Get-RemoteSession cmdlet 32
errors when using View PowerCLI cmdlets 30 Get-TerminalServer cmdlet 32
escape character sequences 30 Get-User cmdlet 32
escaping special characters 30 Get-ViewVC cmdlet 32
event database global configuration, displaying for VMware View 43
attributes 25 Group Node State view 54
columns 10 Group State view 54
integrating with 9 GroupId column 10
sample queries and views 27 Groups view 54
tables 9 groups, displaying information about 41
event database connectivity monitor 55
event database schema 10
event table 9

VMware, Inc. 65
VMware View Integration Guide

H Module column 10
help, displaying for View PowerCLI cmdlets 30 ModuleAndEventText column 10
monitors, available with SCOM 53
I MULTIPLE_DESKTOPS_FOR_KIOSK_USER 16
importing
LDAP configuration data using LDIFDE 50 N
LDAP configuration data using vdmimport 49 Name column 11
View MPs 52 naming View Connection Server groups 52
integration interfaces, introduced 8 Node column 10
IntValue column 11
O
L ObjectID attribute 26
LDAP backup frequency, setting default 36 ObjectType attribute 26
LDAP configuration data 45
exporting using vdmexport 46
P
importing using LDIFDE 50 PackageName attribute 26
importing using vdmimport 49 parameters, for View PowerCLI cmdlets 35
modifying 46 PathName attribute 26
LDAP Data Interchange Format (LDIF) 45 performance counter settings 55
-ldapBackupFrequency parameter 36 performance data, displaying for View in SCOM 56
LDIF files 45 performance monitor 54
LDIFDE command 50 physical computers, displaying information about 43
licenses PolicyDisplayName attribute 26
adding 44 PolicyObject attribute 26
displaying 44 PolicyValue attribute 26
linked-clone desktop pools pool type, setting default 37
creating 40 -poolType parameter 37
rebalancing 40 power policy, setting default 37
recomposing 40 -powerPolicy parameter 37
refreshing 40 PowerShell cmdlets 29
updating 40 PowerShell console, starting 29
listing, View PowerCLI cmdlets 30 prelogin message, setting global value for VMware
View 44
loading, View PowerCLI cmdlets 29
primary key 10
local desktops
ProtocolId attribute 26
displaying information about 42
proxy agent, enabling for SCOM 55
rolling back 42
LocalModeMessage attribute 25 R
LocalModeOperation attribute 25
ramp factor, changing for vCenter servers 39
logout delay period, setting global value for VMware
rebalancing linked-clone desktop pools 40
View 44
recomposing linked-clone desktop pools 40
logout warning message, setting global value for
VMware View 44 refresh policy, setting default 38
LUNId column 10 refreshing linked-clone desktop pools 40
-refreshPolicyType parameter 38
M relationship definitions in View MPs 57
MachineId attribute 26 remote sessions
MachineId column 10 disconnecting 42
MachineName attribute 26 displaying information about 42
MaintenanceMode attribute 26 logging out 42
managed objects, displaying 53 Remove-Pool cmdlet 32
management packs 51 Remove-PoolEntitlement cmdlet 32
MessageBusServiceCheck monitor 54 Remove-UserOwnership cmdlet 32
modifying LDAP configuration data 46 Remove-ViewVC cmdlet 32

66 VMware, Inc.
Index

removing desktop pools 39 SVIAdminFqdn attribute 26


running discovery script for SCOM 53 SVIAdminID attribute 26
SVIAdminName attribute 26
S SVIDeploymentGroupID attribute 26
schema, event database 10 SVIOperation attribute 26
SCOM SVIParentVM attribute 26
class and relationship definitions for View 57 SVIPath attribute 26
closing alerts 57 SVISnapshot attribute 26
displaying information about alerts 56 SVIVMID attribute 26
displaying View performance data 56 System Center Operations Manager (SCOM) 51
enabling a proxy agent 55
excluding domains from monitoring 56 T
integrating with VMware View 51 tables, event database 9
performance monitor 54 terminal servers
restarting View component services 56 adding desktop pools provisioned by 41
service component monitors 54 displaying information about 41
SCOM views and monitors 53 updating desktop pools provisioned by 41
Secure Gateway Role Performance Data view 54 The input object cannot be bound 30
SecureGatewayCheck monitor 54, 55 ThinAppDisplayName attribute 26
SecureGatewayServerServiceCheck monitor 55 ThinAppId
SecurityServerId attribute 26 attribute 26
Send-LinkedCloneRebalance cmdlet 31 column 10
Send-LinkedCloneRecompose cmdlet 31 ThinAppRepositoryName attribute 26
Send-LinkedCloneRefresh cmdlet 31 ThinAppRepositoryPath attribute 26
Send-LocalSessionRollback cmdlet 32 Time
Send-SessionDisconnect cmdlet 32 attribute 26
Send-SessionLogoff cmdlet 32 column 10
Send-VMReset cmdlet 32 timeout, setting global value for VMware View 43
service component monitors 54 TimeValue column 11
services, restarting from SCOM 56 TRANSFER_SERVER_PACKAGE_
session timeout, setting global value for VMware DISPLACEMENT 25
View 43 TRANSFER_SERVER_PACKAGE_MISSING 25
Set-ExecutionPolicy cmdlet 30 TRANSFER_SERVER_PACKAGE_
Set-License cmdlet 31 RECOVERY 25
setting TRANSFER_SERVER_PUBLISH_PACKAGE_
default display protocol 35 FAILURE 25
deletion policy 35 TRANSFER_SERVER_REAPER_FAILED 25
Flash quality 36 TRANSFER_SERVER_STATE_CHANGED 25
Flash throttling 36 TransferServerDisplay attribute 26
LDAP backup frequency 36 TransferServerNewState attribute 26
pool type 37 TransferServerOldState attribute 26
power policy 37 TransferServerStateInput attribute 26
refresh policy 38 Type column 11
smartt card authentication 38
U
unrestricted execution policy 30
Update-AutomaticLinkedClonePool cmdlet 31
Severity column 10
Update-AutomaticPool cmdlet 31
smart card authentication, setting 38
Update-ConnectionBroker cmdlet 31
-smartCardSetting parameter 38
Update-GlobalSetting cmdlet 31
Source column 10
Update-ManualPool cmdlet 32
special characters 30
Update-ManualUnmanagedPool cmdlet 32
SSL, setting global value for View Client 44
Update-TerminalServerPool cmdlet 32
starting PowerShell console 29
Update-UserOwnership cmdlet 32
StrValue column 11

VMware, Inc. 67
VMware View Integration Guide

Update-ViewVC cmdlet 32 error using pipe with View PowerCLI


user events, displaying for VMware View 43 cmdlets 30
UserCount attribute 26 introduction to 29
UserDiskPathId column 10 listing 30
UserDisplayName attribute 26 loading 29
UserName attribute 26 parameters 35
users setting unrestricted execution policy for 30
adding entitlements to desktop pools 41 View Transfer Server 7
changing ownership of virtual machines 43 views
displaying entitlements to desktop pools 41 available with SCOM 53
displaying information about 41 displaying those available for reporting
removing entitlements to desktop pools 42 events 43
removing ownership of virtual machines 43 virtual machines
UserSID column 10 displaying active data disks for 43
displaying information about 42
V removing ownership of 43
VCAddress attribute 26 resetting 43
vCenter pathnames,escape sequences 30 updating ownership of 43
vCenter Server 7 VMware View
vCenter server connectivity monitor 55 adding licenses 44
vCenter servers displaying configuration changes 43
adding to View Connection Server 39 displaying global configuration of 43
changing ramp factor for 39 displaying licenses 44
displaying for View Connection Server 39 displaying user events 43
displaying information about virtual machines event database 9
configured on 42 integrating with SCOM 51
removing from View Connection Server 39 overview 7
vdmexport command 46 setting global value of logout delay period 44
vdmimport command 49 setting global value of logout warning
View Administrator 7 message 44
View Administrator events 17 setting global value of prelogin message 44
View Agent 7 setting global value of session timeout 43
View Agent events 17 setting global value of SSL use by View
View Client 7 Client 44
setting SSL for connections 44 VMware.View.Cluster class 57
with Local Mode 7 VMware.View.Cluster.Node class 57
View Composer 7 VMware.View.Cluster.Node.V0405 class 58
View Composer maintenance task types 38 VMware.View.Clusters class 57
View Connection Server 7 VMware.View.Component class 57
adding vCenter servers to configuration 39 VMware.View.Component.ConnectionServer
class 57
displaying configuration settings for 39
VMware.View.Component.ConnectionServer.V0405
displaying configured vCenter servers 39
class 58
removing vCenter servers from
VMware.View.Component.Directory class 57
configuration 39
VMware.View.Component.Directory.V0405 class 58
updating configuration settings for 39
VMware.View.Component.Framework class 57
View Connection Server groups, naming 52
VMware.View.Component.Framework.V0405
View discovery script 52
class 58
View MPs
VMware.View.Component.MessageBus class 57
class and relationship definitions 57
VMware.View.Component.MessageBus.V0405
importing 52 class 58
introduction to 51 VMware.View.Component.Security Server.V0405
View PowerCLI cmdlets 29 class 58
displaying help 30

68 VMware, Inc.
Index

VMware.View.Component.SecurityGateway
class 57
VMware.View.Component.SecurityGateway.V0405
class 58
VMware.View.Component.SecurityServer class 58
VMware.View.Component.Web class 58
VMware.View.Component.Web.V0405 class 58
VMware.View.ConnectionServerRole class 58
VMware.View.ConnectionServerRole.V0405
class 59
VMware.View.Discovery.mp 51
VMware.View.Image.Library.mp 52
VMware.View.Library.mp 52
VMware.View.Monitoring.mp 51
VMware.View.NodeRole class 58
VMware.View.SecurityServerRole class 58
VMware.View.SecurityServerRole.V0405 class 59

W
WebServiceCheck monitor 54

VMware, Inc. 69
VMware View Integration Guide

70 VMware, Inc.

You might also like