VMware Horizon 7.1 User Manual

View Integration

VMware Horizon 7

Version 7.1

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-002046-00

View Integration

You can ﬁnd the most up-to-date technical documentation on the VMware Web site at:

hp://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:

docfeedback@vmware.com

VMware, Inc.

3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com

2 VMware, Inc.

View Integration 5

Introduction to View Integration 7

View Components 7

Integration Interfaces to View 8

Integrating View with the Event Database 9

Event Database Tables and Schemas 9

Connection Broker Events 11

Horizon Agent Events 16

View Administrator Events 17

Event Message Aributes 24

Sample Database Queries and Views 25

Using View PowerCLI 27

Geing Started with View PowerCLI 27

View Administrator, PowerCLI Cmdlets, and View Command-Line Interfaces Compared 30

View PowerCLI cmdlet Reference 34

View PowerCLI cmdlet Parameters 36

Examples of Using View PowerCLI cmdlets 40

Examples of Using View PowerCLI to Perform Advanced Tasks 46

Assigning Multiple Network Labels to a Desktop Pool 52

VMware, Inc.

Customizing LDAP Data 61

Introduction to LDAP Conguration Data 61

Modifying LDAP Conguration Data 62

Integrating View with Microsoft SCOM 67

Seing Up a SCOM Integration 67

Monitoring View in the Operations Manager Console 72

Examining PCoIP Session Statistics with WMI 77

Using PCoIP Session Statistics 77

General PCoIP Session Statistics 78

PCoIP Audio Statistics 78

PCoIP Imaging Statistics 79

PCoIP Network Statistics 80

PCoIP USB Statistics 81

Examples of Using PowerShell cmdlets to Examine PCoIP Statistics 82

View Integration

Seing Desktop Policies with Start Session Scripts 83

Index 89

Obtaining Input Data for a Start Session Script 83

Best Practices for Using Start Session Scripts 83

Preparing a View Desktop to Use a Start Session Script 84

Sample Start Session Scripts 86

4 VMware, Inc.

View Integration

The View Integration document describes how to integrate View™ software with third-party software such as Windows PowerShell, business intelligence reporting engines, and Microsoft System Center Operations Manager (SCOM).

Intended Audience

This document is intended for anyone who wants to customize or integrate software to work with View. The information in this document is wrien for experienced Windows or Linux system administrators who are familiar with virtual machine technology and datacenter operations.

VMware, Inc. 5

View Integration

6 VMware, Inc.

Introduction to View Integration 1

With View, system administrators can provision desktops and control user access to these desktops. Client software connects users to virtual machines running in VMware vSphere™, or to physical systems running within your network environment. In addition, View administrators can congure Remote Desktop Services (RDS) hosts to provide View desktop and application sessions to client devices.

This chapter includes the following topics:

“View Components,” on page 7

“Integration Interfaces to View,” on page 8

View Components

You can use View with VMware vCenter Server to create desktops from virtual machines that are running on VMware ESX® or VMware ESXi™ hosts and deploy these desktops to end users. You can also install View on RDS hosts to deploy desktops and applications to end users. View uses your existing Active Directory infrastructure for user authentication and management.

After you create a desktop or application, authorized end users can use Web-based or locally installed client software to securely connect to centralized virtual machines, back-end physical systems, or RDS hosts.

View consists of the following major components.

View Connection Server

Horizon Agent

Horizon Client

View Administrator

VMware, Inc. 7

A software service that acts as a broker for client connections by authenticating and then directing incoming user requests to the appropriate virtual machine, physical system, or RDS host.

A software service that is installed on all guest virtual machines, physical systems, or RDS hosts to allow them to be managed by View. Horizon Agent provides features such as connection monitoring, virtual printing, USB support, and single sign-on.

A software application that communicates with View Connection Server to enable users to connect to their desktops.

A Web application that enables View administrators to congure View Connection Server, deploy desktop and application pools, manage machines, control user authentication, initiate and examine system events, and perform analytical activities.

N View Administrator is named Horizon Administrator in Horizon 7.

View Integration

vCenter Server

View Composer

A server that acts as a central administrator for ESX/ESXi hosts that are connected on a network. A vCenter Server instance provides the central point for conguring, provisioning, and managing virtual machines in the datacenter.

A software service that is installed on a vCenter Server instance to enable View to rapidly deploy multiple linked-clone desktops from a single centralized base image.

Integration Interfaces to View

You can use several interfaces to integrate View with external applications.

Event database

View PowerCLI

Lightweight Directory Access Protocol (LDAP)

Microsoft System Center Operations Manager (SCOM)

You can congure 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.

You can use the PowerShell interface to perform a wide variety of administration tasks on View components.

You can export and import LDAP conguration data from and into View. You can create scripts that update this conguration data without accessing View Administrator directly.

You can monitor the operations of View components from the SCOM console.

Windows Management Instrumentation (WMI)

You can examine performance statistics for a PCoIP session.

8 VMware, Inc.

Integrating View with the Event

Database 2

You can congure View to record events to a Microsoft SQL Server or Oracle database. View records events such as end-user actions, administrator actions, alerts that report system failures and errors, and statistical sampling.

End-user actions include logging and starting desktop and application sessions. Administrator actions include adding entitlements and creating desktop and application pools. An example of statistical sampling is 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

“Horizon Agent Events,” on page 16

“View Administrator Events,” on page 17

“Event Message Aributes,” on page 24

“Sample Database Queries and Views,” on page 25

Event Database Tables and Schemas

View uses database tables to implement the event database. The event database prepends the names of these tables with a prex that you dene when you set up the database.

Event Database Tables

The following table shows the database tables that implement the event database in 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.

VMware, Inc. 9

View Integration

View records details about events to all the database tables. After a certain period of time has elapsed since writing an event record, View deletes the record from the event and event_data tables. You can use View Administrator to congure the time period for which the database keeps a record in the event and event_data tables.

I 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.

A unique primary key, EventID, identies each event that View records in the event and event_historical tables. View records data values for each event in the event_data and event_data_historical tables. You can obtain the complete set of information for an event by joining the event and event_data tables or the event_ historical and event_data_historical tables on the EventID column.

The EventType, Severity, and Time columns in the event and event_historical tables identify the type and severity of an event and the time at which it occurred.

For information about seing up the event database, see the View Installation document.

N Events might be lost if you restart View Connection Server instances while the event database is not running. For a solution that avoids this problem see hp://kb.vmware.com/kb/1021461.

Event Database Schemas

The following table shows the schema for the event and event_historical database tables.

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

Column Name Oracle Data Type SQL Server Data Type Description

Acknowledged SMALLINT tinyint Whether 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 aribute 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) Identier for the source of the event.

10 VMware, Inc.

Chapter 2 Integrating View with the Event Database

Table 2‑2. Schema for the event and event_historical Tables (Continued)

Column Name Oracle Data Type SQL Server Data Type Description

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.

The following table shows the schema for the event_data and event_data_historical database tables.

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

Column Name Oracle Data Type SQL Server Data Type Description

BooleanValue SMALLINT tinyint Value of a Boolean aribute.

0 = false

1 = true

EventID INTEGER int Unique primary key for the event.

IntValue INTEGER int Value of an integer aribute.

Name NVARCHAR2(512) nvarchar(512) Aribute name (for example,

UserDisplayName).

StrValue NVARCHAR2(512) nvarchar(512) Value of a string aribute. For other

types of aributes, this column contains an interpretation of the data type as a string.

TimeValue TIMESTAMP datetime Value of a date and time aribute.

Type SMALLINT tinyint The data type of the aribute.

0 = StrValue

1 = IntValue

2 = TimeValue

3 = BooleanValue

Connection Broker Events

Connection broker events report View Connection Server-related information, such as desktop and application sessions, user authentication failures, and provisioning errors.

The BROKER_DAILY_MAX_DESKTOP_SESSIONS event reports the maximum number of concurrent desktop sessions over a 24-hour period. If a user runs multiple desktop sessions concurrently, each desktop session is counted separately.

The BROKER_DAILY_MAX_APP_USERS event reports the maximum number of concurrent application users over a 24-hour period. If a user runs multiple applications concurrently, the user is counted only once. Short-lived sessions might not be included in the count because the sampling is performed every ve minutes.

The BROKER_VC_DISABLED and BROKER_VC_ENABLED events report the state of the vCenter driver that View uses to track a vCenter Server instance.

The BROKER_VC_STATUS_* events report the state of a vCenter Server instance.

The following table lists all the event types for View Connection Server.

VMware, Inc. 11

View Integration

Table 2‑4. Connection Broker Events

Event Type Severity ModuleAndEventText

BROKER_AGENT_OFFLINE BROKER_AGENT_OFF

LINE WARNING

The agent running on machine ${MachineName} has not responded to queries, marking it as oine

BROKER_AGENT_ONLINE WARNING The agent running on machine ${MachineName} is

responding again, but did not send a startup message

BROKER_APPLICATION_LAUNCH_FAILURE ERROR Unable to launch from Pool ${PoolId} for user $

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

BROKER_APPLICATION_MISSING WARNING At least ${ApplicationMissingCount} applications, including

${ApplicationExecutable}, are not installed on $ {MachineName} in Pool ${PoolId}

BROKER_APPLICATION_NOT_ENTITLED AUDIT_FAIL Unable to launch from Pool ${PoolId} for user $

{UserDisplayName}: User is not entitled to this Pool

BROKER_APPLICATION_PROTOCOL_NOT_SUPP ORTED

AUDIT_FAIL Unable to launch from Pool ${PoolId} for user $

{UserDisplayName}: Requested protocol ${ProtocolId} is not supported

BROKER_APPLICATION_REQUEST INFO User ${UserDisplayName} requested Application $

{ApplicationId}

BROKER_APPLICATION_SESSION_REQUEST INFO User ${UserDisplayName} requested an application session

from Pool ${PoolId}

BROKER_DAILY_MAX_DESKTOP_SESSIONS INFO ${Time}: Over the past 24 hours, the maximum number of

concurrent desktop sessions was ${UserCount}

BROKER_DAILY_MAX_APP_USERS INFO ${Time}: Over the past 24 hours, the maximum number of

users with concurrent application 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

BROKER_DESKTOP_PROTOCOL_NOT_SUPPORTEDAUDIT_FAIL Unable to launch from Pool ${DesktopId} 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_MACHINE_ALLOCATED INFO User ${UserDisplayName} requested Pool ${DesktopId},

allocated machine ${MachineName}

BROKER_MACHINE_ASSIGNED_UNAVAILABLE AUDIT_FAIL Unable to launch from Pool ${DesktopId} 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_CONFIGURED_VIDEO_SETTI NGS

INFO Successfully congured video seings for 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

12 VMware, Inc.

Chapter 2 Integrating View with the Event Database

Table 2‑4. Connection Broker Events (Continued)

Event Type Severity ModuleAndEventText

BROKER_MACHINE_PROTOCOL_NOT_SUPPORTEDAUDIT_FAIL Unable to launch from Pool ${DesktopId} for user $

{UserDisplayName}: Machine ${MachineName} does not support protocol ${ProtocolId}

BROKER_MACHINE_PROTOCOL_UNAVAILABLE AUDIT_FAIL Unable to launch from Pool ${DesktopId} for user $

{UserDisplayName}: Machine ${MachineName} did not report protocol ${ProtocolId} as ready

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_MULTIPLE_DESKTOPS_FOR_KIOSK_USERWARNING User ${UserDisplayName} is entitled to multiple desktop

pools

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_COMANAGER_REQUIRED AUDIT_FAIL Unable to launch from Pool ${DesktopId} for user $

{UserDisplayName}: No co-management availability for protocol ${ProtocolId}

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_SUPPORTED AUDIT_FAIL Unable to launch from Pool ${DesktopId} 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_CLEA RED

INFO The previously reported conguration problem is no longer

present on Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_CONFIG_SET ERROR Provisioning error occurred on Pool ${DesktopId} because of

a conguration problem

BROKER_PROVISIONING_ERROR_DISK_CLEAREDINFO The previously reported disk problem is no longer present on

Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_DISK_LC_RESE RVATION_CLEARED

INFO The previously reported error due to available free disk space

reserved for linked clones is no longer present on Pool $ {DesktopId}

BROKER_PROVISIONING_ERROR_DISK_LC_RESE RVATION_SET

ERROR Provisioning error occurred on Pool ${DesktopId} because

available free disk space is reserved for linked clones

VMware, Inc. 13

View Integration

Table 2‑4. Connection Broker Events (Continued)

Event Type Severity ModuleAndEventText

BROKER_PROVISIONING_ERROR_DISK_SET WARNING Provisioning error occurred on Pool ${DesktopId} because of

a disk problem

BROKER_PROVISIONING_ERROR_LICENCE_CLE ARED

INFO The previously reported licensing problem is no longer

present on Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_LICENCE_SET ERROR Provisioning error occurred on Pool ${DesktopId} because of

a licensing problem

BROKER_PROVISIONING_ERROR_NETWORKING _CLEARED

BROKER_PROVISIONING_ERROR_NETWORKING _SET

BROKER_PROVISIONING_ERROR_RESOURCE_CL EARED

INFO The previously reported networking problems with

Horizon Agent are no longer present on Pool ${DesktopId}

ERROR Provisioning error occurred on Pool ${DesktopId} because of

a networking problem with Horizon Agent

INFO The previously reported resource problem is no longer

present on Pool ${DesktopId}

BROKER_PROVISIONING_ERROR_RESOURCE_SETERROR Provisioning error occurred on Pool ${DesktopId} because of

a resource problem

BROKER_PROVISIONING_ERROR_TIMEOUT_CUS TOMIZATION_CLEARED

BROKER_PROVISIONING_ERROR_TIMEOUT_CUS TOMIZATION_SET

INFO The previously reported timeout while customizing is no

longer present on Pool ${DesktopId}

ERROR Provisioning error occurred on Pool ${DesktopId} because of

a timeout while customizing

BROKER_PROVISIONING_ERROR_VM_CLONING ERROR Provisioning error occurred for Machine ${MachineName}:

Cloning failed for Machine

BROKER_PROVISIONING_ERROR_VM_CUSTOMI ZATION_ERROR

BROKER_PROVISIONING_ERROR_VM_CUSTOMI ZATION_NETWORKING

ERROR Provisioning error occurred for Machine ${MachineName}:

Customization failed for Machine

ERROR Provisioning error occurred for Machine ${MachineName}:

Customization error due to no network communication between Horizon Agent and Connection Server

BROKER_PROVISIONING_ERROR_VM_CUSTOMI ZATION_TIMEOUT

BROKER_PROVISIONING_SVI_ERROR_COMPOSE R_AGENT_INIT_FAILED

BROKER_PROVISIONING_SVI_ERROR_RECONFIG _FAILED

BROKER_PROVISIONING_SVI_ERROR_REFIT_ FAILED

BROKER_PROVISIONING_SVI_ERROR_ REMOVING_VM

BROKER_PROVISIONING_VERIFICATION_ FAILED_USER_ASSIGNED

ERROR Provisioning error occurred for Machine ${MachineName}:

Customization operation timed out

ERROR Provisioning error occurred for Machine ${MachineName}:

View Composer agent initialization failed

ERROR Provisioning error occurred for Machine ${MachineName}:

Recongure operation failed

ERROR Provisioning error occurred for Machine ${MachineName}:

Ret operation ${SVIOperation} failed

ERROR Provisioning error occurred for Machine ${MachineName}:

Unable to remove Machine from inventory

WARNING Provisioning verication failed for Machine $

{MachineName}: User is already assigned to a machine in Pool ${DesktopId}

BROKER_PROVISIONING_VERIFICATION_ FAILED_USER_CANNOT_BE_ASSIGNED

WARNING Provisioning verication failed for Machine $

{MachineName}: A user cannot be assigned because Pool $ {DesktopId} is not persistent

BROKER_PROVISIONING_VERIFICATION_ FAILED_VMNAME_IN_USE

WARNING Provisioning verication failed for 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_ PASSWORD_EXPIRED

BROKER_SECURITY_SERVER_ADD_FAILED_ PASSWORD_INCORRECT

AUDIT_FAIL Failed to add security server ${SecurityServerId}, pairing

password expired

AUDIT_FAIL Failed to add security server ${SecurityServerId}, pairing

password incorrect

14 VMware, Inc.

Chapter 2 Integrating View with the Event Database

Table 2‑4. Connection Broker Events (Continued)

Event Type Severity ModuleAndEventText

BROKER_SECURITY_SERVER_ADD_FAILED_ PASSWORD_NOT_SET

AUDIT_FAIL Failed to add security server ${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 aach user data disk ${UserDiskName} to VM $

{SVIVMID}

BROKER_SVI_ATTACH_UDD_SUCCEEDED AUDIT_SUCCESS Aached 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_ DISABLED

BROKER_USER_AUTHFAILED_ACCOUNT_ EXPIRED

BROKER_USER_AUTHFAILED_ACCOUNT_ LOCKED_OUT

BROKER_USER_AUTHFAILED_ACCOUNT_ RESTRICTION

BROKER_USER_AUTHFAILED_BAD_USER_ PASSWORD

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because the

account is disabled

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because the

account has expired

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because the

account is locked out

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because of

an account restriction

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because of a

bad username or password

BROKER_USER_AUTHFAILED_GENERAL AUDIT_FAIL User ${UserDisplayName} failed to authenticate

BROKER_USER_AUTHFAILED_NO_LOGON_ SERVERS

BROKER_USER_AUTHFAILED_PASSWORD_ EXPIRED

BROKER_USER_AUTHFAILED_PASSWORD_ MUST_CHANGE

BROKER_USER_AUTHFAILED_SECUREID_

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because

there are no logon servers

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because the

password has expired

AUDIT_FAIL User ${UserDisplayName} failed to authenticate because the

password must change

AUDIT_FAIL SecurID access denied for user ${UserDisplayName}

ACCESS_DENIED

BROKER_USER_AUTHFAILED_SECUREID_ NEWPIN_REJECTED

BROKER_USER_AUTHFAILED_SECUREID_ WRONG_NEXTTOKEN

BROKER_USER_AUTHFAILED_SECUREID_ WRONG_STATE

BROKER_USER_AUTHFAILED_TIME_ RESTRICTION

AUDIT_FAIL SecurID access denied for user ${UserDisplayName} because

new pin was rejected

AUDIT_FAIL SecurID access denied for user ${UserDisplayName} because

wrong next token entered

AUDIT_FAIL SecurID access denied for user ${UserDisplayName} because

of incorrect state

AUDIT_FAIL User ${UserDisplayName} failed to 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

VMware, Inc. 15

View Integration

Table 2‑4. Connection Broker Events (Continued)

Event Type Severity ModuleAndEventText

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_ LOGIN

BROKER_VC_STATUS_CHANGED_DOWN INFO vCenter at address ${VCAddress} is down

BROKER_VC_STATUS_CHANGED_INVALID_ CREDENTIALS

BROKER_VC_STATUS_CHANGED_NOT_YET_ CONNECTED

BROKER_VC_STATUS_CHANGED_ RECONNECTING

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

WARNING Cannot log in to vCenter at address ${VCAddress}

WARNING vCenter at address ${VCAddress} has invalid credentials

INFO Not yet connected to vCenter at address ${VCAddress}

INFO Reconnecting to vCenter at address ${VCAddress}

Horizon Agent Events

View Agent events report Horizon Agent-related information, such as the users who have logged in to or disconnected from a specic machine, whether Horizon Agent has shut down on a specic machine, and whether Horizon Agent has sent a start up message from a specic machine to View Connection Server.

Table 2‑5. Horizon Agent Events

Event Type 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 o machine ${MachineName}

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

allocated session for user ${UserDisplayName}

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

{UserDisplayName} has expired

AGENT_RECONFIGURED INFO Machine ${MachineName} has been successfully recongured

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

16 VMware, Inc.

Chapter 2 Integrating View with the Event Database

View Administrator Events

View Administrator events report information about actions that users initiate in 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_FAILED AUDIT_FAIL ${UserDisplayName} failed to add Application

entitlement

ADMIN_ADD_THINAPP_POOL_ENTITLEMENT AUDIT_SUCCESS Application ${ThinAppDisplayName} was

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

ADMIN_ADMINSTRATOR_REMOVE_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove all

permissions for Administrator $ {AdminPermissionEntity}

ADMIN_ADMINSTRATOR_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed all permissions

for Administrator ${AdminPermissionEntity}

ADMIN_CONNECTION_BROKER_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update

connection broker ${BrokerId}

ADMIN_CONNECTION_BROKER_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated connection

broker ${BrokerId}: (${ArChangeType}: $ {ArName} = ${ArValue})

ADMIN_CONNECTION_SERVER_BACKUP_FAILED AUDIT_FAIL ${UserDisplayName} failed to initiate a backup

of connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_BACKUP_INITIATED AUDIT_SUCCESS ${UserDisplayName} initiated a backup of

connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_DISABLE_FAILED AUDIT_FAIL ${UserDisplayName} failed to disable

connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_DISABLED AUDIT_SUCCESS ${UserDisplayName} is disabling connection

broker ${BrokerId}

ADMIN_CONNECTION_SERVER_ENABLE_FAILED AUDIT_FAIL ${UserDisplayName} failed to enable

connection broker ${BrokerId}

ADMIN_CONNECTION_SERVER_ENABLED AUDIT_SUCCESS ${UserDisplayName} is enabling connection

broker ${BrokerId}

ADMIN_DATABASE_CONFIGURATION_ADD_FAILED AUDIT_FAIL ${UserDisplayName} failed to add database

conguration

ADMIN_DATABASE_CONFIGURATION_ ADDED AUDIT_SUCCESS ${UserDisplayName} has added database

conguration

VMware, Inc. 17

View Integration

Table 2‑6. View Administrator Events (Continued)

EventType Severity ModuleAndEventText

ADMIN_DATABASE_CONFIGURATION_DELETE_FAILED AUDIT_FAIL ${UserDisplayName} failed to delete database

conguration

ADMIN_DATABASE_CONFIGURATION_DELETE_FAILED AUDIT_SUCCESS ${UserDisplayName} has deleted database

conguration

ADMIN_DATABASE_CONFIGURATION_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update database

conguration

ADMIN_DATABASE_CONFIGURATION_UPDATED AUDIT_SUCCESS ${UserDisplayName} has updated database

conguration

ADMIN_DEFAULT_DESKTOPPOOL_ASSIGN AUDIT_SUCCESS ${UserDisplayName} assigned Pool $

{DesktopId} for default desktop to $ {UserName}

ADMIN_DEFAULT_DESKTOPPOOL_ASSIGN_FAILED AUDIT_FAIL ${UserDisplayName} failed to assign Pool $

{DesktopId} for default desktop to $ {UserName}

ADMIN_DEFAULT_DESKTOPPOOL_UNASSIGN AUDIT_SUCCESS ${UserDisplayName} removed pool

assignment for default desktop to $ {UserName}

ADMIN_DEFAULT_DESKTOPPOOL_UNASSIGN_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove Pool

assignment for default desktop to $ {UserName}

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}

(${ArChangeType}: ${ArName} = $ {ArValue})

ADMIN_DESKTOP_MAINTENANCE_MODE_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update desktop

${MachineName} to ${MaintenanceMode} maintenance mode

ADMIN_DESKTOP_MAINTENANCE_MODE_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated desktop $

{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_FAILED AUDIT_FAIL ${UserDisplayName} failed to set provisioning

for Pool ${DesktopId} to ${EnableStatus}

ADMIN_ENABLED_DESKTOP_PROVISION_SUCCEEDED AUDIT_SUCCESS ${UserDisplayName} set provisioning for Pool

${DesktopId} to ${EnableStatus}

ADMIN_EVENT_CONFIGURATION_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update event

conguration

18 VMware, Inc.

Chapter 2 Integrating View with the Event Database

Table 2‑6. View Administrator Events (Continued)

EventType Severity ModuleAndEventText

ADMIN_EVENT_CONFIGURATION_UPDATED AUDIT_SUCCESS ${UserDisplayName} has updated global

conguration

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_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update global

conguration

ADMIN_GLOBAL_CONFIGURATION_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated global

conguration (${ArChangeType}: $ {ArName} = ${ArValue})

ADMIN_GLOBAL_POLICY_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update global

policies

ADMIN_GLOBAL_POLICY_UPDATED AUDIT_SUCCESS ${UserDisplayName} updated global policy ($

{ArChangeType}: ${ArName} = $ {ArValue})

ADMIN_PERFMON_CONFIGURATION_UPDATE_FAILED AUDIT_FAIL ${UserDisplayName} failed to update

performance monitoring conguration

ADMIN_PERFMON_CONFIGURATION_UPDATED AUDIT_SUCCESS ${UserDisplayName} has updated

performance monitoring conguration

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 (${ArChangeType}: $ {ArName} = ${ArValue})

VMware, Inc. 19

View Integration

Table 2‑6. View Administrator Events (Continued)

EventType Severity ModuleAndEventText

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}

ADMIN_REMOVE_THINAPP_ENTITLEMENT_FAILED AUDIT_FAIL ${UserDisplayName} failed to remove

Application entitlement

ADMIN_REMOVE_THINAPP_POOL_ENTITLEMENT AUDIT_SUCCESS Application ${ThinAppDisplayName} was

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} (${ArChangeType}: $ {ArName} = ${ArValue})

20 VMware, Inc.

Chapter 2 Integrating View with the Event Database

Table 2‑6. View Administrator Events (Continued)

EventType Severity ModuleAndEventText

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}

ADMIN_SVI_ADD_DEPLOYMENT_GROUP_FAILED AUDIT_FAIL Failed to add deployment group for $

{SVIParentVM} : ${SVISnapshot}

ADMIN_SVI_ADD_DEPLOYMENT_GROUP_SUCCEEDED AUDIT_SUCCESS Added deployment group $

{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 aach user data disk $

{UserDiskName} to VM ${SVIVMID}

ADMIN_SVI_ATTACH_UDD_SUCCEEDED AUDIT_SUCCESS Requested aach 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_GROUP_FAILED AUDIT_FAIL Failed to update pool ${DesktopId} to

deployment group ${SVIDeploymentGroupID}

ADMIN_SVI_UPDATE_POOL_DEPLOYMENT_GROUP_SUCCEEDEDAUDIT_SUCCESS Updated pool ${DesktopId} to deployment

group ${SVIDeploymentGroupID}

VMware, Inc. 21

View Integration

Table 2‑6. View Administrator Events (Continued)

EventType Severity ModuleAndEventText

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}

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_DELIVERY AUDIT_FAIL Failed to deliver Application $

{ThinAppDisplayName} to Desktop $ {DesktopDisplayName}

ADMIN_THINAPP_FAILED_DESKTOP_REMOVAL AUDIT_FAIL Failed to remove Application $

{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}

22 VMware, Inc.

Chapter 2 Integrating View with the Event Database

Table 2‑6. View Administrator Events (Continued)

EventType Severity ModuleAndEventText

ADMIN_THINAPP_REPO_EDITED AUDIT_SUCCESS ${UserDisplayName} edited Repository $

{ThinAppRepositoryName}, path $ {ThinAppRepositoryPath}

ADMIN_THINAPP_REPO_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed Repository $

{ThinAppRepositoryName}

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} (${ArChangeType}: ${ArName} = ${ArValue})

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} ($

{ArChangeType}: ${ArName} = $ {ArValue})

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} (${ArChangeType}: $ {ArName} = ${ArValue})

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}

VMware, Inc. 23

View Integration

Event Message Attributes

ModuleAndEventText messages use certain aributes. To determine the data type for an aribute, you can examine its value in the type column in the event_data or event_data_historical table.

Table 2‑7. Attributes that ModuleAndEventText Messages Use

Attribute Name Description

AdminFolderName Name of a folder that requries privileged access.

AdminPermissionEntity Name of an object that requires privileged access.

AdminPrivilegeName Name of an administrative privilege.

AdminRoleName Name of an administrative role.

AdminRoleNewName New name of an administrative role.

ArChangeType Type of change that was applied to a generic aribute.

ArName Name of a generic aribute.

ArValue Value of a generic aribute.

BrokerId Identier of a View Connection Server instance.

BrokerName Name of a View Connection Server instance.

DesktopDisplayName Display name of a desktop pool.

DesktopId Identier of a desktop pool.

EntitlementDisplay Display name of a desktop entitlement.

MachineId Name of a physical or virtual machine.

MachineName Name of a physical or virtual machine.

MaintenanceMode Maintenance mode state.

ObjectID Identier of an inventory object.

ObjectType Type of an inventory object.

PolicyDisplayName Display name of a policy.

PolicyObject Identier of a policy object.

PolicyValue Value of a policy object.

ProtocolId Identier of a display protocol.

SecurityServerId Identier of a security server.

SVIAdminFqdn FQDN of a QuickPrep domain.

SVIAdminID Identier of a QuickPrep domain.

SVIAdminName Name of a QuickPrep domain.

SVIDeploymentGroupID Identier 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 Identier of a virtual machine in View Composer.

ThinAppDisplayName Display name of a ThinApp object.

ThinAppId Identier of a ThinApp object.

24 VMware, Inc.

Table 2‑7. Attributes that ModuleAndEventText Messages Use (Continued)

Attribute Name Description

ThinAppRepositoryName Name of a ThinApp repository

ThinAppRepositoryPath Path of a ThinApp repository.

Time Date and time value.

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.

Sample Database Queries and Views

You can query the event_historical database to display error events, warning events, and specic recent events.

N Replace the dbo.VE_ prex in the following examples with the appropriate prex for your event database.

Chapter 2 Integrating View with the Event Database

List Error Events

The following query displays all error events from the event_historical table.

CREATE VIEW error_events AS

(

SELECT ev.EventID, ev.Time, ev.Module, ev.EventType, ev.ModuleAndEventText

FROM dbo.VE_event_historical AS ev

WHERE ev.Severity = ‘ERROR’

);

List Warning Events

The following query displays all warning events from the event_historical table.

CREATE VIEW warning_events AS

(

SELECT ev.EventID, ev.Time, ev.Module, ev.EventType, ev.ModuleAndEventText

FROM dbo.VE_event_historical AS ev

WHERE ev.Severity = ‘WARNING’

);

List Recent Events

The following query lists all recent events that are associated with the user fred in the domain MYDOM.

CREATE VIEW user_fred_events AS

(

SELECT ev.EventID, ev.Time, ev.Module, ev.EventType, ev.Severity, ev.Acknowledged

FROM dbo.VE_event_historical AS ev,

dbo.VE_event_data_historical AS ed

WHERE ev.EventID = ed.EventID AND ed.Name = 'UserDisplayName' AND ed.StrValue =

‘MYDOM\fred’

);

VMware, Inc. 25

View Integration

The following query lists 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 dbo.VE_event_historical AS ev,

dbo.VE_event_data_historical AS ed

WHERE ev.EventID = ed.EventID AND ev.EventType = ‘AGENT_SHUTDOWN’ AND

ed.Name = ‘MachineName’

);

The following query lists all recent events where a desktop failed to launch because the desktop pool was empty.

CREATE VIEW desktop_launch_failure_events AS

(

SELECT ev.EventID, ev.Time, ed1.StrValue, ed2.StrValue

FROM dbo.VE_event_historical AS ev,

dbo.VE_event_data_historical AS ed1,

dbo.VE_event_data_historical AS ed2

WHERE ev.EventID = ed1.EventID AND ev.EventID = ed2.EventID AND

ev.EventType = ‘BROKER_POOL_EMPTY’ AND

ed1.Name = ‘UserDisplayName’ AND ed2.Name = ‘DesktopId’

);

The following query lists all recent events where an administrator removed a desktop pool.

CREATE VIEW desktop_pool_removed_events AS

(

SELECT ev.EventID, ev.Time, ed1.StrValue, ed2.StrValue

FROM dbo.VE_event_historical AS ev,

dbo.VE_event_data_historical AS ed1,

dbo.VE_event_data_historical AS ed2

WHERE ev.EventID = ed1.EventID AND ev.EventID = ed2.EventID AND

ev.EventType = ‘ADMIN_DESKTOP_REMOVED’ AND

ed1.Name = ‘UserDisplayName’ AND ed2.Name = ‘DesktopId’

);

The following query lists 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 dbo.VE_event_historical AS ev,

dbo.VE_event_data_historical AS ed1,

dbo.VE_event_data_historical AS ed2,

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’

);

26 VMware, Inc.

Using View PowerCLI 3

Eective in Horizon 7 version 7.0.3, View PowerCLI is deprecated.

For previous versions of Horizon 7, you can use View PowerCLI as an easy-to-use PowerShell interface to View and use View PowerCLI cmdlets to perform various administration tasks on View components.

In Horizon 7 version 7.0.3, you can use Horizon PowerCLI cmdlets with VMware PowerCLI. Use Horizon PowerCLI cmdlets to perform various administration tasks on Horizon components.

For more information about Horizon PowerCLI cmdlets, read the VMware PowerCLI Cmdlets Reference.

For information on the API specications to create advanced functions and scripts to use with Horizon PowerCLI, see the View API Reference at the VMware Developer Center.

For more information on sample scripts that you can use to create your own Horizon PowerCLI scripts, see the Horizon PowerCLI community on GitHub.

This chapter includes the following topics:

“Geing Started with View PowerCLI,” on page 27

“View Administrator, PowerCLI Cmdlets, and View Command-Line Interfaces Compared,” on

page 30

“View PowerCLI cmdlet Reference,” on page 34

“View PowerCLI cmdlet Parameters,” on page 36

“Examples of Using View PowerCLI cmdlets,” on page 40

“Examples of Using View PowerCLI to Perform Advanced Tasks,” on page 46

“Assigning Multiple Network Labels to a Desktop Pool,” on page 52

Getting Started with View PowerCLI

PowerShell is a command line and scripting environment designed for Microsoft Windows. PowerShell uses the .NET object model and provides administrators with management and automation capabilities. You work with PowerShell by running commands, which are called cmdlets in PowerShell. The command line syntax for View PowerCLI cmdlets is the same as generic PowerShell syntax.

The View PowerCLI cmdlets are dened in the PowershellServiceCmdlets.dll le, which is installed in the

C:\Program Files\VMware\VMware View\Server\bin directory. The PowershellServiceCmdlets.dll le

constitutes the VMware.View.Broker snapin.

You can edit and extend the View PowerCLI cmdlets script conguration le, InitViewCmdlets.ps1, to dene cmdlet aliases, congure the environment, and set startup actions. InitViewCmdlets.ps1 is in the

Extras folder in the View installation directory.

VMware, Inc.

+ 63 hidden pages

VMware Horizon 7.1 User Manual

Contents

View Integration

Introduction to View Integration 1

View Components

Integration Interfaces to View

Event Database Tables and Schemas

Connection Broker Events

Horizon Agent Events

View Administrator Events

Event Message Attributes

Sample Database Queries and Views

Using View PowerCLI 3

Getting Started with View PowerCLI