Back to top

FREE eBook: The Most USEFUL PowerShell CmdLets and more…

Grab a copy!

How To Get Disk Size And Disk Free Space Using PowerShell

How To Get Disk Size And Disk Free Space Using PowerShell
Approx Reading Time: 24 minutes

To get out of disk free space is very bad so we need to manage disk free space at all times and optionally get alerts when disk free space drops under a certain percentage or size.

To get the disk(s) size and disk(s) free space using PowerShell we can use either CIM_LogicalDisk CIM Class or Win32_LogicalDisk WMI Class.

Get Disk Size And Disk Free Space – Solutions

Here are few solutions for the local machines, remote computers and writing own PowerShell CmdLet.

Solution 1 – Get Disk Size And Disk Free Space On Local Machine

To get the needed data we can use either CIM_LogicalDisk CIM Class or Win32_LogicalDisk WMI Class.

CIM_LogicalDisk CIM Class

We can use CIM_LogicalDisk CIM Class to get free space and disk(s) size on the local machine.

Get-CimInstance -Class CIM_LogicalDisk | Select-Object @{Name="Size(GB)";Expression={$_.size/1gb}}, @{Name="Free Space(GB)";Expression={$_.freespace/1gb}}, @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}}, DeviceID, DriveType | Where-Object DriveType -EQ '3'

Here is the resultset:

Disk size and free disk space on local machine using CIM_LogicalDisk CIM Class

If you want to see all the properties that CIM_LogicalDisk CIM Class returns than please run the following command.

Get-CimInstance -Class CIM_LogicalDisk | Select-Object * | Where-Object DriveType -EQ '3'

Here is the resultset.

Properties of CIM_LogicalDisk CIM Class

Win32_LogicalDisk WMI Class

Very similarly we can use Win32_LogicalDisk WMI Class to get free space and disk(s) size on the local machine.

Get-CimInstance -Class Win32_LogicalDisk | Select-Object @{Name="Size(GB)";Expression={$_.size/1gb}}, @{Name="Free Space(GB)";Expression={$_.freespace/1gb}}, @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}}, DeviceID, DriveType | Where-Object DriveType -EQ '3'

Here is the resultset:

Disk size and free disk space on local machine using Win32_LogicalDisk WMI Class

If you want to see all the properties that Win32_LogicalDisk WMI Class returns than please run the following command.

Get-CimInstance -Class Win32_LogicalDisk | Select-Object * | Where-Object DriveType -EQ '3'

Here is the resultset.

Properties of Win32_LogicalDisk WMI Class

Solution 2 – Get Disk Size And Disk Free Space For The List Of Servers (Remote Computers)

For the list of computers, we can use the same calls as for the previous solution only to use the ComputerName parameter and add the list of servers as a txt file.

Create the list of servers in the text file and save in, for example, C:\Temp folder. We basically load the content of the text file using Get-Content CmdLet and PowerShell will go through the list and run the same command as in the previous solution for each server on the list.

CIM_LogicalDisk CIM Class

We use the CIM_LogicalDisk CIM Class combined with the ComputerName parameter that has been fed from the text file with the list of servers.

Get-CimInstance -Class CIM_LogicalDisk -ComputerName (Get-Content -Path 'C:\Temp\Servers.txt') | Select-Object @{Name="Size(GB)";Expression={$_.size/1gb}}, @{Name="Free Space(GB)";Expression={$_.freespace/1gb}}, @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}}, DeviceID, DriveType, SystemName | Where-Object DriveType -EQ '3' | Out-GridView

Here is the resultset.

Disk size and free disk space for remote servers using CIM_LogicalDisk CIM Class

Win32_LogicalDisk WMI Class

We use the Win32_LogicalDisk WMI Class combined with the ComputerName parameter that has been fed from the text file with the list of servers.

Get-CimInstance -Class Win32_LogicalDisk -ComputerName (Get-Content -Path 'C:\Temp\Servers.txt') | Select-Object @{Name="Size(GB)";Expression={$_.size/1gb}}, @{Name="Free Space(GB)";Expression={$_.freespace/1gb}}, @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}}, DeviceID, DriveType, SystemName | Where-Object DriveType -EQ '3' | Out-GridView

Here is the resultset.

Disk size and free disk space for remote servers using Win32_LogicalDisk WMI Class

I do not have servers in my home network so in order to simulate one I have created a very simple input list of servers in a text file just copying the localhost value several times.

Servers.txt file content

Solution 3 – Write Own PowerShell CmdLet ( Get-DiskFreeSpace )

I have written my own Get-DiskFreeSpace CmdLet that I will explain in the minute.

This approach takes a little bit longer time but gives us more benefits in the long run so it is my preferred way and we can combine this CmdLet with the library of CmdLets in Efficiency Booster PowerShell Project.

Here is a sample call to Get-DiskFreeSpace CmdLet:

Get-DiskFreeSpace -filename "OKFINservers.txt" -client "OK" -solution "FIN" -Verbose -errorlog | Select-Object 'Environment', 'Logical Name', 'Server Name', 'Drive', 'Size(GB)', 'Free Space(GB)', 'Free (%)', 'IP', 'Collected' | Out-GridView

Here is the resultset of a call to Get-DiskFreeSpace CmdLet:

Get-DiskFreeSpace CmdLet resultset

INFO: I have written two PowerShell Add-on functions ( Get-CIMClassProperty and Select-CIMClassAllProperties) that help us working with WMI and CIM classes. First list all the properties and datatypes of WMI or CIM classes and the second one makes the select statements with all the properties for the WMI or CIM class. How To List CIM Or WMI Class All Properties And Their Datatypes With PowerShell AND How To Write Select Statement For All Properties Of CIM Or WMI Class With PowerShell.

Get-DiskFreeSpace CmdLet – Explained

Get-DiskFreeSpace CmdLet collects disk(s) size and disk(s) free space for the list of servers and this CmdLet belongs to Efficiency Booster PowerShell Project. This project is the library of different CmdLets that can help us IT personal to do our everyday tasks more efficiently and accurately.

Source code for Get-DiskFreeSpace CmdLet can be downloaded from this zip file so please feel free to download it and it would be easier for you to follow me along.

Get-DiskFreeSpace CmdLet is part of Maintenance module and if you have downloaded the source code it can be found in the folder …\[My] Documents\WindowsPowerShell\Modules\04maintenance

INFO: If you want to know how to install and configure Efficiency Booster PowerShell Project files please read the following article: How To Install And Configure PowerShell: CmdLets, Modules, Profiles.

Get-DiskFreeSpace CmdLet – Input Parameters

As input parameters we have:

  • computers – it is a list of servers passed as input parameter with default value ‘localhost’ and accepts both pipeline options. Parameter belongs to the “ServerNames” parameter set. The “ServerNames” parameter set is the default parameter set.
  • filename – it is the name of the text file with the list of servers and represents an alternative option to the “computers” parameter. The parameter belongs to the “FileName” parameter set.
  • errorlog – switch datatype and when turned on it will write errors into an external error log file using Write-ErrorLog CmdLet. The error log file is located in the PSLogs folder of [My] Documents.
  • client – it is a mandatory input parameter and by convention, I use two letters for client shortcode (for example, OK = O client, BK = B client, etc.). This parameter value is part of the filename parameter naming convention.
  • solution – it is a mandatory input parameter and by convention, I use two-three letters for solution shortcode (for example, FIN = Financial solution, HR = HR solution, etc.).

The naming convention for the filename parameter is as follows: Client + Solution + Text.txt. The text file should be located in …[My] Documents\WindowsPowerShell\Modules\01servers folder.

For example:

  • OKFINTestServers.txt – List of test environment servers for OK client and FIN solution.
  • OKFINProdServers.txt – List of production environment servers for OK client and FIN solution.
  • OKFINAllServers.txt – List of all servers for OK client and FIN solution.

INFO: To get a deeper explanation about client and solution input parameters please read these two sections Parameter clientParameter solution.

INFO: In order to customize the installation of CmdLet to your needs and set up necessary CSV file please read the following article How To Install And Configure PowerShell: CmdLets, Modules, Profiles

Here is the parameters definition code:

Function Get-DiskFreeSpace {
[CmdletBinding(DefaultParametersetName="ServerNames")]
param (
    [Parameter( ValueFromPipeline=$true,
                ValueFromPipelineByPropertyName=$true,
                ParameterSetName="ServerNames",
                HelpMessage="List of computer names separated by commas.")]
    [Alias('hosts')] 
    [string[]]$computers = 'localhost',
    
    [Parameter( ParameterSetName="FileName",
                HelpMessage="Name of txt file with list of servers. Txt file should be in 01servers folder.")] 
    [string]$filename,
    
    [Parameter( Mandatory=$false,
                HelpMessage="Write to error log file or not.")]
    [switch]$errorlog,
    
    [Parameter(Mandatory=$true, 
                HelpMessage="Client for example OK = O client, BK = B client")]
    [string]$client,
     
    [Parameter(Mandatory=$true,
                HelpMessage="Solution, for example FIN = Financial, HR = Human Resource")]
    [string]$solution     
)
}

INFO: To know more about PowerShell Parameters and Parameter Sets with some awesome examples please read the following articles How To Create Parameters In PowerShell and How To Use Parameter Sets In PowerShell Functions.

INFOPowerShell Pipelining is a very important concept and I highly recommend you to read the article written on the subject. How PowerShell Pipeline Works. Here I have shown in many examples the real power of PowerShell using the Pipelining.

BEGIN Block

In the BEGIN block we:

  • If the FileName parameter set has been used we test if text file with a list of servers exists.
  • If the file exists read the file and create the list of servers as a string array in the $computers variable.
  • … and if not write a warning with information to the caller to create the file.
BEGIN {

    if ( $PsCmdlet.ParameterSetName -eq "FileName") {

        if ( Test-Path -Path "$home\Documents\WindowsPowerShell\Modules\01servers\$filename" -PathType Leaf ) {
            Write-Verbose "Read content from file: $filename"
            $computers = Get-Content( "$home\Documents\WindowsPowerShell\Modules\01servers\$filename" )        
        } else {
            Write-Warning "This file path does NOT exist: $home\Documents\WindowsPowerShell\Modules\01servers\$filename"
            Write-Warning "Create file $filename in folder $home\Documents\WindowsPowerShell\Modules\01servers with list of server names."
            break;
        }       
    }
}

PROCESS Block

In the PROCESS block we run this block of code for each server passed into the pipeline or read from the text file:

  • We replace the localhost default value for the local server with the actual name of the local machine.
  • We use Get-ComputerInfo CmdLet to read additional data about each server (name, environment, logical name, IP address).
  • We implement Error Handling using try-catch blocks and writing errors in an external text file using Write-ErrorLog CmdLet.
  • We use PowerShell splatting to prepare the input parameters for the next call of Get-CimInstance CmdLet.
  • We go through each disk of the machine and read certain disk properties.
  • We call the CIM_LogicalDisk CIM class using Get-CimInstance CmdLet. Again we use splatting to prepare the input parameters.
  • We prepare the resultset of Get-DiskFreeSpace CmdLet.

Please notice these features in the PROCESS block.

Splatting

We have used splatting several times. First when we prepare the call to Get-CimInstance CmdLet, and second when we prepare the resultset.

Splatting helps us to have a more neat and understandable code.

Here is a call to Get-CimInstance CmdLet and use of splatting:

$params = @{'ComputerName'=$computer;
           #'Filter'="DriveType=3";
           'Class'='CIM_LogicalDisk';
           'ErrorAction'='Stop'}

            

#IMPORTANT - DO NOT use formatting {("{0:N2}" -f($_.size/1gb))} of expression if you want to explicit convert to decimal data type. (see down in properties variable)   
                                    
$drives = Get-CimInstance @params | 
          Select-Object @{Name="Size(GB)";Expression={$_.size/1gb}}, 
                          @{Name="Free Space(GB)";Expression={$_.freespace/1gb}},
                          @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}},
                          DeviceID,
                          DriveType |
          Where-Object DriveType -EQ '3'

Here is the second use of splatting when creating the resultset.

$properties = @{'Environment'=$env;
                'Logical Name'=$logicalname;
            	'Server Name'=$computer;
            	'Drive'=$drive.DeviceID;
            	'Size(GB)'=[decimal]$drive."Size(GB)";
            	'Free Space(GB)'=[decimal]$drive."Free Space(GB)";
            	'Free (%)'=$drive."Free (%)";
                'IP'=$ip;
                'Collected'=(Get-Date -UFormat %Y.%m.%d' '%H:%M:%S)}
                
$obj = New-Object -TypeName PSObject -Property $properties
$obj.PSObject.TypeNames.Insert(0,'Report.DiskSpaceInfo')

Write-Output $obj

Type Name Of The Resultset Objects

Notice the name of the resultset (Report.DiskSpaceInfo).

$obj.PSObject.TypeNames.Insert(0,'Report.DiskSpaceInfo')

So if we call PowerShell Get-Member CmdLet to get the type of resultset for Get-DiskFreeSpace CmdLet we will get Report.DiskSpaceInfo type and not standard PowerShell PSObject type.

Get-DiskFreeSpace -client "OK" -solution "FIN" | Get-Member

Here is the resultset:

Report.DiskSpaceInfo Type Name for Get-DiskFreeSpace CmdLet resultset

Type Name of resultset gives us a possibility to further expend the use of resultset. For example, we can use MS SQL Database and create table DiskFreeSpace based on resultset type name ( Report.DiskSpaceInfo ) where we can record the resultset and use MS SQL Reporting Services to show the results collected over a certain period of time.

TIP: It is always smart to have monitoring tools (Like HP SiteScope or HP Operations Manager for example) that will control critical points in your system and send you alerts when for example disk free space drops a certain level.

TIP: If you log the data about free disk space in the database over time you can create nice reports that can be useful for disk capacity planning so you can either expand disk size on a virtual machine or order and add additional disk(s) in your server or disk storage.

Use Of Expressions To Get Disk Size In GB And Explicit Conversion

Please notice the use of Expression to get disk size in GB and also explicit conversion in the decimal data type of the resulting properties.

I have written a reminder for myself not to use 0:N2 formatting if I want to use explicit decimal conversion afterward.

#IMPORTANT - DO NOT use formatting {("{0:N2}" -f($_.size/1gb))} of expression if you want to explicit convert to decimal data type. (see down in properties variable)   
                                    
$drives = Get-CimInstance @params | 
          Select-Object @{Name="Size(GB)";Expression={$_.size/1gb}}, 
                          @{Name="Free Space(GB)";Expression={$_.freespace/1gb}},
                          @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}},
                          DeviceID,
                          DriveType |
          Where-Object DriveType -EQ '3'
            
          foreach ($drive in $drives) {
                
                $properties = @{'Environment'=$env;
                                'Logical Name'=$logicalname;
            	                'Server Name'=$computer;
            	                'Drive'=$drive.DeviceID;
            	                'Size(GB)'=[decimal]$drive."Size(GB)";
            	                'Free Space(GB)'=[decimal]$drive."Free Space(GB)";
            	                'Free (%)'=$drive."Free (%)";
                                'IP'=$ip;
                                'Collected'=(Get-Date -UFormat %Y.%m.%d' '%H:%M:%S)}
                
                $obj = New-Object -TypeName PSObject -Property $properties
                $obj.PSObject.TypeNames.Insert(0,'Report.DiskSpaceInfo')
          }   

INFO: To learn about PowerShell Error Handling and code debugging please read the following articles: How To Log PowerShell Errors And Much More and How To Debug PowerShell Scripts.

END Block

END block is empty.

INFO: To understand BEGINPROCESS and END blocks in PowerShell please read PowerShell Function Begin Process End Blocks Explained With Examples.

Comment-Based Help Section

For every one of my own CmdLets, I write Comment-Based help as well.

INFO: If you want to learn how to write comment-based Help for your own PowerShell Functions and Scripts please read these articles How To Write PowerShell Help (Step by Step). In this article How To Write PowerShell Function’s Or CmdLet’s Help (Fast), I explain the PowerShell Add-on that help us to be fast with writing help content.

How To Use Get-DiskFreeSpace CmdLet – Tips

To get the free disk(s) space and disk(s) size for the local machine we just call Get-DiskFreeSpace CmdLet and provide values for mandatory parameters (client and solution).

Get-DiskFreeSpace -client "OK" -solution "FIN"

Here is the resultset.

Get-DiskFreeSpace CmdLet resultset for the local machine

As we have seen in the solution section of this article we can call Get-DiskFreeSpace CmdLet for the list of servers:

Get-DiskFreeSpace -filename "OKFINservers.txt" -client "OK" -solution "FIN" -Verbose -errorlog | Select-Object 'Environment', 'Logical Name', 'Server Name', 'Drive', 'Size(GB)', 'Free Space(GB)', 'Free (%)', 'IP', 'Collected' | Out-GridView

Here is the resultset for the list of servers.

Get-DiskFreeSpace CmdLet resultset

We can PowerShell pipeline result from Get-DiskFreeSpace CmdLet into Save-ToExcel CmdLet and get resultset as an Excel Sheet:

Get-DiskFreeSpace -filename "OKFINservers.txt" -errorlog -client "OK" -solution "FIN" -Verbose | Save-ToExcel -errorlog -ExcelFileName "Get-DiskFreeSpace" -title "Free disk space on servers in Financial solution for " -author "DJ PowerScirpt" -WorkSheetName "Disk free space" -client "OK" -solution "FIN"

Here is the Excel Sheet result:

Get-DiskFreeSpace CmdLet resultset as Excel Sheet

REMINDER: As I have already mentioned it is always smart to have monitoring tools (Like HP SiteScope or HP Operations Manager for example) that will control critical points in your system and send you alerts when for example disk free space drops a certain level.

I have used Get-DiskFreeSpace CmdLet as part of the monthly maintenance routine on the servers that I have maintained to be proactive although I have had alerts set up in monitoring tools.

If you log disk free space data in the database over time and use some reporting tool to pull out these data to show trends of free disk space that is fantastic for disk capacity planning as I mentioned in the tip below. I have used the MS SQL database combined with MS SQL Reporting Services and it worked for me just fine.

TIP: If you log the data about free disk space in the database over time you can create nice reports that can be useful for disk capacity planning so you can either expand disk size on a virtual machine or order and add additional disk(s) in your server or disk storage.

Useful PowerShell Disk Articles

Here are some useful articles and resources:

Get-DiskFreeSpace CmdLet Source Code

DISCLAIMERGet-DiskFreeSpace function is part of the Efficiency Booster PowerShell Project and as such utilize other CmdLets that are part of the same project. So the best option for you in order for this function to work without any additional customization is to download the source code of the whole project from here.

INFO: My best advice to every PowerShell scripter is to learn writing own PowerShell Advanced Functions and CmdLets and I have written several articles explaining this, so please read them. How To Create A Custom PowerShell CmdLet (Step By Step). Here I explain how to use PowerShell Add-on Function to be faster in writing PowerShell Functions How To Write Advanced Functions Or CmdLets With PowerShell (Fast).

Here is the source code of the whole Get-DiskFreeSpace CmdLet:

<#
.SYNOPSIS
Gets disk drives free space for a list of computers
.DESCRIPTION
Get-DiskFreeSpace gets disk drives free space for list of servers. List of servers is in txt file in 01servers folder
or list of strings with names of computers.
CmdLet has two ParameterSets one for list of computers from file and another from list of strings as computer names.

Errors will be saved in log folder PSLogs with name Error_Log.txt. Parameter errorlog controls logging of errors in log file.

Get-DiskFreeSpace function uses Get-CimInstance -Class CIM_LogicalDisk PowerShell function to get disk free space info.

Result shows following columns: Environment (PROD, Acceptance, Test, Course...), 
Logical Name (Application, web, integration, FTP, Scan, Terminal Server...), Server Name
Drive, Size(GB), Free Space(GB), Free (%), IP
.PARAMETER computers
List of computers that we want to get Disk free space info from. Parameter belongs to default Parameter Set = ServerNames.
.PARAMETER filename
Name of txt file with list of servers that we want to check Disk free space info. .txt file should be in 01servers folder.
Parameter belongs to Parameter Set = FileName.
.PARAMETER errorlog
Switch parameter that sets to write to log or not to write to log. Error file is in PSLog folder with name Error_Log.txt.
.PARAMETER client
OK - O client
BK - B client
etc.
.PARAMETER solution
FIN - Financial solution 
HR - Human resource solution
etc. 

.EXAMPLE
Get-DiskFreeSpace -client "OK" -solution "FIN"

Description
---------------------------------------
Test of default paramater with default value ( computers = 'localhost' ) in default ParameterSet = ServerName.

.EXAMPLE
Get-DiskFreeSpace -client "OK" -solution "FIN" -Verbose

Description
---------------------------------------
Test of Verbose paramater. NOTE: Notice how localhost default value of parameter computers replaces with name of server.

.EXAMPLE
'ERROR' | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog

Description
---------------------------------------
Test of errorlog parameter. There is no server with name ERROR so this call will fail and write to Error log since errorlog switch parameter is on. Look Error_Log.txt file in PSLogs folder.

.EXAMPLE
Get-DiskFreeSpace -computers 'APP100001' -client "OK" -solution "FIN" -errorlog

Description
---------------------------------------
Test of computers parameter with one value. Parameter accepts array of strings.

.EXAMPLE
Get-DiskFreeSpace -computers 'APP100001', 'APP100002' -client "OK" -solution "FIN" -errorlog -Verbose

Description
---------------------------------------
Test of computers parameter with array of strings. Parameter accepts array of strings.

.EXAMPLE
Get-DiskFreeSpace -hosts 'APP100001' -client "OK" -solution "FIN" -errorlog

Description
---------------------------------------
Test of computers paramater alias hosts.

.EXAMPLE
Get-DiskFreeSpace -computers (Get-Content( "$home\Documents\WindowsPowerShell\Modules\01servers\OKFINservers.txt" )) -client "OK" -solution "FIN" -errorlog -Verbose

Description
---------------------------------------
Test of computers parameter and values for parameter comes from .txt file that has list of servers.

.EXAMPLE
'APP100001' | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog

Description
---------------------------------------
Test of pipeline by value of computers parameter.

.EXAMPLE
'APP100001', 'APP100002' | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog -Verbose

Description
---------------------------------------
Test of pipeline by value with array of strings of computers parameter.

.EXAMPLE
'APP100001', 'APP100002' | Select-Object @{label="computers";expression={$_}} | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog

Description
---------------------------------------
Test of values from pipeline by property name (computers).

.EXAMPLE
Get-Content( "$home\Documents\WindowsPowerShell\Modules\01servers\OKFINkursservers.txt" ) | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog -Verbose

Description
---------------------------------------
Test of pipeline by value that comes as content of .txt file with list of servers.

.EXAMPLE
Help Get-DiskFreeSpace -Full

Description
---------------------------------------
Test of Powershell help.

.EXAMPLE
Get-DiskFreeSpace -filename "OKFINservers.txt" -errorlog -client "OK" -solution "FIN" -Verbose

Description
---------------------------------------
This is test of ParameterSet = FileName and parameter filename. There is list of servers in .txt file.

.EXAMPLE
Get-DiskFreeSpace -filename "OKFINserverss.txt" -errorlog -client "OK" -solution "FIN" -Verbose

Description
---------------------------------------
This is test of ParameterSet = FileName and parameter filename. This test will fail due to wrong name of the .txt file with warning message "WARNING: This file path does NOT exist:".

.INPUTS
System.String

Computers parameter pipeline both by Value and by Property Name value and has default value of localhost. (Parameter Set = ComputerNames)
Filename parameter does not pipeline and does not have default value. (Parameter Set = FileName)
.OUTPUTS
System.Management.Automation.PSCustomObject

Get-DiskFreeSpace returns PSCustomObjects which has been converted from PowerShell function Get-CimInstance -Class CIM_LogicalDisk
Result shows following columns: Environment (PROD, Acceptance, Test, Course...), 
Logical name (Application, web, integration, FTP, Scan, Terminal Server...), Server name
Drive, Size(GB), Free Space(GB), Free (%), IP

.NOTES
FunctionName : Get-DiskFreeSpace
Created by   : Dejan Mladenovic
Date Coded   : 10/31/2018 19:06:41
More info    : https://improvescripting.com/

.LINK 
https://improvescripting.com/how-to-get-disk-size-and-disk-free-space-using-powershell
Get-WmiObject -Class Win32_LogicalDisk
Get-CimInstance -Class CIM_LogicalDisk
#>
Function Get-DiskFreeSpace {
[CmdletBinding(DefaultParametersetName="ServerNames")]
param (
    [Parameter( ValueFromPipeline=$true,
                ValueFromPipelineByPropertyName=$true,
                ParameterSetName="ServerNames",
                HelpMessage="List of computer names separated by commas.")]
    [Alias('hosts')] 
    [string[]]$computers = 'localhost',
    
    [Parameter( ParameterSetName="FileName",
                HelpMessage="Name of txt file with list of servers. Txt file should be in 01servers folder.")] 
    [string]$filename,
    
    [Parameter( Mandatory=$false,
                HelpMessage="Write to error log file or not.")]
    [switch]$errorlog,
    
    [Parameter(Mandatory=$true, 
                HelpMessage="Client for example OK = O client, BK = B client")]
    [string]$client,
     
    [Parameter(Mandatory=$true,
                HelpMessage="Solution, for example FIN = Financial, HR = Human Resource")]
    [string]$solution     
)

BEGIN {

    if ( $PsCmdlet.ParameterSetName -eq "FileName") {

        if ( Test-Path -Path "$home\Documents\WindowsPowerShell\Modules\01servers\$filename" -PathType Leaf ) {
            Write-Verbose "Read content from file: $filename"
            $computers = Get-Content( "$home\Documents\WindowsPowerShell\Modules\01servers\$filename" )        
        } else {
            Write-Warning "This file path does NOT exist: $home\Documents\WindowsPowerShell\Modules\01servers\$filename"
            Write-Warning "Create file $filename in folder $home\Documents\WindowsPowerShell\Modules\01servers with list of server names."
            break;
        }
       
    }
}
PROCESS { 
                        
    foreach ($computer in $computers) {
        
        if ( $computer -eq 'localhost' ) {
            $computer = $env:COMPUTERNAME
            Write-Verbose "Replace localhost with real name of the server."
        }
        
        $computerinfo = Get-ComputerInfo -computername $computer -client $client -solution $solution
        $hostname = $computerinfo.hostname
        $env = $computerinfo.environment
        $logicalname = $computerinfo.logicalname
        $ip = $computerinfo.ipaddress

        try {
        
            Write-Verbose "Start processing: $computer - $env - $logicalname"
            Write-Verbose "Start CIM_LogicalDisk processing..."
            
            $drives = $null
            $drive = $null
            $obj = $null
            
            <#
            $params = @{'ComputerName'=$computer;
                        'Filter'="DriveType=3";
                        'Class'='Win32_LogicalDisk';
                        'ErrorAction'='Stop'}
            #>
            $params = @{'ComputerName'=$computer;
                        #'Filter'="DriveType=3";
                        'Class'='CIM_LogicalDisk';
                        'ErrorAction'='Stop'}

            

#IMPORTANT - DO NOT use formatting {("{0:N2}" -f($_.size/1gb))} of expression if you want to explicit convert to decimal data type. (see down in properties variable)   
            #Get-WmiObject                         
            $drives = Get-CimInstance @params | 
                        Select-Object @{Name="Size(GB)";Expression={$_.size/1gb}}, 
                                      @{Name="Free Space(GB)";Expression={$_.freespace/1gb}},
                                      @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}},
                                      DeviceID,
                                      DriveType |
                        Where-Object DriveType -EQ '3'
                        
                        <#
                        Select-Object @{Name="Size(GB)";Expression={("{0:N2}" -f($_.size/1gb))}}, 
                                      @{Name="Free Space(GB)";Expression={("{0:N2}" -f($_.freespace/1gb))}},
                                      @{Name="Free (%)";Expression={"{0,6:P0}" -f(($_.freespace/1gb) / ($_.size/1gb))}},
                                      DeviceID
                        #>
                             
            Write-Verbose "Finish CIM_LogicalDisk processing..."
            
            foreach ($drive in $drives) {
            
                Write-Verbose "Start processing drive: $drive"
                
                $properties = @{'Environment'=$env;
                                'Logical Name'=$logicalname;
            	                'Server Name'=$computer;
            	                'Drive'=$drive.DeviceID;
            	                'Size(GB)'=[decimal]$drive."Size(GB)";
            	                'Free Space(GB)'=[decimal]$drive."Free Space(GB)";
            	                'Free (%)'=$drive."Free (%)";
                                'IP'=$ip;
                                'Collected'=(Get-Date -UFormat %Y.%m.%d' '%H:%M:%S)}
                
                $obj = New-Object -TypeName PSObject -Property $properties
                $obj.PSObject.TypeNames.Insert(0,'Report.DiskSpaceInfo')

                Write-Output $obj
                Write-Verbose "Finish processing drive: $drive"
            }
            
        Write-Verbose "Computer processed: $computer - $env - $logicalname"
        
        } catch {
                 Write-Warning "Computer failed: $computer - $env - $logicalname Drive failed: $drive"
                 Write-Warning "Error message: $_"

                if ( $errorlog ) {

                    $errormsg = $_.ToString()
                    $exception = $_.Exception
                    $stacktrace = $_.ScriptStackTrace
                    $failingline = $_.InvocationInfo.Line
                    $positionmsg = $_.InvocationInfo.PositionMessage
                    $pscommandpath = $_.InvocationInfo.PSCommandPath
                    $failinglinenumber = $_.InvocationInfo.ScriptLineNumber
                    $scriptname = $_.InvocationInfo.ScriptName

                    Write-Verbose "Start writing to Error log."
                    Write-ErrorLog -hostname $computer -env $env -logicalname $logicalname -errormsg $errormsg -exception $exception -scriptname $scriptname -failinglinenumber $failinglinenumber -failingline $failingline -pscommandpath $pscommandpath -positionmsg $pscommandpath -stacktrace $stacktrace
                    Write-Verbose "Finish writing to Error log."
                }        
        }
        
    }
}
END { }
}
#region Execution examples
#Get-DiskFreeSpace -filename "OKFINservers.txt" -client "OK" -solution "FIN" -Verbose -errorlog | Select-Object 'Environment', 'Logical Name', 'Server Name', 'Drive', 'Size(GB)', 'Free Space(GB)', 'Free (%)', 'IP', 'Collected' | Out-GridView


<#
#Test ParameterSet = ServerName
Get-DiskFreeSpace -client "OK" -solution "FIN"
Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog
Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog -Verbose
Get-DiskFreeSpace -computers 'APP100001' -client "OK" -solution "FIN" -errorlog
Get-DiskFreeSpace -computers 'APP100001', 'APP100002' -client "OK" -solution "FIN" -errorlog -Verbose
Get-DiskFreeSpace -hosts 'APP100001' -client "OK" -solution "FIN" -errorlog
Get-DiskFreeSpace -computers (Get-Content( "$home\Documents\WindowsPowerShell\Modules\01servers\OKFINservers.txt" )) -client "OK" -solution "FIN" -errorlog -Verbose

#Pipeline examples
'APP100001' | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog
'APP100001', 'APP100002' | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog -Verbose
'APP100001', 'APP100002' | Select-Object @{label="computers";expression={$_}} | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog
Get-Content( "$home\Documents\WindowsPowerShell\Modules\01servers\OKFINservers.txt" ) | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog -Verbose
'ERROR' | Get-DiskFreeSpace -client "OK" -solution "FIN" -errorlog

#Test CmdLet help
Help Get-DiskFreeSpace -Full

#SaveToExcel
Get-DiskFreeSpace -filename "OKFINservers.txt" -errorlog -client "OK" -solution "FIN" -Verbose | Save-ToExcel -errorlog -ExcelFileName "Get-DiskFreeSpace" -title "Free disk space on servers in Financial solution for " -author "DJ PowerScirpt" -WorkSheetName "Disk free space" -client "OK" -solution "FIN" 
#SaveToExcel and send email
Get-DiskFreeSpace -filename "OKFINservers.txt" -errorlog -client "OK" -solution "FIN" -Verbose | Save-ToExcel -sendemail -errorlog -ExcelFileName "Get-DiskFreeSpace" -title "Free disk space on servers in Financial solution for " -author "DJ PowerScirpt" -WorkSheetName "Disk free space" -client "OK" -solution "FIN" 

#Benchmark
#Time = 2 sec; Total Items = 72
Measure-BenchmarksCmdLet { Get-DiskFreeSpace -filename "OKFINservers.txt" -errorlog -client "OK" -solution "FIN" -Verbose }
#Time = 1,3 sec; Total Items = 72
Measure-BenchmarksCmdLet { Get-DiskFreeSpace -filename "OKFINservers.txt" -errorlog -client "OK" -solution "FIN" }

#Test ParameterSet = FileName
Get-DiskFreeSpace -filename "OKFINservers.txt" -errorlog -client "OK" -solution "FIN" -Verbose
Get-DiskFreeSpace -filename "OKFINserverss.txt" -errorlog -client "OK" -solution "FIN" -Verbose
#>
#endregion

About Dejan Mladenović

Hey Everyone! I hope that this article you read today has taken you from a place of frustration to a place of joy coding! Please let me know of anything you need for Windows PowerShell in the comments below that can help you achieve your goals!
I have 18+ years of experience in IT and you can check my Microsoft credentials. Transcript ID: 750479 and Access Code: DejanMladenovic
Credentials
About Me...

My Posts | Website

Dejan Mladenović

Hey Everyone! I hope that this article you read today has taken you from a place of frustration to a place of joy coding! Please let me know of anything you need for Windows PowerShell in the comments below that can help you achieve your goals! I have 18+ years of experience in IT and you can check my Microsoft credentials. Transcript ID: 750479 and Access Code: DejanMladenovic
Credentials About Me...

4 thoughts on “How To Get Disk Size And Disk Free Space Using PowerShell

    1. Hi Alex. You are welcome I am glad that you have found useful information and maybe some of your questions answered. I will start my YouTube Channel very soon and that is my next step in order to do the marketing of this blog.
      When I upload a few videos I will send you the link so you can look at it and share it with your friends and colleagues.
      Stay tuned and cheers.

  1. I simply couldn’t leave your web site before suggesting that I really loved the usual information an individual provide in your guests? Is going to be back continuously in order to check for new posts, thanks!

    1. Hi Verdell. You are most welcomed to come back I plan to write many more articles and very soon to start with YouTube channel as well.

      Stay tuned and cheers.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Recent Content