Hey, Scripting Guy! How Can I Tell How Much Free Disk Space a User Has?

ScriptingGuy1

I know most people have heard of Moore’s Law that is named after Gordon Moore, but have you ever heard of Bob’s law? Bob was the senior network administrator when I first became an IT pro, and he created what he called Bob’s Law. Briefly stated it says this: “A user’s demand for storage space will always expand to meet the available storage space, plus 10 percent.” In other words, we can never have too much disk space for users.

Well, at work, we are currently being ravaged by Bob’s Law; our users are constantly running out of disk space on their work stations, their laptops, and even their Windows smart phones. I go into some offices, and they have USB sticks stuck in every available port on their laptops, and some users have even gone so far as to buy external USB hubs and stick stuff in there as well. The things look like some kind of infernal terminator porcupine. I know we cannot suspend Bob`s Law, but I need a script that I can run remotely that will tell me how much free disk space a user has. Can you help me?

– EC

Hi EC,

So your users say they do not have enough free disk space? Tell them to open Windows PowerShell and type Format c…just kidding. That command will delete all their files. That is an old IT joke, about as old as Bob’s law.

To aid you in managing your users’ incessant demands for disk space, it might be useful to be able to retrieve the amount of free disk space from a remote computer before it becomes a crisis. We can use the Win32_LogicalDisk WMI class with the Get-WmiObject cmdlet from Windows PowerShell. An example of doing this is seen in the GetFreeDiskSpace.ps1 script.

Get-FreeDiskSpace.ps1

Function Get-FreeDiskSpace($drive,$computer)
{
 $driveData = Get-WmiObject -class win32_LogicalDisk `
 -computername $computer -filter "Name = '$drive'"
"$computer free disk space on drive $drive"
"{0:n2}" -f ($driveData.FreeSpace/1MB) + " MegaBytes"
}
Get-FreeDiskSpace -drive "C:" -computer "vista"

The first thing we do in the Get-FreeDiskSpace.ps1 script is to create a function. To create a function that uses multiple input parameters we use the Function keyword, specify the name of the function, use variables for each input parameter, and define the script block within the curly brackets.

The Get-FreeDiskSpace.ps1 script begins with the Function keyword, the name of the function, and the two input parameters. The first input parameter is the drive name, and the second is the name of the computer. The input parameters are placed inside smooth parentheses with a variable used to hold the data that comes in when the function is called:

Function Get-FreeDiskSpace($drive,$computer)
{

Inside the curly brackets the Get-FreeDiskSpace function uses the Get-WmiObject cmdlet to query the Win32_LogicalDisk WMI class. It connects to the computer specified in the $computer parameter, and it filters out only the drive that is specified in the $drive parameter. When the function is called, the parameters are specified as –drive and –computer. In the function definition, the variables $drive and $computer are used to hold the values supplied to the parameters.

The –filter parameter from the Get-WmiObject cmdlet is used to limit the number of instances that are returned by the WMI query. The filter takes the place of the whereclause from VBScript WMI Query Language (WQL) statements. The filter in our script limits the number of instances that are returned to only the one specified in the $drive variable. Here is our filter:

-filter "Name = '$drive'

The thing that is perhaps surprising is that the value contained in the $drive variable still gets read. You may recall from previous “Hey, Scriting Guy!” articles that I went on and on at great length about the difference between literal quotation marks and expanding quotation marks. We also have this documented as a Windows PowerShell tip. Well, you can forget that here. When you are working with the filter parameter of the Get-WmiObject cmdlet, you are using WQL syntax, not Windows PowerShell syntax. This is why you use the equal sign instead of –eq. It is also why the single quotation mark is not a literal quotation mark, so we still have access to the value of the $drive variable.

An excellent reference for learning WMI is the Microsoft Press book, Microsoft Windows Scripting with WMI: Self-Paced Learning Guide. While the examples are all written in VBScript, WMI technology is still the same.

If we were to use the Get-WmiObject cmdlet by itself and query the Win32_Logicaldisk WMI class, we would see an output similar to this:

There is more data returned from the WMI query than that which is displayed in the preceding image. Windows PowerShell creates s a nice display of information that is considered to be most useful to the network administrator. If you want to see more information, you can easily obtain it by using either the methods or properties seen in Table 1.

After the data from WMI is retrieved, it is stored in the $driveData variable. The data that is stored in the $driveData variable is an instance of the Win32_LogicalDisk. This variable contains a complete instance of the class. The members of this class are seen in Table 1.

Table 1 Members of the Win32_LogicalDisk class

System.String VolumeSerialNumber {get;set;}

After you have the data stored in the $driveData variable, you will want to print out some information to the user of the script. The first thing to do is print out the name of the computer and the name of the drive. To do this, you can place the variables inside double quotation marks. Double quotation marks are expanding strings, and variables placed inside double quotation marks emit their value, not their name. This is seen here:

"$computer free disk space on drive $drive"

The next thing you will want to do is to format the data that is returned. To do this, use the .NET Framework format strings to specify two decimal places. We will need to use smooth parentheses to force the evaluation of the free disk space prior to formatting it to two decimal places. This is seen here:

"{0:n2}" -f ($driveData.FreeSpace/1MB) + " MegaBytes"

When you run the script you see the name of the computer, the name of the drive, and the amount of free disk space expressed in megabytes:

office free disk space on drive C:
54,108.36 MegaBytes

Well, EC, that is about it for using WMI to obtain free disk space. Join us tomorrow as Desktop Week continues. Until then, peace.

Ed Wilson and Craig Liebendorfer, Scripting Guys

ScriptingGuy1

Follow