Profile Container registry configuration reference

  • 11 minutes to read

Note

When configuring Profile Container registry settings are added here: Registry Key: HKLM\SOFTWARE\FSLogix\Profiles

When configuring Profile Container the entire contents of the registry will be redirected to the FSLogix Profile Container. If it is desired to redirect only Office related information see Profile Container for Office registry configuration reference.

AccessNetworkAsComputerObject

Type DWORD

Default Value 0

Data values and use 0: default – attach as user. 1: attach as computer - folder must have permissions for computer objects.

AttachVHDSDDL

Type REG_SZ

Default Value N/A

Data values and use SDDL string representing the ACLs to use when attaching the VHD.

CCDLocations

Type REG_SZ

Default Value N/A

Data values and use See FSLogix Cloud Cache Configuration Settings for details about configuring.

ConcurrentUserSessions

Type DWORD

Default Value 0

Data values and use 0: don’t handle concurrent sessions. 1: handle concurrent sessions. Note: This setting is used to when the Windows server feature that allows concurrent logins for the same Windows account on the same server is enabled. This scenario is seen most often with Citrix XenApp, when using this configuration this setting should be set to 1|

DeleteLocalProfileWhenVHDShouldApply

Type DWORD

Default Value 0

Data values and use 0: no deletion. 1: delete local profile if exists and matches the profile being loaded from VHD. NOTE: Use caution with this setting. When the FSLogix Profiles system determines a user should have a FSLogix profile, but a local profile exists, Profile Container permanently deletes the local profile. The user will then be signed in with an FSLogix profile.

DiffDiskParentFolderPath

Type REG_SZ

Default Value %TEMP%

Data values and use Specifies the path where difference disks will be created (when ProfileType is configured to use them). Variables may be used in this value. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable.

Enabled

(required setting)

Type DWORD

Default Value 0

Data values and use 0: Profile Containers disabled. 1: Profile Containers enabled

FlipFlopProfileDirectoryName

Type DWORD

Default Value 0

Data values and use When set to ‘1’ the SID folder is created as “%username%%sid%” instead of the default “%sid%%username%”. This setting has the same effect as setting SIDDirNamePattern = “%username%%sid%” and SIDDirNameMatch = “%username%%sid%”.

IsDynamic

Type DWORD

Default Value 1

Data values and use If set to ‘1’ the VHD(X) that is created will be dynamic. If set to ‘0’ the created VHD(X) will be fixed size. This setting is used in conjunction with the SizeInMBs setting to manage the size of Profile and Office Containers. Setting IsDynamic to 1 causes the profile container to use the minimum space on disk, regardless of the allocated SizeInMBs. As a users profile contains more data, the amount of data on disk will grow up to the size specified in SizeInMBs. SizeInMBs is the maximum size that a user will be allowed to use on disk, if the user's profile grows beyond what is specified in SizeInMBs the user will experience errors. Setting IsDynmaic to 1 does NOT allow the user profile to grow larger than what is specified in SizeInMBs.

KeepLocalDir

Type DWORD

Default Value 0

Data values and use 1: The “local_%username%” folder will be left on the system, after sign out. It will also be used again if the same user signs on again.

LockedRetryCount

Type DWORD

Default Value 12

Data values and use Specifies the number of retries attempted when a VHD(X) file is locked (open by another process or computer).

LockedRetryInterval

Type DWORD

Default Value 5

Data values and use Specifies the number of seconds to wait between retries (see LockedRetryCount).

NoProfileContainingFolder

Type DWORD

Default Value 0

Data values and use 1: Profile Container won't use or create a SID containing folder for the VHD(X) file. This setting is intended for situations where storage provides a location that is already unique per-user. Default settings for matching VHD names won't work correctly if this setting is enabled, and VHDs for multiple users are stored in the same location.

OutlookCachedMode

Type DWORD

Default Value 0

Data values and use 1: Only when the Profile Container is attached, the Outlook setting that enables cached mode will temporarily be set until the container is detached. This setting insures cached mode is used only when the container is attached. 0: Prevents FSLogix from doing anything with cached mode. NOTE: Outlook must be configured for online mode for this feature to work. This insures if FSLogix gets disabled, that large OST files won't be downloaded. HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\office\16.0\Outlook\OST\NoOST:DWORD = 2

PreventLoginWithFailure

Type DWORD

Default Value 0

Data values and use If set to 1 Profile Container will load FRXShell if there's a failure attaching to, or using an existing profile VHD(X). The user will receive the FRXShell prompt - default prompt to call support, and the users only option will be to sign out.

PreventLoginWithTempProfile

Type DWORD

Default Value 0

Data values and use If set to 1 Profile Container will load FRXShell if it's determined a temp profile has been created. The user will receive the FRXShell prompt - default prompt to call support, and the users only option will be to sign out.

ProfileDirSDDL

Type REG_SZ

Default Value N/A

Data values and use SDDL string representing the ACLs to use when creating the profile directory (for example “C:\Users%username%). See the What are ACLs and SDDL? appendix for more information. Variables may be used in this SDDL string. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. The most common of these variables used will likely be sid and in the SDDL. This is configured as %sid% in order for it to be processed and replaced.

ProfileType

Type DWORD

Default Value 0

Data values and use 0: Normal profile behavior. 1: Machine should only be the RW profile instance. 2: Machine should only be the RO profile instance. 3: Machine should try to take the RW role and if it can't, it should fall back to a RO role. NOTE: All sessions trying to use the VHD concurrently must have a ProfileType of 1, 2, or 3. If the VHD isn't accessed concurrently, ProfileType should be 0.

ReAttachRetryCount

Type DWORD

Default Value 60

Data values and use Specifies the number of times the system should attempt to reattach the VHD(X) container if it's disconnected unexpectedly.

Re-AttachIntervalSeconds

Type DWORD

Default Value 10

Data values and use Specifies the number of seconds to wait between retries when attempting to reattach the VHD(X) container if it's disconnected unexpectedly.

RebootOnUserLogoff

Type DWORD

Default Value 0

Data values and use A value of ‘0’ means, “Take no action”. A value of ‘1’ means, “Reboot when any user signs out”, a value of ‘2’ means, “Reboot when a FSLogix Profile user signs out”.

RedirectType

Type DWORD

Default Value 2

Data values and use A value of '1' means, Use legacy redirection. A value of '2' (default) means, Use FSLogix advanced redirection.

RedirXMLSourceFolder

Type REG_SZ

Default Value N/A

Data values and use RedirXMLSourceFolder = <path to File System for example "\someserver\someshare">) If the folder contains a redirections.xml, it will be copied to the local profile and immediately used. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable.

RemoveOrphanedOSTFilesOnLogoff

Type DWORD

Default Value 1

Data values and use A value of '0' or lack of this setting results in no action. A value of '1' will cause duplicate OST files to be removed. NOTE: Review the following, in full, before setting. In rare cases, duplicate OST files are created for a user. This circumstance has been documented to occur with and without the use of a non-persistent profile. When the profile is stored in the standard file system, administrators may remove orphaned or stale OST files by deleting them. When using Profile Container the OST file in a VHD, isn't as visible. Over long periods of time duplicate OST files may consume incremental disk space. Setting this option to 1 will cause Profile Container and Profile Container for Office to remove all OST files in a VHD(X), except the OST with the latest modify date. Administrators should be familiar with the use of OST files, and potential implications, before choosing to enable this setting.

RoamSearch

Type DWORD

Default Value 0

Data values and use Used to control the Profile Container Search Roaming feature. Set to '1' or '2' to enable the feature. See Configure Search Roaming for details. NOTE: RoamSearch is set prior to GPOs being applied, it is not possible to rely on GPOs to set RoamSearch in environments where a GoldImage is applied at boot. NOTE: Windows Server 2019 and Windows 10 Entperprise multi-session support per user search. RoamSearch should not be enabled in these environments.

SetTempToLocalPath

Type DWORD

Default Value 3

Data values and use A value of ‘0’ means, “Take no action”. A value of ‘1’ means, “Redirect TEMP and TMP to the local drive”. A value of ‘2’ means, “Redirect INetCache to the local drive”. A value of ‘3’means, “Redirect TEMP, TMP, and INetCache to the local drive.”

ShutdownOnUserLogoff

Type DWORD

Default Value 0

Data values and use A value of ‘0’ means, “Take no action”. A value of ‘1’ means, “Shutdown when any user signs off”, a value of ‘2’ means, “Shutdown when a FSLogix Profile user signs off”.

SIDDirNameMatch

Type REG_SZ

Default Value %sid%_%username%

Data values and use Specifies a string pattern used when creating a SID container folder. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE: In almost all cases, SIDDirNameMatch and SIDDirNamePattern should match. Unless there's a well understood use case that requires these settings to be different, verify SIDDirNameMatch and SIDDirNamePattern are the same when setting either.

SIDDirNamePattern

Type REG_SZ

Default Value %sid%_%username%

Data values and use Specifies a string pattern used when creating a SID container folder. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE: In almost all cases, SIDDirNameMatch and SIDDirNamePattern should match. Unless there's a well understood use case that requires these settings to be different, verify SIDDirNameMatch and SIDDirNamePattern are the same when setting either.

SIDDirSDDL

Type REG_SZ

Default Value N/A

Data values and use SDDL string representing the ACLs to use when creating the SID container folder. See the What are ACLs and SDDL? appendix for more information.|

SizeInMBs

Type DWORD

Default Value 30000

Data values and use Specifies the size of newly created VHD(X) in number of MBs. Default of 30000 = 30 GB

VHDNameMatch

Type REG_SZ

Default Value Profile*

Data values and use Specifies a string pattern used to match (find) the profile VHD(X) file. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%,%osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE-1: In almost all cases, if VHDNameMatch and VHDNamePattern are changed from the default they should match. Unless there's a well understood use case that requires these settings to be different, verify VHDNameMatch and VHDNamePattern are the same when changing either setting. NOTE-2: Beginning in 2.9.4 VHDNameMatch appends either .vhd or .vhdx to the Name Match string. Before 2.9.4 this search used a ".*" rather than specifying the file type. the VolumeType setting will determine which file type is appended.

VHDNamePattern

Type REG_SZ

Default Value Profile_%username%

Data values and use Specifies a string pattern used when creating a profile VHD(X) file. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%,%osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE: In almost all cases, if VHDNameMatch and VHDNamePattern are changed from the default they should match. An administrator should have a well understood use case that requires these settings to be different, verify VHDNameMatch and VHDNamePattern are the same when changing either setting.

VHDLocations

(required setting)

Type MULTI_SZ or REG_SZ

Default Value N/A

Data values and use A list of file system locations to search for the user’s profile VHD(X) file. If one isn't found, one will be created in the first listed location. If the VHD path doesn't exist, it will be created before it checks if a VHD(X) exists in the path. These values can contain variables that will be resolved. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, and any environment variable. When specified as a REG_SZ value, multiple locations can be separated with a semi-colon.

VHDXSectorSize

Type DWORD

Default Value 0

Data values and use Sector size to use if the file being created is a VHDX. Currently can only be 512 (0x200) or 4096 (0x1000). Setting of 0 (default setting) results in system default being used

VolumeType

Type REG_SZ

Default Value "vhd"

Data values and use A value of "vhd" means that newly created files should be of type VHD. A value of "vhdx" means that newly created files should be of type VHDX.

VolumeWaitTimeMS

Type DWORD

Default Value 20000

Data values and useSpecifies the number of milliseconds the system should wait for the volume to arrive after the VHD(X) has been attached. Default value of 20000 = 20 seconds