FSLogix Containers Cleanup Script
When you have a share with FSLogix containers you probably want to keep this in sync with you active directory. Users who are deleted, inactive or disabled can still claim space on the file server. This script will read all container folders and match them against the active directory useraccounts and delete the containers if needed.
All information is in the script. Have fun with it and leave a comment when using or when having issues.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
<# This script checks the path where FSLogix containers are stored. For each folder it will check the active directory for the status of the specific useraccount. The following checks will be performed: 1. Does the user still exists? 2. Is the user disabled? 3. What is the last logon date? There are a couple of variables to set to tune the script for your needs: 1. $FSLogixPath : The location where the containers are stored. 2. $ExcludeFolders : Is the location has folders which must not be processed you can add them here. 3. $DaysInactive : Minimum amount of days when the last logon occured. 4. $DeleteDisabled : Set this to 0 or 1. 0 will NOT delete conainters from disabled user accounts. 1 will ;) 5. $DeleteNotExisting : When a user is deleted and the conainers aren't deleted set this to 1 and the containers will be deleted. 6. $DeleteInactive : Users with a last logon longer the the $DaysInactive will be deleted if this is set to 1. 7. $DryRun : When this is set to 1, nothing will be deleted regardless the settings. This will also output more information which containers are claiming space. There is one assumption made and that is that FSLogix Flip Flop is enabled: https://docs.microsoft.com/en-us/fslogix/profile-container-configuration-reference#flipflopprofiledirectoryname This setting is storing the containers in the following folder name per user: "%username%%sid%" Version : 1.0 Date : 12 June 2022 Created by : Jeroen Tielen - Tielen Consultancy B.V. Email : jeroen@tielenconsultancy.nl History: 1.0 : 12 June 2022 - Initial setup script. #> # Tune this variables to your need $FSLogixPath = "\\Nutanix_Files\FSLogix" # Set FSLogix containers path. [string[]]$ExcludeFolders = @('FSLogix_Redirections','Template') # Excluded directories from the FSLogix containers path. $DaysInactive = 90 # Days of inactivity before FSLogix containers are removed. $DeleteDisabled = 0 # Delete containers from disabled users. $DeleteNotExisting = 0 # Delete containers from not existing users. $DeleteInactive = 0 # Delete containers from inactive users. $DryRun = 1 # Override switch, nothing will be deleted, script will also output user names and what will be deleted. # Script Start $PotentialSpaceReclamation = 0 $SpaceReclaimed = 0 $SpaceDisabled = 0 $SpaceNotExisting = 0 $SpaceInactive = 0 If ($DryRun -eq 1) { Write-Host "!! DryRun Active, nothing will be deleted !!" -ForegroundColor Green -BackgroundColor Blue } Else { Write-Host "!! DryRun NOT Active, containers will be deleted !!" -ForegroundColor Red -BackgroundColor White Write-Host -nonewline "Continue? (Y/N) " $Response = Read-Host If ( $Response -ne "Y" ) { EXIT } } $PathItems = Get-ChildItem -Path "$($FSLogixPath)" -Directory -Exclude $ExcludeFolders Foreach ($PathItem in $PathItems) { $UserName = $pathItem.Name.Substring(0, $PathItem.Name.IndexOf('_S-1-5')) Try { $Information = Get-ADUser -Identity $UserName -Properties sAMAccountName,Enabled,lastLogon,lastLogonDate If ($False -eq $Information.Enabled) { If ($DryRun -eq 1 ) { Write-host "User $UserName is disabled." } $PotentialSpaceReclamation = $PotentialSpaceReclamation + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb $SpaceDisabled = $SpaceDisabled + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb If ($DeleteDisabled -eq 1) { Write-Host "Deleting containers from $UserName" -ForegroundColor Red $SpaceReclaimed = $SpaceReclaimed + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb If ($DryRun -ne 1) { Remove-Item -Path $PathItem -Recurse -Force } } } ElseIf ($Information.lastLogonDate -lt ((Get-Date).Adddays(-($DaysInactive)))) { If ($DryRun -eq 1 ) { Write-Host "User $UserName is more than $DaysInactive days inactive." } $PotentialSpaceReclamation = $PotentialSpaceReclamation + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb $SpaceInactive = $SpaceInactive + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb If ($DeleteInactive -eq 1) { Write-Host "Deleting containers from $UserName" -ForegroundColor Red $SpaceReclaimed = $SpaceReclaimed + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb If ($DryRun -ne 1) { Remove-Item -Path $PathItem -Recurse -Force } } } } catch [Microsoft.ActiveDirectory.Management.ADIdentityNotFoundException] { If ($DryRun -eq 1 ) { Write-Host "User $UserName doesn't exist." } $PotentialSpaceReclamation = $PotentialSpaceReclamation + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb $SpaceNotExisting = $SpaceNotExisting + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb If ($DeleteNotExisting -eq 1) { Write-Host "Deleting containers from $UserName" -ForegroundColor Red $SpaceReclaimed = $SpaceReclaimed + (Get-ChildItem -Path "$PathItem" | Measure Length -Sum).Sum /1Gb If ($DryRun -ne 1) { Remove-Item -Path $PathItem -Recurse -Force } } } } $PotentialSpaceReclamation = "{0:N2} GB" -f $PotentialSpaceReclamation $SpaceReclaimed = "{0:N2} GB" -f $SpaceReclaimed $SpaceDisabled = "{0:N2} GB" -f $SpaceDisabled $SpaceNotExisting = "{0:N2} GB" -f $SpaceNotExisting $SpaceInactive = "{0:N2} GB" -f $SpaceInactive If ($DryRun -eq 1) { Write-Host "Potential $PotentialSpaceReclamation can be reclaimed." } Write-Host "Disabled users are claiming $SpaceDisabled" Write-Host "Not Existing users are claiming $SpaceNotExisting" Write-Host "Inactive users are claiming $SpaceInactive" Write-Host "$SpaceReclaimed total reclaimed." |
Keep in mind, I’m not a scripter/devver 😉 So the script can be shorter/smarter but this works either. I’m not responsable for any damage or deleted containers 😉 Usage of the script is your own responsability.
5 Comments
Joep · August 10, 2022 at 15:46
Hi Jeroen,
Thank you for this script. We are not using FSLogix Flip Flop, but I can’t figure out what to change about the script to make it work. Could you help me with this?
Kind regards,
Joep
Jeroen Tielen · August 10, 2022 at 15:54
Ahh you are the one in a thousand which is not using flip flop 😉 You need to change the script so it reads the username from the last part of the foldername. I never ever use that kind of naming convention as it is not easy to find the user his profile.
Tom Schoen · November 2, 2022 at 15:29
Thanks for the inspiration! Did not exactly use yours but served as a great basis to develop my own. Should it help you, you can find it here! I built a flipflop switch into it as well.
https://github.com/tompatta/PowerShell/tree/main/FSLogix%20Cleanup
Jeroen Tielen · November 9, 2022 at 13:47
Ahh lovely Tom. That is community power. Thanks for sharing.
Automatically clean up FSLogix Profile Containers – The Cloud Admin · November 9, 2022 at 19:24
[…] Jeroen Tielen created a cool script that does some of the things I wanted it to do, but not all of it. […]