FSLogix Profile Details Test

FSLogix is a container-based solution that is used to store the Windows User Profile or Office-related files (like those used with Outlook and OneDrive) of users logged into non-persistent VDI machines, within a VHD/VHDX file on a network share.

FSLogix has two container-based technologies namely Profile Containers and Office Containers. Profile Containers encompass the entire user profile while Office Containers cover the part of the user profile pertaining to Microsoft Office and supporting technologies like Microsoft OneDrive.

Profile Container moves all profile files and folders of the users into a VHD / VHDX file in the network and then mounts it as a container in the target system when the users log into the target system. This will replace the existing profile solutions where the files are copied over the network to the target system, like Roaming Profile or Universal Profile Management.

In a Citrix Virtual Apps environment, the profile container is dynamically attached to the user soon after the user attempts to log into a non persistent VDI machine using a natively supported Virtual Hard Disk (VHD) and a Hyper-V Virtual Hard Disk (VHDX). The user profile is immediately available and appears in the system exactly like a native user profile. The files of the users are stored in their corresponding VHD or VHDX.

If, for any reason, the profile container fails to attach to the user or takes a longer duration, then the logon process may take longer than usual or may eventually fail. Similarly, if the user exhausts the disk space allocated for their user profile, then the activities performed by that user could not be saved and hence the data will be lost once the user disconnects the session. This will impact the productivity of the users and overall user experience with the Virtual Apps server. Therefore, it is imperative that administrators keep track of the time taken for attaching the Profile container to the user and the disk space allocated to the user. This can be easily achieved using the FSLogix Profile Details test.

This test tracks the FSLogix profile containers created for each user and alerts administrators if any user is experiencing undue slowness while the Profile containers are attached to the users. This test also monitors the disk space allocated to the users and identifies the user profiles that are currently running out of disk space. This way, administrators are prompted to rapidly initiate remedial measures, so that bottlenecks can be resolved before it impacts the user experience and productivity. This test also reports additional metrics for the Summary descriptor which throws light on the following:

whether/not the FSLogix profile container is enabled
whether/not the FSLogix application service is running
the profile type
whether/not storage space allocated to the VHD(X) file used for storing the user profile is dynamic and
whether/not concurrent user sessions are allowed for the FSLogix user profiles.

Using the metrics reported by the Summary descriptor, administrators are proactively alerted to issues that arise when the FSLogix profile container is not enabled or the FSLogix application service is not running.

Target of the test: A Citrix Virtual Apps Server

Agent deploying the test: An internal agent

Outputs of the test: One set of results for each user who is currently logged into Citrix Virtual Apps server being monitored

Configurable parameters for the test
Parameters	Description
Test period	How often should the test be executed
Host	The host for which the test is to be configured.
Port	Specify the port at which the configured host listens.
Report by Domain Name	By default, this flag is set to Yes. This implies that by default, the domainname\username of each user logged into a desktop OS machine, will be displayed as a descriptor of this test. This way, administrators will be able to quickly determine which user logged into the desktop from which domain. If you want the only the username of these users (and not domain name\username) to be displayed as descriptors, set this flag to No.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enabled/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test

Measurement

Description

Measurement Unit

Interpretation

FSLogix profile container attached status

Indicates whether/not the FSLogix profile container is attached for this user.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value
Attached success	0
The system is in an error state	1
Virtual Disk API ("virtdisk.dll") cannot be found	2
Unable to get the user SID	3
Security API failed	5
Error determining the path to the VHD/X file	6
Error creating a directory	7
Error impersonating the user	8
Error creating the VHD/X file	9
Error closing a handle	10
Error opening the VHD/X file	11
Error attaching the VHD/X	12
Error getting the physical path of the virtual disk	13
Error opening the device	14
Error initializing the disk	15
Error retrieving the volume GUID	16
Error formatting the volume	17
Unable to determine the user's profile directory	18
Error creating a junction in the file system	19
Error importing registry data	20
Error checking group membership for the user	21
Error trying to determine the profile type	22
Error processing the redirections.xml file	23
Waiting for the Windows Profile Service to begin creation of the user's profile	0.1
In progress	0.2
Already attached	0.3

Note:

By default, this measure reports the above-mentioned values to indicate whether/not the FSLogix profile container is attached. The graph of this measure however is represented using the numeric equivalents i.e., 0 or 1.

The detailed diagnosis of this measure lists the Profile name, Volume name, VHD root file path, VHD location, Error info, Profile start date, Profile end date, Duration(Seconds), Session ID and Session name.

Reason

Indicates the reason i.e., how the FSLogix profile container is attached for this user.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value	Explanation
Attached with error	0	The FSLogix Profile has been attached with errors
Not in white list	1	The user is not a member of the FSLogix Include group, and should therefore not receive a FSLogix Profile.
In black list	2	The user is a member of the FSLogix Exclude group, and should therefore not receive a FSLogix Profile.
Local profile exists	3	A local profile for the user already exists.
Short SID	4	The FSLogix system will not handle profiles for special users.
Unset	5	The FSLogix system has been initialized to empty state.
Component not enabled	6	Component is not enabled in product key (legacy)
Windows temporary profile	7	The FSLogix profile is a Windows temporary profile.
Not AVD session	8	The FSLogix Session is not an Azure Virtual Desktop Session.
Profile load failed	9	The FSLogix Profile had failed to load.

Note:

By default, this measure reports the above-mentioned values to indicate how the FSLogix profile container is attached for this user. The graph of this measure however is represented using the numeric equivalents i.e., 0 to 4.

The detailed diagnosis of this measure lists the name of the user, reason, status, VHD location of the user profile, Error information, Profile start date, Profile end date, Duration(Seconds), Session ID and Session name.

FSLogix profile load duration

Indicates the time taken to load this user’s FSLogix profile.

Seconds

A low value is desired for this measure.

A high value for this measure indicates that the user profile is taking too long to load. A persistently high value may have an impact on the user experience and productivity.

FSLogix profile logon notification duration

Indicates the time taken for displaying this user's FSLogix profile logon notification.

Seconds

FSLogix disk capacity

Indicates the disk capacity allocated to this user's FSLogix profile.

FSLogix disk free lspace

Indicates the amount of space available for use in the disk allocated to this user's FSLogix profile.

A high value is desired for this measure.

FSLogix disk used space

Indicates amount of space that is already utilized from the disk space allocated to this user's profile.

A value close to the FSLogix disk capacity measure indicates that the user profile is currently running out of space.

FSLogix disk usage

Indicates the percentage of disk space utilized by this user's FSLogix profile.

Percent

A high value indicates that the FSLogix profile of the user is running out of disk space.

Is FSLogix profile container enabled?

Indicates whether/not the FSLogix profile container is enabled.

This measure is applicable only for the 'Summary' descriptor.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value
No	0
Yes	1

Note:

By default, this measure reports the above-mentioned values to indicate whether/not the FSLogix profile container is enabled. The graph of this measure however is represented using the numeric equivalents i.e., 0 or 1.

Is FSLogix application service running?

Indicates whether/not the FSLogix application service is running.

This measure is applicable only for the 'Summary' descriptor.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value
No	0
Yes	1

Note:

By default, this measure reports the above-mentioned values to indicate whether/not the FSLogix application service is running. The graph of this measure however is represented using the numeric equivalents i.e., 0 or 1.

Profile type

Indicates the type of FSLogix profile.

This measure is applicable only for the 'Summary' descriptor.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value
Normal	0
Read-Write	1
Read-Only	2
Read-Write fall-back to Read-Only	3

Note:

By default, this measure reports the above-mentioned values to indicate the type of FSLogix profile. The graph of this measure however is represented using the corresponding numeric equivalents only i.e., 0 to 3.

Is dynamic VHD(X)?

Indicates whether/not the size of the VHD(X) files on which the profiles are placed grows dynamically.

This measure is applicable only for the 'Summary' descriptor.

Profiles are placed in VHD(X) files and mounted at run time.

If Dynamic VHD(X) allocation is enabled i.e., if the value of this measure is Yes, the VHD(X) files are assigned dynamically. This means that the file size of the VHD(X) file only grows when data is added to the Profile/Office Container. If this option is not enabled, automatically created VHD(X) files will be directly allocated to the full data storage space.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value
No	0
Yes	1

Note:

By default, this measure reports the above-mentioned values to indicate wwhether/not the size of the VHD(X) files on which the profiles are placed grows dynamically. The graph of this measure however is represented using the numeric equivalents i.e., 0 or 1.

Is allow concurrent user sessions?

Indicates whether/not concurrent sessions are allowed for the FSLogix profiles.

This measure is applicable only for the 'Summary' descriptor.

If the value of this measure is Yes, then it indicates that the target system is multi-session enabled and allows simultaneous logins for the same Windows account on the same server.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value
No	0
Yes	1

Note:

By default, this measure reports the above-mentioned values to indicate whether/not concurrent sessions are allowed for the FSLogix profiles. The graph of this measure however is represented using the numeric equivalents i.e., 0 or 1.

Is profile using cloud cache?

Indicates whether/not the profile container of this user is configured with cloud cache.

If the value of this measure is Yes, then it indicates that the cloud cache is configured on the profile container attached to each user.

The measure values that this test can report and their corresponding numeric values are listed in the table below:

Measure Value	Numeric Value
No	0
Yes	1

Note:

By default, this measure reports the above-mentioned values to indicate whether/not cloud cache is configured on the FSLogix profile container attached to each user. The graph of this measure however is represented using the numeric equivalents i.e., 0 or 1.