Configuration examples
The example configurations outlined in this article are a progression of complexity based on configuration choices. Each example has an associated configuration focused on redundancy or disaster recovery. We recommend customers select the simplest configuration for their environment. Adding unnecessary complexity leads to incorrect configurations and support cases.
Note
Use these examples as a starting point of your FSLogix configuration. The ideas and concepts in these examples should inform your unique organizational requirements.
EXAMPLE 1: Standard
The Standard configuration example is the simplest configuration in which most customers should consider.
Prerequisites (Standard)
- FSLogix prerequisites including antivirus exclusions
- Azure Virtual Desktop or equivalent Virtual Desktop infrastructure.
- SMB File Share.
- Validated share and NTFS permissions.
Configuration Items (Standard)
| Items | Description |
|---|---|
| Single VHD location | The VHDLocations setting contains a single UNC path to an SMB file share. |
| Single container | A single Profile container is created for the user. The ODFC container isn't configured. |
| No concurrent connections | The ProfileType setting is set to 0 or not configured. A user's profile can only be mounted within a single connection. |
| No custom profile redirections | No use of redirections.xml file. |
Registry Settings (Standard)
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| SizeInMBs | DWORD | 30000 | Default |
| VHDLocations | MULTI_SZ or REG_SZ | \\<storage-account-name>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
EXAMPLE 2: Standard + High Availability (Cloud Cache)
The Standard + High Availability configuration example expands on the Standard example by using Cloud Cache to provide regional availability for the profile container.
Figure 1: FSLogix High Availability using Cloud Cache
Prerequisites (Standard + High Availability)
- FSLogix prerequisites including antivirus exclusions
- Azure Virtual Desktop or equivalent Virtual Desktop infrastructure.
- Multiple storage providers in the same region or zone-redundant storage.
- Validated NTFS and share-level permissions (SMB only).
Configuration Items (Standard + High Availability)
| Items | Description |
|---|---|
| Container redundancy | The CCDLocations contains at least 2 storage providers of varying kinds. The storage providers are in the SAME region as the virtual machines. |
| Single container | A single Profile container is created for the user. The ODFC container isn't configured. |
| No concurrent connections | The ProfileType setting is set to 0 or not configured. A user's profile can only be mounted within a single connection. |
| No custom profile redirections | No use of redirections.xml file. |
Registry Settings (Standard + High Availability)
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| SizeInMBs | DWORD | 30000 | Default |
| CCDLocations | MULTI_SZ or REG_SZ | type=smb,name="FILES SMB PROVIDER",connectionString=\\<storage-account-name-1>.file.core.windows.net\<share-name>;type=smb,name="ANF SMB PROVIDER",connectionString=\\<azure-netapp-files-fqdn>\<volume-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
EXAMPLE 3: Standard + Disaster Recovery (no profile recovery)
The Standard + Disaster Recovery configuration example expands on the Standard example through duplicate, powered down infrastructure in another region. There's no profile recovery as the user's create new profiles in the new location. No profile recovery is the least complex recovery scenario. The major drawback is the experience and training for end users is a critical component for success.
Figure 2: No Profile Recovery | FSLogix standard containers (VHDLocations)
Prerequisites (Standard + Disaster Recovery)
- FSLogix prerequisites including antivirus exclusions
- Azure Virtual Desktop or equivalent Virtual Desktop infrastructure.
- Duplicate storage and compute infrastructure in another region.
- Validated NTFS and share-level permissions (SMB only).
Configuration Items (Standard + Disaster Recovery)
| Items | Description |
|---|---|
| Single VHD location | The VHDLocations setting contains a single UNC path to an SMB file share. |
| Single container | A single Profile container is created for the user. The ODFC container isn't configured. |
| No concurrent connections | The ProfileType setting is set to 0 or not configured. A user's profile can only be mounted within a single connection. |
| No custom profile redirections | No use of redirections.xml file. |
Registry Settings (Standard + Disaster Recovery)
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| SizeInMBs | DWORD | 30000 | Default |
| VHDLocations | MULTI_SZ or REG_SZ | \\<storage-account-name>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
EXAMPLE 4: Advanced
The Advanced configuration example expands on the Standard example though introducing multiple VHDLocations OR Object-Specific settings AND minimal entries in custom profile redirections.
Prerequisites (Advanced)
- FSLogix prerequisites including antivirus exclusions
- Azure Virtual Desktop or equivalent Virtual Desktop infrastructure.
- Multiple SMB File Share(s).
- Validated NTFS and share-level permissions (SMB only).
Configuration Items (Advanced)
| Items | Description |
|---|---|
| Multiple VHD locations | The VHDLocations setting contains a single or multiple UNC paths (separated by semi-colon) to SMB file shares. |
| Object-specific settings | Allows unique settings based on a user or group SID. |
| Single container | A single profile container is created for the user. The ODFC container isn't configured. |
| No concurrent connections | The ProfileType setting is set to 0 or not configured. A user's profile can only be mounted within a single connection. |
| Minimal redirections.xml | XML file contains minimal entries with minor complexity. |
Tip
Review the Custom profile redirections page for our recommended exclusions.
Registry Settings (Advanced)
Multiple VHDLocations
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| RedirXMLSourceFolder | REG_SZ | \\<server-name>\<share-name> |
Example |
| SizeInMBs | DWORD | 30000 | Default |
| VHDLocations | MULTI_SZ or REG_SZ | \\<storage-account-name-1>.file.core.windows.net\<share-name>;\\<storage-account-name-2>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
Object-Specific VHDLocations
The default VHDLocations is used for any user or group not matched by the object-specific configuration.
Registry Path: HKLM:\SOFTWARE\FSLogix\Profiles\
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| RedirXMLSourceFolder | REG_SZ | \\<server-name>\<share-name> |
Example |
| SizeInMBs | DWORD | 30000 | Default |
| VHDLocations | MULTI_SZ or REG_SZ | \\<storage-account-name>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
Registry Path: HKLM:\SOFTWARE\FSLogix\Profiles\ObjectSpecific\S-0-0-00-000000000-0000000000-000000000-1234\
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| VHDLocations | MULTI_SZ or REG_SZ | \\<server-name>\<share-name> |
Example |
Registry Path: HKLM:\SOFTWARE\FSLogix\Profiles\ObjectSpecific\S-0-0-00-000000000-0000000000-000000000-4321\
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| VHDLocations | MULTI_SZ or REG_SZ | \\<azure-netapp-files-computer-account>.contoso.com\<share-name> |
Example |
Warning
Multiple entries in VHDLocations doesn't provide container resiliency. When multiple entries exist, a user will try to create or locate their container from the list of locations in order. The first location which the user has access to or is available will be where the container is created or attached from. If using multiple entries, users should only have access to a single location. Consider using the object-specific configuration settings in lieu of multiple VHDLocations.
EXAMPLE 5: Advanced + Disaster Recovery (primary / failover)
The Advanced + Disaster Recovery configuration example adds complexity through multiple storage providers in at least two regions and various custom profile redirections. This example removes the Object-Specific configuration as the multi-regional components adds complexity.
Figure 3: Cloud Cache (primary / failover) | FSLogix Cloud Cache (CCDLocations)
Prerequisites (Advanced + Disaster Recovery)
- FSLogix prerequisites including antivirus exclusions
- Azure Virtual Desktop or equivalent Virtual Desktop infrastructure.
- Two storage providers in at least two regions.
- Validated share and NTFS permissions (SMB only).
Configuration Items (Advanced + Disaster Recovery)
| Items | Description |
|---|---|
| Container redundancy | The CCDLocations contains two (2) storage providers1. The primary site is configured with the closest storage provider listed first and failover storage provider provided listed last. The failover site has the reverse configuration. The closest storage provider first, followed by the primary site storage providers listed last. |
| Single container | A single profile container is created for the user. The ODFC container isn't configured. |
| No concurrent connections | The ProfileType setting is set to 0 or not configured. A user's profile can only be mounted within a single connection. |
| Various redirections.xml | XML file contains various entries with moderate complexity. |
1 The storage providers must be in different regions or locations.
Tip
Review the Custom profile redirections page for our recommended exclusions.
Registry Settings (Advanced + Disaster Recovery)
Primary site
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| RedirXMLSourceFolder | REG_SZ | \\<server-name>\<share-name> |
Example |
| SizeInMBs | DWORD | 30000 | Default |
| CCDLocations | MULTI_SZ or REG_SZ | type=smb,name="FILES SMB PRIMARY",connectionString=\\<storage-account-name-primary>.file.core.windows.net\<share-name>;type=smb,name="FILES SMB PROVIDER FAILOVER",connectionString=\\<storage-account-name-failover>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
Failover site
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| RedirXMLSourceFolder | REG_SZ | \\<server-name>\<share-name> |
Example |
| SizeInMBs | DWORD | 30000 | Default |
| CCDLocations | MULTI_SZ or REG_SZ | type=smb,name="FILES SMB FAILOVER",connectionString=\\<storage-account-name-failover>.file.core.windows.net\<share-name>;type=smb,name="FILES SMB PROVIDER PRIMARY",connectionString=\\<storage-account-name-primary>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
EXAMPLE 6: Complex
The Complex configuration example expands on the Advanced example above.though introducing concurrent connections.
Prerequisites (Complex)
- FSLogix prerequisites including antivirus exclusions
- Azure Virtual Desktop or equivalent Virtual Desktop infrastructure.
- Multiple SMB file share(s) (not for high availability).
- Validated share and NTFS permissions (SMB only).
Configuration Items (Complex)
| Items | Description |
|---|---|
| Multiple VHD location | The VHDLocations setting contains a single or multiple UNC paths (separated by semi-colon) to SMB file shares. |
| Object-specific settings | Allows unique settings based on a user or group SID. |
| Single container | A single profile container is created for the user. The ODFC container isn't configured. |
| Concurrent connection(s) | ProfileType is set to 3. Users can have multiple sign-ins, but only one (1) session allows writes to the base VHD disk. |
| Various redirections.xml | XML file contains various entries with added complexity. |
Tip
Review the Custom profile redirections page for our recommended exclusions.
Registry Settings (Complex)
Multiple VHDLocations
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 3 | Example |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| SizeInMBs | DWORD | 30000 | Default |
| VHDLocations | MULTI_SZ or REG_SZ | \\<storage-account-name-1>.file.core.windows.net\<share-name>;\\<storage-account-name-2>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
Object-Specific VHDLocations
The default VHDLocations is used for any user or group not matched by the object-specific configuration.
Registry Path: HKLM:\SOFTWARE\FSLogix\Profiles\
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 3 | Example |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| RedirXMLSourceFolder | REG_SZ | \\<server-name>\<share-name> |
Example |
| SizeInMBs | DWORD | 30000 | Default |
| VHDLocations | MULTI_SZ or REG_SZ | \\<storage-account-name>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
Registry Path: HKLM:\SOFTWARE\FSLogix\Profiles\ObjectSpecific\S-0-0-00-000000000-0000000000-000000000-1234\
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| VHDLocations | MULTI_SZ or REG_SZ | \\<server-name>\<share-name> |
Example |
Registry Path: HKLM:\SOFTWARE\FSLogix\Profiles\ObjectSpecific\S-0-0-00-000000000-0000000000-000000000-4321\
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| VHDLocations | MULTI_SZ or REG_SZ | \\<azure-netapp-files-computer-account>.contoso.com\<share-name> |
Example |
Warning
Multiple entries in VHDLocations doesn't provide container resiliency. When multiple entries exist, a user will try to create or locate their container from the list of locations in order. The first location which the user has access to or is available will be where the container is created or attached from. If using multiple entries, users should only have access to a single location. Consider using the object-specific configuration settings in lieu of multiple VHDLocations.
EXAMPLE 7: Complex + Disaster Recovery (active / active)
The Complex + Disaster Recovery configuration example expands from the advanced + disaster recovery by creating an active / active design. This configuration is not load balancing between the two sites, rather we're relying on users only having access to a single location. During a drill or BCDR event users from a failed region are given access to virtual machines in the working region.
Figure 4: Cloud Cache (active / active) | FSLogix Cloud Cache (CCDLocations)
Prerequisites (Complex + Disaster Recovery)
- FSLogix prerequisites including antivirus exclusions
- Azure Virtual Desktop or equivalent Virtual Desktop infrastructure.
- Separate pools of virtual machines in each location.
- Users only have access to a single region at a time.
- Validated share and NTFS permissions (SMB only).
Configuration Items (Complex + Disaster Recovery)
| Items | Description |
|---|---|
| Container redundancy | The CCDLocations contains two (2) storage providers1. The primary site is configured with the closest storage provider listed first and failover storage provider provided listed last. The failover site has the reverse configuration. The closest storage provider first, followed by the primary site storage providers listed last. |
| Single container | A Profile and ODFC container exists or is created for each user. |
| No concurrent connections | The ProfileType setting is set to 0 or not configured. A user's profile can only be mounted within a single connection. |
| Various redirections.xml | XML file contains various entries with moderate complexity. |
Tip
Review the Custom profile redirections page for our recommended exclusions.
Registry Settings (Complex + Disaster Recovery)
Site A (West US)
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| RedirXMLSourceFolder | REG_SZ | \\<server-name>\<share-name> |
Example |
| SizeInMBs | DWORD | 30000 | Default |
| CCDLocations | MULTI_SZ or REG_SZ | type=smb,name="FILES SMB WEST US",connectionString=\\<storage-account-name-primary>.file.core.windows.net\<share-name>;type=smb,name="FILES SMB PROVIDER EAST US",connectionString=\\<storage-account-name-failover>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
Site B (East US)
| Key Name | Data Type | Value | Description |
|---|---|---|---|
| Enabled | DWORD | 1 | REQUIRED |
| DeleteLocalProfileWhenVHDShouldApply | DWORD | 1 | Recommended |
| FlipFlopProfileDirectoryName | DWORD | 1 | Recommended |
| LockedRetryCount | DWORD | 3 | Recommended |
| LockedRetryInterval | DWORD | 15 | Recommended |
| ProfileType | DWORD | 0 | Default |
| ReAttachIntervalSeconds | DWORD | 15 | Recommended |
| ReAttachRetryCount | DWORD | 3 | Recommended |
| RedirXMLSourceFolder | REG_SZ | \\<server-name>\<share-name> |
Example |
| SizeInMBs | DWORD | 30000 | Default |
| CCDLocations | MULTI_SZ or REG_SZ | type=smb,name="FILES SMB EAST US",connectionString=\\<storage-account-name-failover>.file.core.windows.net\<share-name>;type=smb,name="FILES SMB PROVIDER WEST US",connectionString=\\<storage-account-name-primary>.file.core.windows.net\<share-name> |
Example |
| VolumeType | REG_SZ | VHDX | Recommended |
Appendix: Multiple VHDLocations logic diagram
When using multiple values in the VHDLocations setting, it's important to understand how FSLogix determines the location to use.
Warning
Users who have access to multiple locations may create a new profile in another location if the location for their actual profile is not available.
Figure 5: VHDLocations Logic Diagram
Next steps
Feedback
Submit and view feedback for