The FSLogix Profile Migration Module is currently private preview. This preview version is provided without a service level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. FSLogix Profile Container may not support all functionality of the formats that are converted. For more information, see Supplemental Terms of Use for Microsoft Azure Previews at https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/.
PowerShell Module for Converting UPD/Roaming Profiles to FSLogix Profile Containers Overview
The tools will allow the users to perform mass conversions of user profiles from various (specified) types to FSLogix based Profile Containers at scale. This document contains the detailed instructions of tool code base and structure of the code with commands to be executed with detailed examples.
The target audience of this tool is System administrators to migrate the system profiles with full permissions on the machine to execute the code to migrate the system profiles to FSLogix containers.
Following are the list of PowerShell modules to be installed before the execution of the code:
| Module | Install Command |
|---|---|
| ActiveDirectory | Add-WindowsFeature RSAT-AD-PowerShell |
| Hyper-V | Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All |
| Pester (version 4.8.1 or above) | Install-Module -Name Pester -Force -SkipPublisherCheck |
Administrator must have (at least) read access to ALL files in source profile. Any files that are not visible will not be copied. This script does not change source permissions.
Download/extract the zip file from Releases. Place the FSLogixMigration-#.#.# Folder in a PSModule directory (e.g. C:\Users<USERNAME>\Documents\WindowsPowerShell\Modules), and import the module with:
Import-Module FSLogixMigration
If the module is imported successfully you will see the welcome message.
At the time of import, a check will be done for the following modules:
ActiveDirectory
Hyper-V
Pester
If any of these modules are not found, a warning message will be displayed:
ActiveDirectory Module not found on this machine. This module is required to read user SIDs to migrate profiles.
Hyper-V Module not found on this machine. This module is required to create VHDs.
Pester Module version 4.8.1 or higher was not found on this machine. This module is required to run Pester Tests.
The FSLogixMigration Module has two main functions, and a subset of helper functions, that are used within the main functions.
Convert-RoamingProfile – Converts a roaming profile to an FSLogix Profile Container
Convert-UPDProfile – Converts a user profile disk to an FSLogix Profile Container
Convert-UPMProfile - Converts a UPM Profile to an FSLogix Profile Container. UPM Conversion has had minimal testing in small environments.
Get-ProfileSource – Takes input for the source type/path
New-MigrationObject – Creates a PowerShell object, which the script refers to for each migration
Mount-UPDProfile – Mounts a user profile disk to copy data
New-ProfileDisk – Creates a VHD or VHDX at the Target location
Copy-Profile – Runs a Robocopy from source to destination
New-ProfileReg – Creates an FSLogix Registry .reg file
Write-Log – Used to write verbose commands and log
Convert-RoamingProfile
Convert-RoamingProfile -ParentPath <String> -Target <String> -VHDMaxSizeGB <UInt64> -VHDLogicalSectorSize <String> [-VHD] [-IncludeRobocopyDetail] [-LogPath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Convert-RoamingProfile -ProfilePath <String> -Target <String> -VHDMaxSizeGB <UInt64> -VHDLogicalSectorSize <String> [-VHD] [-IncludeRobocopyDetail] [-LogPath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Convert-RoamingProfile -CSV <String> -Target <String> -VHDMaxSizeGB <UInt64> -VHDLogicalSectorSize <String> [-VHD] [-IncludeRobocopyDetail] [-LogPath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Convert-UPDProfile
Convert-UPDProfile -ParentPath <String> -Target <String> -VHDMaxSizeGB <UInt64> -VHDLogicalSectorSize <String> [-VHD] [-SwapDirectoryNameComponents] [-IncludeRobocopyDetail] [-LogPath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Convert-UPDProfile -ProfilePath <String> -Target <String> -VHDMaxSizeGB <UInt64> -VHDLogicalSectorSize <String> [-VHD] [-SwapDirectoryNameComponents] [-IncludeRobocopyDetail] [-LogPath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Convert-UPDProfile -CSV <String> -Target <String> -VHDMaxSizeGB <UInt64> -VHDLogicalSectorSize <String> [-VHD] [-SwapDirectoryNameComponents] [-IncludeRobocopyDetail] [-LogPath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
PS C:\>Convert-UPDProfile -ParentPath F:\Shares\UPDs -Target F:\Shares\FSLogixProfiles -VHDMaxSizeGB 30 -VHDLogicalSectorSize 4K -SwapDirectoryNameComponents -LogPath F:\LogFiles\UPDtoFSLogixMigration\Log.txt
The example above will take inventory of all child-item directories, create a VHDX with a max size of 30GB, and copy the source profiles to their respective destinations. FSLogix Profile directory names will be created using username_SID to work with GPO setting 'Swap directory name components'
PS C:\>Convert-RoamingProfile -ParentPath "C:\Users\" -Target "\\Server\FSLogixProfiles$" -MaxVHDSize 20 -VHDLogicalSectorSize 512
The example above will take inventory of all child-item directories, create a VHDX with a max size of 20GB, Sector Size 512, and copy the source profiles to their respective destinations.
PS C:\>Convert-RoamingProfile -ProfilePath "C:\Users\User1" -Target "\\Server\FSLogixProfiles$" -MaxVHDSize 20 -VHDLogicalSectorSize 512 -VHD -IncludeRobocopyDetails -LogPath C:\temp\Log.txt
The example above will take the User1 profile, create a VHD with a max size of 20GB, Sector Size 512, and copy the source profiles to their respective destinations. /TEE will be added to Robocopy parameters, and a Log will be generated at C:\Temp\Log.txt
PS C:\>Convert-UPDProfile -ParentPath "C:\Users\" -Target "\\Server\FSLogixProfiles$" -MaxVHDSize 20 -VHDLogicalSectorSize 512
The example above will take inventory of all child-item directories, create a VHDX with a max size of 20GB, Sector Size 512, and copy the source profiles to their respective destinations.
PS C:\>Convert-UPDProfile -ProfilePath "C:\Users\UserDisk1.vhd" -Target "\\Server\FSLogixProfiles$" -MaxVHDSize 20 -VHDLogicalSectorSize 512 -VHD -IncludeRobocopyDetails -LogPath C:\temp\Log.txt
The example above will take the User1 profile, create a VHD with a max size of 20GB, Sector Size 512, and copy the source profiles to their respective destinations. /TEE will be added to Robocopy parameters, and a Log will be generated at C:\Temp\Log.txt
If you received the following error message:
Unable to resolve package source ‘https://www.powershellgallery.com/api/v2’
Solution:
Run PowerShell as Administrator and run the following command to force to use TLS1.2 protocol
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12