Functions/Public/Get-FolderSize.ps1
|
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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
function Get-FolderSize { <# .SYNOPSIS Get-FolderSize Returns the size of folders in MB and GB. You can change the base path, omit folders, as well as output results in various formats. .DESCRIPTION This function will get the folder size in MB and GB of folders found in the basePath parameter. The BasePath parameter defaults to the current directory. .PARAMETER BasePath This parameter allows you to specify the base path you'd like to get the child folders of. It defaults to where the module was run from via (Get-Location). .PARAMETER FolderName This parameter allows you to specify the name of a specific folder you'd like to get the size of. .PARAMETER AddTotal This parameter adds a total count at the end of the array .PARAMETER OmitFolders This parameter allows you to omit folder(s) (array of string) from being included .PARAMETER Output Use this option to output the results. Valid options are csv, xml, or json .PARAMETER OutputPath Specify the path you want to use when outputting the results as a csv, xml, or json file Do not include a trailing slash Example: C:\users\you\Desktop Defaults to (Get-Location) This will be where you called the module from .PARAMETER OutputFile This allows you to specify the path and file name you'd like for output Example: C:\users\you\desktop\output.csv .PARAMETER OutputSort This allows you to specify what you'd like to sort by for the csv/json/xml output. Valid options are FolderSize and SizeBytes .PARAMETER AddFileTotals This parameter allows you to add file totals to the results Note: This will reduce performance of the script by around 30%! .EXAMPLE Get-FolderSize | Format-Table -AutoSize FolderName SizeBytes SizeMB SizeGB $GetCurrent 193768 0.18 MB 0.00 GB $RECYCLE.BIN 20649823 19.69 MB 0.02 GB $SysReset 53267392 50.80 MB 0.05 GB Config.Msi 0.00 MB 0.00 GB Documents and Settings 0.00 MB 0.00 GB Games 48522184491 46,274.36 MB 45.19 GB .EXAMPLE Get-FolderSize -BasePath 'C:\Program Files' FolderName SizeBytes SizeMB SizeGB 7-Zip 4588532 4.38 MB 0.00 GB Adobe 3567833029 3,402.55 MB 3.32 GB Application Verifier 353569 0.34 MB 0.00 GB Bonjour 615066 0.59 MB 0.00 GB Common Files 489183608 466.52 MB 0.46 GB .EXAMPLE Get-FolderSize -BasePath 'C:\Program Files' -FolderName IIS FolderName SizeBytes SizeMB SizeGB IIS 5480411 5.23 MB 0.01 GB .EXAMPLE $getFolderSize = Get-FolderSize $getFolderSize | Format-Table -AutoSize FolderName SizeGB SizeMB Public 0.00 GB 0.00 MB thegn 2.39 GB 2,442.99 MB .EXAMPLE $getFolderSize = Get-FolderSize -Output csv -OutputPath ~\Desktop $getFolderSize FolderName SizeGB SizeMB Public 0.00 GB 0.00 MB thegn 2.39 GB 2,442.99 MB (Results will also be exported as a CSV to your Desktop folder) .EXAMPLE Sort by size descending $getFolderSize = Get-FolderSize | Sort-Object SizeBytes -Descending $getFolderSize FolderName SizeBytes SizeMB SizeGB Users 76280394429 72,746.65 MB 71.04 GB Games 48522184491 46,274.36 MB 45.19 GB Program Files (x86) 27752593691 26,466.94 MB 25.85 GB Windows 25351747445 24,177.31 MB 23.61 GB .EXAMPLE Omit folder(s) from being included Get-FolderSize.ps1 -OmitFolders 'C:\Temp','C:\Windows' .EXAMPLE Add file counts for each folder Note: This will slow down the execution of the script by around 30% $results = Get-FolderSize -AddFileTotal PS /Users/ninja/Documents/repos/PSFolderSize> $results[0] | Format-List * FolderName : .git SizeBytes : 228591 SizeMB : 0.22 SizeGB : 0.00 FullPath : /Users/ninja/Documents/repos/PSFolderSize/.git HostName : njambp.local FileCount : 382 #> [cmdletbinding( DefaultParameterSetName = 'default' )] param( [Parameter( Mandatory = $false, Position = 0, ParameterSetName = 'default' )] [Alias('Path')] [String[]] $BasePath = (Get-Location), [Parameter( Mandatory = $false, ParameterSetName = 'default' )] [Alias('Name')] [String[]] $FolderName = 'all', [Parameter( ParameterSetName = 'default' )] [String[]] $OmitFolders, [Parameter( ParameterSetName = 'default' )] [Switch] $AddTotal, [Parameter( ParameterSetName = 'default' )] [Switch] $AddFileTotals, [Parameter( ParameterSetName = 'default' )] [Switch] $UseRobo, [Parameter( ParameterSetName = 'default' )] [Parameter( ParameterSetName = 'outputWithType' )] [ValidateSet('csv','xml','json')] [String] $Output, [Parameter( ParameterSetName = 'default' )] [Parameter( ParameterSetName = 'outputWithType' )] [String] $OutputPath = (Get-Location), [Parameter( ParameterSetName = 'default' )] [Parameter( ParameterSetName = 'outputWithType' )] [ValidateSet('FolderName','SizeBytes')] [String] $OutputSort, [Parameter( ParameterSetName = 'default' )] [String] $OutputFile = [string]::Empty ) begin { #Get a list of all the directories in the base path we're looking for. $allFolders = Get-FolderList -FolderName $FolderName -OmitFolders $OmitFolders -BasePath $BasePath #Create array to store folder objects found with size info. [System.Collections.ArrayList]$folderList = @() #Get hostname $hostName = [System.Net.Dns]::GetHostByName((hostname)).HostName } process { #Go through each folder in the base path. $allFolders | ForEach-Object { #Clear out the variables used in the loop. $folder = $null $fullPath = $null $folderInfo = $null $folderObject = $null $folderSize = $null $folderSizeInBytes = $null $folderSizeInMB = $null $folderSizeInGB = $null $folderBaseName = $null $totalFiles = $null $folder = $_ #Store the full path to the folder and its name in separate variables $fullPath = $folder.FullName $folderBaseName = $folder.BaseName Write-Verbose "Working with [$fullPath]..." #Get folder info / sizes if ($UseRobo) { $folderSize = Get-RoboSize -Path $fullPath -DecimalPrecision 2 $folderSizeInBytes = $folderSize.TotalBytes $folderSizeInKB = [math]::Round($folderSize.TotalKB, 2) $folderSizeInMB = [math]::Round($folderSize.TotalMB, 2) $folderSizeInGB = [math]::Round($folderSize.TotalGB, 2) } else { $folderInfo = Get-Childitem -LiteralPath $fullPath -Recurse -Force -ErrorAction SilentlyContinue $folderSize = $folderInfo | Measure-Object -Property Length -Sum -ErrorAction SilentlyContinue #We use the string format operator here to show only 2 decimals, and do some PS Math. if ($folderSize.Sum) { $folderSizeInBytes = $folderSize.Sum $folderSizeInKB = [math]::Round($folderSize.Sum / 1KB, 2) $folderSizeInMB = [math]::Round($folderSize.Sum / 1MB, 2) $folderSizeInGB = [math]::Round($folderSize.Sum / 1GB, 2) } } #Here we create a custom object that we'll add to the array $folderObject = [PSCustomObject]@{ PSTypeName = 'PS.Folder.List.Result' FolderName = $folderBaseName SizeBytes = $folderSizeInBytes SizeKB = $folderSizeInKB SizeMB = $folderSizeInMB SizeGB = $folderSizeInGB FullPath = $fullPath HostName = $hostName } #Add file totals if switch is true if ($AddFileTotals) { $totalFiles = ($folderInfo | Where-Object {!$_.PSIsContainer}).Count $folderObject | Add-Member -MemberType NoteProperty -Name FileCount -Value $totalFiles } #Add the object to the array $folderList.Add($folderObject) | Out-Null } if ($AddTotal) { $grandTotal = $null $grandTotalFiles = $null if ($folderList.Count -gt 1) { $folderList | ForEach-Object { if ($_.SizeBytes -gt 0) { $grandTotal += $_.SizeBytes } } $totalFolderSizeInKB = [math]::Round($grandTotal / 1KB, 2) $totalFolderSizeInMB = [math]::Round($grandTotal / 1MB, 2) $totalFolderSizeInGB = [math]::Round($grandTotal / 1GB, 2) $folderObject = [PSCustomObject]@{ FolderName = "GrandTotal for [$BasePath]" SizeBytes = $grandTotal SizeKB = $totalFolderSizeInKB SizeMB = $totalFolderSizeInMB SizeGB = $totalFolderSizeInGB FullPath = 'N/A' HostName = $hostName } } if ($AddFileTotals) { $folderList | ForEach-Object { $grandTotalFiles += $_.FileCount } $folderObject | Add-Member -MemberType NoteProperty -Name FileCount -Value $grandTotalFiles } #Add the object to the array $folderList.Add($folderObject) | Out-Null } } end { if ($Output -or $OutputFile) { if (!$OutputFile) { $fileName = "{2}\{0:MMddyy_HHmm}.{1}" -f (Get-Date), $Output, $OutputPath } else { $fileName = $OutputFile $Output = $fileName.Substring($fileName.LastIndexOf('.') + 1) } Write-Verbose "Attempting to export results to -> [$fileName]!" try { switch ($Output) { 'csv' { $folderList | Sort-Object $OutputSort -Descending | Export-Csv -Path $fileName -NoTypeInformation -Force } 'xml' { $folderList | Sort-Object $OutputSort -Descending | Export-Clixml -Path $fileName } 'json' { $folderList | Sort-Object $OutputSort -Descending | ConvertTo-Json | Out-File -FilePath $fileName -Force } } } catch { $errorMessage = $_.Exception.Message Write-Error "Error exporting file to [$fileName] -> [$errorMessage]!" } } #Return the object array with the objects selected in the order specified Return $folderList | Sort-Object SizeBytes -Descending } } |