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.
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: docfeedback@vmware.com Copyright © 2010 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
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 Power
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
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.
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.
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.
VMware View Integration Guide Integration Interfaces to VMware View You can use several interfaces to integrate VMware View with external applications. 8 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.
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.
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.
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 Column Name Oracle Data Type SQLServer 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.
VMware View Integration Guide Table 2-4.
Chapter 2 Integrating with the Event Database Table 2-4.
VMware View Integration Guide Table 2-4.
Chapter 2 Integrating with the Event Database Table 2-4.
VMware View Integration Guide Table 2-4.
Chapter 2 Integrating with the Event Database View Agent Events Table 2‐5 shows the event types for View Agent. Table 2-5.
VMware View Integration Guide Table 2-6. View Administrator Events (Continued) 18 EventType Severity ModuleAndEventText ADMIN_ADMINSTRATOR_REMOVED AUDIT_SUCCESS ${UserDisplayName} removed all permissions for Administrator ${AdminPermissionEntity} ADMIN_CONFIGURE_TRANSFER_SERVER_ LOCAL_REPO INFO Configure a local Transfer Server Repository. Path ${PathName} ADMIN_CONFIGURE_TRANSFER_SERVER_ NETWORK_REPO INFO Configure a network Transfer Server Repository.
Chapter 2 Integrating with the Event Database Table 2-6.
VMware View Integration Guide Table 2-6.
Chapter 2 Integrating with the Event Database Table 2-6.
VMware View Integration Guide Table 2-6.
Chapter 2 Integrating with the Event Database Table 2-6.
VMware View Integration Guide Table 2-6.
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.
VMware View Integration Guide Table 2-8. Attributes Used with ModuleAndEventText Messages (Continued) 26 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.
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 mac
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.
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.
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.
VMware View Integration Guide Table 3-3. View PowerCLI Cmdlets Ordered by Noun (Continued) 32 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.
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.
VMware View Integration Guide Table 3-4.
Chapter 3 Using View PowerCLI Table 3-4.
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.
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.
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.
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.
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.
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.
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 .
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.
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.
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.
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.
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.
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-VmProvEnabl
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 generated automatically, specify globally unique identifier (GUID) strings. You can use any reliable GUID generator, such as the mechanism provided by .NET (for example, by calling System.Guid.NewGuid().
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.
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.
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.
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.
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.
Chapter 5 Integrating with SCOM Table 5-3.
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.
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.
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.
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.
VMware View Integration Guide 60 VMware, Inc.
Index A Acknowledged column 10 Active Alerts view 54 Add-AutomaticLinkedClonePool cmdlet 31 Add-AutomaticPool cmdlet 31 Add-ManualPool cmdlet 32 Add-ManualUnmanagedPool cmdlet 32 Add-PoolEntitlement cmdlet 32 Add-TerminalServerPool cmdlet 32 Add-ViewVC cmdlet 32 ADMIN 21 ADMIN_ADD_DESKTOP_ENTITLEMENT 17 ADMIN_ADD_LICENSE 17 ADMIN_ADD_LICENSE_FAILED 17 ADMIN_ADD_PM 17 ADMIN_ADD_PM_FAILED 17 ADMIN_ADD_THINAPP_ENTITLEMENT 17 ADMIN_ADD_THINAPP_ENTITLEMENT_ FAILED 17 ADMIN_ADD_THINAPP_POOL_ ENTITLEMENT 17 ADMIN
VMware View Integration Guide ADMIN_LOCALMODE_UNLOCK_MACHINE_ FAILED 20 ADMIN_PERFMON_CONFIGURATION_UPDATE_ FAILED 20 ADMIN_PERFMON_CONFIGURATION_ UPDATED 20 ADMIN_PERMISSION_ADD_FAILED 20 ADMIN_PERMISSION_ADDED 20 ADMIN_PERMISSION_REMOVE_FAILED 20 ADMIN_PERMISSION_REMOVED 20 ADMIN_POOL_POLICY_UPDATE_FAILED 20 ADMIN_POOL_POLICY_UPDATED 20 ADMIN_PUBLISH_PACKAGE 20 ADMIN_REMOVE_DESKTOP_ENTITLEMENT 20 ADMIN_REMOVE_DESKTOP_FAILED 20 ADMIN_REMOVE_DESKTOP_SUCCEEDED 20 ADMIN_REMOVE_THINAPP_ENTITLEMENT 20 ADMIN_RE
Index ADMIN_VC_EDITED 24 ADMIN_VC_LICINV_ALARM_DISABLED 24 ADMIN_VC_REMOVE_FAILED 24 ADMIN_VC_REMOVED 24 AdminFolderName attribute 25 AdminPermissionEntity attribute 25 AdminPrivilegeName attribute 25 AdminRoleName attribute 25 AdminRoleNewName attribute 25 AGENT_CONNECTED 17 AGENT_DISCONNECTED 17 AGENT_ENDED 17 AGENT_PENDING 17 AGENT_PENDING_EXPIRED 17 AGENT_RECONFIGURED 17 AGENT_RECONNECTED 17 AGENT_RESUME 17 AGENT_SHUTDOWN 17 AGENT_STARTUP 17 AGENT_SUSPEND 17 alerts closing 57 displaying information abo
VMware View Integration Guide BROKER_PROVISIONING_ERROR_VM_ CUSTOMIZATION_TIMEOUT 14 BROKER_PROVISIONING_SVI_ERROR_ COMPOSER_AGENT_INIT_FAILED 14 BROKER_PROVISIONING_SVI_ERROR_ RECONFIG_FAILED 14 BROKER_PROVISIONING_SVI_ERROR_REFIT_ FAILED 14 BROKER_PROVISIONING_SVI_ERROR_ REMOVING_VM 14 BROKER_PROVISIONING_VERIFICATION_ FAILED_USER_ASSIGNED 14 BROKER_PROVISIONING_VERIFICATION_ FAILED_USER_CANNOT_BE_ ASSIGNED 14 BROKER_PROVISIONING_VERIFICATION_ FAILED_VMNAME_IN_USE 15 BROKER_SECURITY_SERVER_ADD_FAILED 15
Index setting type of 37 updating 40 updating provisioned by terminal servers 41 DesktopDisplayName attribute 25 DesktopId attribute 25 column 10 desktops creating manually provisioned 41 creating manually unmanaged 41 updating manually provisioned 41 updating manually unmanaged 41 DirectoryServiceCheck monitor 54 discovery script displaying discovered objects 53 operation of 52 running 53 DiskPath attribute 25 display protocol, setting default 35 displaying discovered objects for SCOM 53 information about
VMware View Integration Guide H help, displaying for View PowerCLI cmdlets 30 I importing LDAP configuration data using LDIFDE 50 LDAP configuration data using vdmimport 49 View MPs 52 integration interfaces, introduced 8 IntValue column 11 L LDAP backup frequency, setting default 36 LDAP configuration data 45 exporting using vdmexport 46 importing using LDIFDE 50 importing using vdmimport 49 modifying 46 LDAP Data Interchange Format (LDIF) 45 -ldapBackupFrequency parameter 36 LDIF files 45 LDIFDE comman
Index removing desktop pools 39 running discovery script for SCOM 53 S schema, event database 10 SCOM class and relationship definitions for View 57 closing alerts 57 displaying information about alerts 56 displaying View performance data 56 enabling a proxy agent 55 excluding domains from monitoring 56 integrating with VMware View 51 performance monitor 54 restarting View component services 56 service component monitors 54 SCOM views and monitors 53 Secure Gateway Role Performance Data view 54 SecureGate
VMware View Integration Guide Update-ViewVC cmdlet 32 user events, displaying for VMware View 43 UserCount attribute 26 UserDiskPathId column 10 UserDisplayName attribute 26 UserName attribute 26 users adding entitlements to desktop pools 41 changing ownership of virtual machines 43 displaying entitlements to desktop pools 41 displaying information about 41 removing entitlements to desktop pools 42 removing ownership of virtual machines 43 UserSID column 10 V VCAddress attribute 26 vCenter pathnames,escap
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.
VMware View Integration Guide 70 VMware, Inc.
