MigrateCitrixUPMtoFSLogix.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\MigrateCitrixUPMtoFSLogix.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName MigrateCitrixUPMtoFSLogix.Import.DoDotSource -Fallback $false if ($MigrateCitrixUPMtoFSLogix_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName MigrateCitrixUPMtoFSLogix.Import.IndividualFiles -Fallback $false if ($MigrateCitrixUPMtoFSLogix_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($Path).ProviderPath if ($doDotSource) { . $resolvedPath } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($resolvedPath))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\preimport.ps1")) { . Import-ModuleFile -Path $path } # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\postimport.ps1")) { . Import-ModuleFile -Path $path } # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code <# This file loads the strings documents from the respective language folders. This allows localizing messages and errors. Load psd1 language files for each language you wish to support. Partial translations are acceptable - when missing a current language message, it will fallback to English or another available language. #> Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'MigrateCitrixUPMtoFSLogix' -Language 'en-US' function Copy-CFXFSLogixProvider { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $DiskPath, [Parameter(Mandatory = $true)] [string[]] $ProviderPath, [Parameter(Mandatory = $true)] [switch] $SetOwner, [Parameter(Mandatory = $true)] [string] $SID ) $diskItem = Get-Item -Path $DiskPath foreach ($path in $ProviderPath) { Write-PSFMessage -Level Verbose -Message "Copying to $path" $measure = Measure-Command -Expression { $null = New-Item -Path (Split-Path -Path $path) -ItemType Directory -Force -ErrorAction Stop Copy-Item -Path $DiskPath -Destination $path -Force -ErrorAction Stop } Write-PSFMessage -Level Verbose -Message "Completed copy." if($SetOwner){ Write-PSFMessage -Level Verbose -Message "Setting ownership on $path" #On VHD file $fileACL = Get-ACL -Path $path $fileACL.SetOwner([System.Security.Principal.SecurityIdentifier] $SID) Set-ACL -Path $path -AclObject $fileACL -ErrorAction Stop $folderPath = Split-Path -Path $path $folderACL = Get-ACL -Path $folderPath $folderACL.SetOwner([System.Security.Principal.SecurityIdentifier] $SID) Set-ACL -Path $folderPath -AclObject $fileACL -ErrorAction Stop } [PSCustomObject]@{ ProviderPath = $path CopyDuration = "{0}:{1}:{2}.{3}" -f $measure.Hours, $measure.Minutes, $measure.seconds, $measure.Milliseconds CopySpeedMBps = ($diskItem.length / 1MB) / $measure.TotalSeconds } } } function Copy-CFXRedirectedFolders { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $FRX , [Parameter(Mandatory = $true)] [string] $DiskPath, [Parameter(Mandatory = $true)] [string] $RedirectedFoldersPath ) Write-PSFMessage -Level Verbose -Message "Mounting VHD using FRX.exe: $Diskpath" $mountPoint = Mount-CFXProfile -FRX $FRX -DiskPath $DiskPath try{ $roboCopyError = $null $robocopyDestination = (Join-PSFPath $mountPoint.Path 'Profile') $robocopyLogPath = Join-PSFPath $env:Temp "$(Split-Path -Path $DiskPath -Leaf).robocopy.log" Copy-CFXRobocopy -Source $RedirectedFoldersPath -Destination $robocopyDestination -LogPath $robocopyLogPath -ErrorAction Stop } catch { $roboCopyError = $_ } finally{ Write-PSFMessage -Level Verbose -Message "Dismounting VHD using FRX.exe" Dismount-CFXProfile -DiskPath $DiskPath -Cookie $mountPoint.Cookie -FRX $FRX if($roboCopyError) {throw $roboCopyError} } } function Copy-CFXRobocopy { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $Source, [Parameter(Mandatory = $true)] [string] $Destination, [Parameter(Mandatory = $true)] [string] $LogPath ) Write-PSFMessage -Level Verbose -Message "Copying files from $Source to $Destination - Logging to $LogPath" $robocopyArgs = @( $Source $Destination '/XJ','/E','/B','/MT:10','/W:1','/R:1','/NP','/NS','/NDL' ,'/COPYALL' ) $robocopyProcess = Start-Process -FilePath Robocopy -ArgumentList $robocopyArgs -RedirectStandardOutput $LogPath -Wait -PassThru -NoNewWindow <# /COPYALL: Copy with timestamp, NTFS permissions, Owner, Audit, etc... /XJ: Do not copy junction points (this can cause infinite loops) /E: Copy all subfolder and files including empty directories /B: Copy in backup mode, requires permission on target system OS. HElps avoid NTFS security blocks. /MT:10 Copy 10 files simultaneously (Multi-threaded) Good for network performance. /W:1 /R:1: In case of error, retry one time. wait one second. /NP /NFL /NJH /NJS: Do not show progress, list of files or directories, header, or summary. So Robocopy should not return any output other than errors. #> Write-PSFMessage -Level Verbose -Message "Robocopy exited with code: $($robocopyProcess.ExitCode)" if($robocopyProcess.ExitCode -notin (1,3)){ # Exit codes 1 and 3 means all good, anything else could be an error. https://adamtheautomator.com/robocopy/#Exit_Codes $robocopyLog = Get-Content -Path $LogPath throw "Robocopy returned $($robocopyProcess.ExitCode):`r`n$($robocopyLog | out-string)" } } function Dismount-CFXProfile { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $DiskPath, [Parameter(Mandatory = $true)] [string] $Cookie, [Parameter(Mandatory = $true)] [string] $FRX ) $result = & $FRX end-edit-profile -filename $DiskPath -cookie $Cookie if($result -ne 'Operation completed successfully!' ){ throw ($result | Out-String) } } function Get-CFXADUserSID { [CmdletBinding()] param ( # Username used for logon (SAMAccountName) [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [string] $Username ) process { try{ $adUser = Get-ADUser -Identity $Username -ErrorAction Stop } catch { throw } Write-PSFMessage -Level Verbose -Message "Resolved SID for $username as $($adUser.SID)" $adUser.SID } } function Get-CFXFSLogixPath { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string[]] $FSLogixProfileRootPath, # FSLogix Folder Name Pattern [Parameter(Mandatory = $false)] [string] $FSLogixFolderPattern, # FSLogix VHDX Name Pattern [Parameter(Mandatory = $false)] [string] $FSLogixVHDXPattern, # Username used for logon (SAMAccountName) [Parameter(Mandatory = $true)] [string] $Username, # Active Directory SID of the user [Parameter(Mandatory = $true)] [string] $SID, [Parameter(Mandatory = $false)] [switch] $Overwrite ) begin { # Calculate Profile Folder name $profileFolderName = $FSLogixFolderPattern -replace "%SID%",$SID -replace "%username%",$Username if($profileFolderName -like "*%*") {throw "Could replace all maps in ($FSLogixFolderPattern). Please only use %SID% or %Username%."} # Calculate profile virtual disk name $profileVHDXName = $FSLogixVHDXPattern -replace "%SID%",$SID -replace "%username%",$Username if($profileVHDXName -like "*%*") {throw "Could replace all maps in ($FSLogixFolderPattern). Please only use %SID% or %Username%."} } process{ $paths = foreach ($provider in $FSLogixProfileRootPath){ $path = Join-PSFPath $provider $profileFolderName $profileVHDXName Write-PSFMessage -Level Verbose -Message "Calculated FSLogix path for $username on $provider as: $path" if((Test-Path $path) -and (-Not $Overwrite)){ throw "FSLogix Disk at '$path' already exists. You can user -OverwriteFSLogix switch to avoid this error." } $path } $paths } } function Get-CFXLogFilePath { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $LogFolderPath ) $dateTime = Get-Date -Format 'yyyyMMdd-HHmmss' $path = Join-PSFPath $LogFolderPath "Convert-CFXUser_$dateTime.log" Set-Content -Path $path -Value "Log file created at $dateTime." -ErrorAction Stop Write-PSFMessage -Level Verbose -Message "Created Log file under: $path" $path } function Get-CFXProfilePath { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $Username, [Parameter(Mandatory = $true)] [string] $ProfilePath ) $path = $ProfilePath -replace "%username%",$Username if($profileFolderName -like "*%*") {throw "Could replace all maps in ($ProfilePath). Please only use %Username%."} if(-Not (Test-Path -Path $path)){ throw "Profile path does not exist: $path" } Write-PSFMessage -Level Verbose -Message "Calculated Profile path for $username on $ProfilePath as: $path" $path } function Mount-CFXProfile { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $FRX , [Parameter(Mandatory = $true)] [string] $DiskPath ) # Open disk for editing using FRX $editDisk = & $FRX begin-edit-profile -filename $DiskPath if($editDisk[-1] -ne 'Operation completed successfully!' ){ throw ($editDisk | Out-String) } $mountPointPath = $editDisk[1] if(-Not (Test-Path -Path $mountPointPath)){ throw "Mount point path is invalid:`r`n$($editDisk | out-string)" } $mountPointCookie = $editDisk[5] <# Removed this check as sometimes the cookie is 3 characters, add later when we know the proper regex for it if(-Not ($mountPointCookie -match '^(\d|\w){4}$')){ throw "Mount point cookie is invalid:`r`n$($editDisk | out-string)" } #> Write-PSFMessage -Level Verbose -Message "Mounted VHD at $mountPointPath - Cookie $mountPointCookie" [PSCustomObject]@{ Path = $mountPointPath Cookie = $mountPointCookie } } function New-CFXFSLogixVHD { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $citrixProfilePath, [Parameter(Mandatory = $true)] [string] $Path, [Parameter(Mandatory = $true)] [string[]] $Username, # FSLogix command line tool path [Parameter(Mandatory = $false)] [string] $FRX ) if (Test-Path -Path $Path) { Write-PSFMessage -Level Verbose -Message "Disk already exists at $Path. Deleting file." Remove-Item -Path $Path -Force -Confirm:$false -ErrorAction 'Stop' } Write-PSFMessage -Level Verbose -Message "Starting copy from '$citrixProfilePath' to '$Path'" $copyResults = (& $FRX copy-profile -filename $Path -username $Username -profile-path $citrixProfilePath ) if($copyResults[-1] -ne 'Operation completed successfully!' ){ throw ($copyResults | Out-String) } Write-PSFMessage -Level Verbose -Message "Profile copy from citrix Operation completed successfully!" } function Convert-CFXUser { [CmdletBinding()] param ( # Username used for logon (SAMAccountName) [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [string[]] $Username, # Location of Citrix Profile for all users e.g. \\FileServer\CTXProfiles\%username%\Win2016\UPM_Profile [Parameter(Mandatory = $true)] [string] $CitrixUPMProfilePath, # Location of Citrix Profile for all users e.g. \\FileServer\RedirectedFolders\%username% [Parameter(Mandatory = $true)] [string] $RedirectedFoldersPath, # Location of FSLogix Profile e.g. \\FileServer\FSLogixProfileContainers\ - accepts multiple entries. [Parameter(Mandatory = $true)] [ValidateScript( { Test-Path -Path $_ -PathType Container })] [string[]] $FSLogixProviderPath, # Allow overwrite of existing VHDs when copying to FSLogix providers. [Parameter(Mandatory = $false)] [Switch] $OverwriteFSLogix, # Set the user account as owner on FSLogix VHD and folder. [Parameter(Mandatory = $false)] [Switch] $SetFSLogixOwner, # FSLogix Folder Name Pattern. You can use %SID% or %username%. Default is: "%Username%_%SID%" [Parameter(Mandatory = $false)] [string] $FSLogixFolderPattern = "%Username%_%SID%", # FSLogix virtual disk default size in GB. [Parameter(Mandatory = $false)] [int] $FSLogixVHDSizeGB = 30, # FSLogix VHDX Name Pattern. You can use %SID% or %username%. Default is: "Profile_%Username%.VHDX" [Parameter(Mandatory = $false)] [ValidatePattern('\.VHDX{0,1}$')] # ErrorMessage = 'FSLogix VHD name must end with VHD or VHDX' [string] $FSLogixVHDXPattern = "Profile_%Username%.VHDX", # FSLogix command line tool path [Parameter(Mandatory = $false)] [ValidateScript( { Test-Path -Path $_ -PathType Container })] [string] $FRXPath = 'C:\Program Files\FSLogix\Apps\frx.exe', # Log Folder Path [Parameter(Mandatory = $false)] [ValidateScript( { Test-Path -Path $_ -PathType Container })] [string] $LogFolderPath, # Temporary Disk Location - Default is user temp folder $env:Temp [Parameter(Mandatory = $false)] [ValidateScript( { Test-Path -Path $_ -PathType Container })] [string] $TempFolderPath = $env:Temp, # Do not delete temp VHD created on temp folder [Parameter(Mandatory = $false)] [switch] $DoNoCleanup ) begin { if ($Username.count -gt 1 ` -and ($CitrixUPMProfilePath -NotLike "*%username%*") ` -or ($RedirectedFoldersPath -NotLike "*%username%*") ) { throw "When providing multiple usernames, you must use %username% in parameters CitrixUPMProfilePath and RedirectedFoldersPath .`r`nFor example: \\FileServer\CTXProfiles\%username%\Win2016\UPM_Profile" } } process { foreach ($user in $Username) { try { # Confirm username is correct and retrieve SID $sid = Get-CFXADUserSID -Username $user -ErrorAction Stop #region: Calculate variables # Calculate name for FSLogix Folder and File - Check if FSLogix folder already exists, fail if so. $fsLogixPathParams = @{ FSLogixProfileRootPath = $FSLogixProviderPath FSLogixFolderPattern = $FSLogixFolderPattern FSLogixVHDXPattern = $FSLogixVHDXPattern Username = $user SID = $sid Overwrite = $OverwriteFSLogix } $fslogixFilePath = Get-CFXFSLogixPath @fsLogixPathParams -ErrorAction Stop # Calculate path for Citrix profile location $citrixProfilePath = Get-CFXProfilePath -Username $user -ProfilePath $CitrixUPMProfilePath -ErrorAction Stop #If profile not found, fail # Calculate path for Redirected folder profile location if ($Username.count -gt 1 -and $CitrixUPMProfilePath -NotLike "*%username%*") { throw "When providing multiple usernames, you must use %username% in parameter RedirectedFoldersPath.`r`nFor example: \\FileServer\RedirectedFolders\%username%" } $redirectedFoldersPath = Get-CFXProfilePath -Username $user -ProfilePath $RedirectedFoldersPath -ErrorAction Stop #If folder not found, fail # Calculate path for log file and confirm access. if ($LogFolderPath) { $logFilePath = Get-CFXLogFilePath -LogFolderPath $LogFolderPath -ErrorAction Stop } #endregion: Calculate variables # Create disk using FSLogix copy-profile $tempDiskPath = Join-PSFPath $TempFolderPath ($fslogixFilePath[0] | Split-Path -Leaf) Write-PSFMessage -Level Verbose -Message "Copying Citrix profile to new VHD: $tempDiskPath" New-CFXFSLogixVHD -citrixProfilePath $citrixProfilePath -Path $tempDiskPath -Username $user -FRX $FRXPath -ErrorAction Stop # Copy redirected folders to disk using robocopy Write-PSFMessage -Level Verbose -Message "Copying Redirected folders to VHD." Copy-CFXRedirectedFolders -DiskPath $tempDiskPath -RedirectedFoldersPath $redirectedFoldersPath -FRX $FRXPath -ErrorAction Stop # Copy disk to profile location(s) $diskItem = Get-Item -Path $tempDiskPath Write-PSFMessage -Level Verbose -Message "Copying VHD to FSLogix Providers." $copyResult = Copy-CFXFSLogixProvider -DiskPath $tempDiskPath -ProviderPath $fslogixFilePath -SetOwner:$SetFSLogixOwner -SID $sid $success = $true } catch { $errorMessage = $_ $success = $false Write-PSFMessage -Message "Error" -Level Warning -ErrorRecord $_ -EnableException $true -PSCmdlet $PSCmdlet Write-Error $_ } finally { # Delete Temp Disk if(-Not $DoNoCleanup){ Remove-Item -Path $tempDiskPath -Force -ErrorAction Continue } } #return output for the user [PSCustomObject]@{ username = $user Success = $success SID = $sid CitrixProfilePath = $citrixProfilePath RedirectedFoldersPath = $redirectedFoldersPath VHDSizeGB = ($diskItem.length / 1GB) CopyResults = $copyResult ErrorMessage = $errorMessage } } } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'MigrateCitrixUPMtoFSLogix' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'MigrateCitrixUPMtoFSLogix' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'MigrateCitrixUPMtoFSLogix' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." <# Stored scriptblocks are available in [PsfValidateScript()] attributes. This makes it easier to centrally provide the same scriptblock multiple times, without having to maintain it in separate locations. It also prevents lengthy validation scriptblocks from making your parameter block hard to read. Set-PSFScriptblock -Name 'MigrateCitrixUPMtoFSLogix.ScriptBlockName' -Scriptblock { } #> <# # Example: Register-PSFTeppScriptblock -Name "MigrateCitrixUPMtoFSLogix.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name MigrateCitrixUPMtoFSLogix.alcohol #> New-PSFLicense -Product 'MigrateCitrixUPMtoFSLogix' -Manufacturer 'wmoselhy' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2021-05-23") -Text @" Copyright (c) 2021 wmoselhy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "@ #endregion Load compiled code |