User Profile Management - OS Test

User logon is a complex and resource intensive process in a VDI environment, and is a key determinant of the quality of a user’s experience with the VDI service. This process is initiated when a desktop broker’s load balancing algorithm selects the virtual desktop where a published application or desktop, which a user has selected, will be started and ends when the application or desktop is running and the user is able to interact with it.

Delays in the user logon process can therefore serve as key spoilers of a user’s experience with the desktop service, causing significant loss of revenue and reputation in mission-critical VDI environments.

One of the common causes for delays in user logons is a delay in the loading of user profiles. To reduce the time taken to load profiles and thus minimize the user logon time, VDI environments where user connections are brokered through the Citrix XenDesktop Broker, use the Citrix Profile Management solution. Citrix Profile Management is a profile type that supersedes all other profiles for the user.

During logon, the Profile management service manages the user settings in a user profile. This service helps minimize the user logon time by enabling administrators to exclude (and include) certain files and folders in order to prevent extraneous settings from needlessly being copied with the profile. For example, some applications may create folders and files that account for tens or hundreds of megabytes - data that is really not required. By excluding these items, the profile is thus smaller, and smaller profiles load faster. Alternatively, you could elect to only include specific files and folders, thus keeping to a minimum the amount of profile data being managed within the user‘s profile.

Also, upon logoff, the Profile management service merges back only changed user settings to the centrally stored user settings (user‘s store).

In environments where the Citrix Profile Management service is utilized therefore, the user experience with the VDI service greatly depends upon how efficient the service is.

Note:

This test is relevant only where the Citrix XenDesktop Broker is used to broker connections between the user and the desktops.

To ascertain the efficiency of the Citrix Profile Management service, VDI administrators may have to periodically track the logon/logoff duration and profile size of each user to the virtual desktops operating on a target virtual host. Doing so will enable these administrators to determine whether/not the Profile management service has succeeded in minimizing both user logon times and profile sizes. The User Profile Management - OS test helps administrators perform this check at pre-configured intervals. The ‘per-user’ performance results reported by this test will not only enable administrators to judge the effectiveness of the Profile management service in its entirety, but will also shed light on those user logons/logoffs that are still experiencing delays; this provides insights into how the service can be fine-tuned to enhance the VDI experience of such users.

This test is disabled by default. To enable the test, go to the enable / disable tests page using the menu sequence: Agents -> Tests -> Enable/Disable, pick VMware vSphere VDI as the Component type, set Performance as the Test type, choose this test from the disabled tests list, and click on the >> button to move the test to the enabled tests list.

Target of the test : An ESX server host

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for every user who is connected to a virtual desktop via ICA.

Configurable parameters for the test:
Parameter Description

Test Period

How often should the test be executed

Host

The host for which the test is to be configured

Port

The port at which the specified HOST listens. By default, this is NULL.

ESX User and ESX Password

In order to enable the test to extract the desired metrics from a target ESX server, you need to configure the test with an ESX USER and ESX PASSWORD. The user credentials to be passed here depend upon the mechanism used by the eG agent for auto-discovering the VMs on the target vSphere server and monitoring the server and its VMs. These discovery/monitoring methodologies and their corresponding configuration requirements have been discussed hereunder:

  • Discovering and monitoring by directly connecting to the target vSphere server: Starting with ESX server 3.0, a VMware ESX server offers a web service interface using which the eG agent discovers the guest operating systems on a physical ESX host. The VMware VI SDK is used by the agent to implement the web services interface. To use this interface for discovering the VMs and for monitoring, the eG agent should directly connect to the monitored vSphere/ESX server as an ESX USER with root privileges. However, if, owing to security constraints, you cannot use root user permissions, you can alternatively configure the tests with the credentials of a user who has been assigned the following permissions:

    • Diagnostics

    • TerminateSession

    To see how you can create such a user on the ESX server, refer to theCreating a Special Role on an ESX Server and Assigning the Role to a New User topic

  • Discovering and monitoring using vCenter: By default, the eG agent connects to each ESX server and discovers the VMs executing on it. While this approach scales well, it requires additional configuration for each server being monitored. For example, separate user accounts may need to be created on each server for accessing VM details. While monitoring large virtualized installations however, the agents can be optionally configured to perform guest discovery using the VM information already available in vCenter. The same vCenter can also be used to monitor the vSphere server and its VMs. In this case therefore, the ESX USER and ESX PASSWORD that you specify should be that of an Administrator or Virtual Machine Administrator in vCenter. However, if, owing to security constraints, you prefer not to use the credentials of such users, then, you can create a special role on vCenter with the following privileges:

    • Diagnostics

    • Change settings

    • View and stop sessions

    To know how to grant the above-mentioned permissions to a vCenter user, refer to Creating a Special Role on vCenter and Assigning the Role to a New User .

    If the ESX server for which this test is being configured had been discovered via vCenter, then the eG manager automatically populates the ESX USERand ESX PASSWORD text boxes with the vCenter user credentials using which the ESX discovery was performed.

Confirm Password

Confirm the specified ESX PASSWORD by retyping it here.

SSL

By default, the ESX server is SSL-enabled. Accordingly, the SSL flag is set to Yes by default. This indicates that the eG agent will communicate with the ESX server via HTTPS by default. On the other hand, if the eG agent has been configured to use the VMPerl API or CLI for monitoring (i.e., if the ESX USER parameter is set to none), then the status of the SSL flag is irrelevant.

Like the ESX sever, the vCenter is also SSL-enabled by default. If you have chosen to use the vCenter for monitoring all the ESX servers in your environment, then you have to set the SSL flag to Yes.

Webport

By default, in most virtualized environments, the ESX server and vCenter listen on port 80 (if not SSL-enabled) or on port 443 (if SSL-enabled). This implies that while monitoring an SSL-enabled ESX server directly, the eG agent, by default, connects to port 443 of the ESX server to pull out metrics, and while monitoring a non-SSL-enabled ESX server, the eG agent connects to port 80. Similarly, while monitoring an ESX server via an SSL-enabled vCenter, the eG agent connects to port 443 of vCenter to pull out the metrics, and while monitoring via a non-SSL-enabled vCenter, the eG agent connects to port 80 of vCenter. Accordingly, the WEBPORT parameter is set to 80 or 443 depending upon the status of the SSL flag.  In some environments however, the default ports 80 or 443 might not apply. In such a case, against the WEBPORT parameter, you can specify the exact port at which the ESX server or vCenter in your environment listens so that the eG agent communicates with that port.

Virtual Center

If the eG manager had discovered the target ESX server by connecting to vCenter, then the IP address of the vCenter server used for discovering this ESX server would be automatically displayed against the VIRTUAL CENTER parameter; similarly, the ESX USER and ESX PASSWORD text boxes will be automatically populated with the vCenter user credentials, using which ESX discovery was performed.

If this ESX server has not been discovered using vCenter, but you still want to discover the guests on the ESX server via vCenter, then select the IP address of the vCenter host that you wish to use for guest discovery from the VIRTUAL CENTER list. By default, this list is populated with the IP address of all vCenter hosts that were added to the eG Enterprise system at the time of discovery. Upon selection, the ESX USERand ESX PASSWORD that were pre-configured for that vCenter server will be automatically displayed against the respective text boxes.

On the other hand, if the IP address of the vCenter server of interest to you is not available in the list, then, you can add the details of the vCenter server on-the-fly, by selecting the Other option from the VIRTUAL CENTER list. This will invoke the ADD VCENTER SERVER DETAILS page. Refer to Adding the Details of a vCenter Server for VM Discoverysection to know how to add a vCenter server using this page. Once the vCenter server is added, its IP address, ESX USER, and ESX PASSWORD will be displayed against the corresponding text boxes.

On the other hand, if you want the eG agent to behave in the default manner -i.e., communicate with each ESX server for monitoring and VM information - then set the VIRTUAL CENTER parameter to ‘none’.

Exclude VMs

Administrators of some virtualized environments may not want to monitor some of their less-critical VMs - for instance, VM templates - both from ‘outside’ and from ‘inside’. The eG agent in this case can be configured to completely exclude such VMs from its monitoring purview. To achieve this, provide a comma-separated list of VMs to be excluded from monitoring in the EXCLUDE VMS text box. Instead of VMs, VM name patterns can also be provided here in a comma-separated list. For example, your exclude vms specification can be: *xp,*lin*,win*,vista. Here, the * (asterisk) is used to denote leading and trailing spaces (as the case may be). By default, this parameter is set to none indicating that the eG agent obtains the inside and outside views of all VMs on a virtual host by default. By providing a comma-separated list of VMs/VM name patterns in the EXCLUDE VMS text box, you can make sure the eG agent stops collecting ‘inside’ and ‘outside’ view metrics for a configured set of VMs.

Exclude IP

Typically, when performing VM discovery, the eG agent automatically discovers the operating system on which every VM runs, and all the IP addresses that each VM supports. If two are more VMs on a target vSphere server are in a VM cluster, then the eG agent will also auto-discover the cluster IP address. Since the cluster IP address is shared by all VMs in the cluster, this IP address will be in the discovery list of every VM in the cluster. In this case, if the eG agent attempts to obtain the 'inside view' of each VM in a cluster using their cluster IP address, incorrect metrics may be reported sometimes. To avoid this, you may want to instruct the eG agent to not use the cluster IP address when collecting 'inside view' metrics. For this, specify a comma-separated list of cluster IP addresses to be excluded in the EXCLUDE IP text box.

Ignore VMs Inside View

Administrators of some high security VMware environments might not have permissions to internally monitor one/more VMs. The eG agent can be configured to not obtain the ‘inside view’ of such ‘inaccessible’ VMs using the IGNORE VMS INSIDE VIEW parameter. Against this parameter, you can provide a comma-separated list of VM names, or VM name patterns, for which the inside view need not be obtained. For instance, your IGNORE VMS INSIDE VIEW specification can be: *xp,*lin*,win*,vista. Here, the * (asterisk) is used to denote leading and trailing spaces (as the case may be). By default, this parameter is set to none indicating that the eG agent obtains the inside view of all VMs on an ESX host by default.

Note:

While performing VM discovery, the eG agent will not discover the operating system of the VMs configured in the IGNORE VMS INSIDE VIEW text box.

Ignore WINNT

By default, the eG agent does not support the inside view for VMs executing on Windows NT operating systems. Accordingly, the IGNORE WINNT flag is set to Yes by default.

Inside view using

By default, this test obtains the “inside view” of VMs using the eG VM Agent. Accordingly, the inside view using flag to eG VM Agent by default. The eG VM Agent is a piece of software, which should be installed on every VM on a hypervisor. Every time the eG agent runs this test, it uses the eG VM Agent to pull relevant 'inside view' metrics from each VM. Once the metrics are collected, the eG agent then communicates with each VM agent and pulls these metrics, without requiring administrator privileges. Refer to Configuring the Remote Agent to Obtain the Inside View of VMs for more details on the eG VM Agent.

Domain, Admin User, and Admin Password, and Confirm Password

By default, these parameters are set to none. This is because, by default, the eG agent collects 'inside view' metrics using the eG VM agent on each VM. Domain administrator privileges need not be granted to the eG agent if it uses this default approach to obtain the 'inside view' of Windows VMs.

Report By User

This flag is set to Yes by default. The value of this flag cannot be changed. This implies that the virtual machines in VDI environments will always be identified using the login name of the user. In other words, in VDI environments, this test will, by default, report measures for every username_on_virtualmachinename.

Report Powered OS

This flag becomes relevant only if the REPORT BY USERflag is set to ‘Yes’

If the REPORT POWERED OS flag is set to Yes (which is the default setting), then this test will report measures for even those VMs that do not have any users logged in currently. Such guests will be identified by their virtualmachine name and not by the username_on_virtualmachinename. On the other hand, if the REPORT POWERED OS flag is set to No, then this test will not report measures for those VMs to which no users are logged in currently.

Measurements made by the test

Measurement Description Measurement Unit Interpretation

Logon Duration:

Indicates the duration of logon processing for this user.

Secs

This value helps to measure the reduction in logon times when the Profile Management service ‘streams’ the profile. Ideally therefore, this value should be low. A high value or a consistent increase in the value of this measure could indicate that profile loading still takes a lot of time at logon - this could be owing to a large profile size. You can then check the value reported by the Logon Bytes measure to know the profile size at logon. If profile sizes continue to grow at logon despite the use of Profile management, it is indicative of the ineffectiveness of profile management. You may then have to fine-tune the feature to further reduce the profile size by excluding more unnecessary files from the profile, or you may have to explore other options such as roaming profiles, mandatory profiles, etc. 

Logon Bytes:

Indicates the size of this user’s profile when it is retrieved from the user’s store at logon.

MB

Ideally, the value of this measure should be low. A low profile size could result in faster profile loading at logon, lesser time to login, and consequently, a richer user experience with the VDI service. 

If profile sizes continue to grow despite the use of Profile management, it is indicative of the ineffectiveness of profile management. You may then have to fine-tune the feature to further reduce the profile size by excluding more unnecessary files from the profile.

Logoff Duration:

Indicates the duration of logoff processing for this user.

Secs

A low value is desired for this measure. A high value could indicate that the profile management service takes too long to update the user’s store with changes in the user settings. This could be because of a bad network connection between the virtual desktop and the user’s store, or because too many changes are waiting to be written to the user store.

Logoff Bytes:

Indicates the size of this user’s profile when it is copied to the user store at logoff.

MB

This measure provides a fair idea of the volume of changes that were copied to the user’s store at logoff.

Local Profile Setup Duration:

Indicates the time taken to create or prepare this user’s profile on the local computer.

Secs

A low value is desired for these measures.

If a user complaints of delays during logon, you can use the value of these measures to determine where the VDI service is spending too much time - is it when setting up the local profile? or is it when deleting the local profile?

Delete Local Profile Duration:

Indicates the time spent deleting this user’s local profiles during the initial migration.

Secs

Processed Logon Files - Under 1KB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logon and categorized by the file size of 1KB.

Number

All the Processed Logon Files measures help VDI administrators to understand whether/not ‘profile streaming’ (performed by the Profile Management service) has helped  in reducing the number of locally copied files during logon.

All the Processed Logoff Files measures help VDI administrators to understand how many files changed when the user session was in progress.

 

 

Processed Logoff Files - Under 1KB:

Indicates the number of locally copied file for this user’s profile that are synchronized during logoff and categorized by the file size of 1KB.

Number

Processed Logon Files from 1KB to 10KB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logon and categorized by the file size ranging from 1KB to 10KB.

Number

Processed Logoff Files from 1KB to 10KB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logoff and categorized by the file size ranging from 1KB to 10KB.

Number

Processed Logon Files from 10KB to 100KB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logon and categorized by the file size ranging from 10KB to 100KB.

Number

Processed Logoff Files from 10KB to 100KB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logoff and categorized by the file size ranging from 1KB to 10KB.

Number

All the Processed Logon Files measures help VDI administrators to understand whether/not ‘profile streaming’ (performed by the Profile Management service) has helped  in reducing the number of locally copied files during logon.

All the Processed Logoff Files measures help VDI administrators to understand how many files changed when the user session was in progress.

Processed Logon Files from 100KB to 1MB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logon and categorized by the file size ranging from 100KB to 1MB.

Number

Processed Logoff Files from 100KB to 1MB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logoff and categorized by the file size ranging from 100KB to 1MB.

Number

Processed Logon Files from 1MB to 5MB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logon and categorized by the file size ranging from 1MB to 5MB.

Number

Processed Logoff Files from 1MB to 5MB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logoff and categorized by the file size ranging from 1MB to 5MB.

Number

All the Processed Logon Files measures help VDI administrators to understand whether/not ‘profile streaming’ (performed by the Profile Management service) has helped  in reducing the number of locally copied files during logon.

All the Processed Logoff Files measures help VDI administrators to understand how many files changed when the user session was in progress.

 

 

Processed Logon Files Above 5MB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logon and categorized by the file size above 5MB.

Number

Processed Logoff Files Above 5MB:

Indicates the number of locally copied files for this user’s profile that are synchronized during logoff and categorized by the file size above 5MB.

Number