Skip to main content

Get-FreeDiskSpace

SYNOPSIS

Retrieves the free disk space in MB on a particular drive (defaults to system drive)

SYNTAX

Get-FreeDiskSpace [[-Drive] <String>] [[-ContinueOnError] <Boolean>] [<CommonParameters>]

DESCRIPTION

Retrieves the free disk space in MB on a particular drive (defaults to system drive)

EXAMPLES

EXAMPLE 1

Get-FreeDiskSpace -Drive 'C:'

PARAMETERS

-Drive

Drive to check free disk space on

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: $envSystemDrive
Accept pipeline input: False
Accept wildcard characters: False

-ContinueOnError

Continue if an error is encountered. Default is: $true.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: True
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

You cannot pipe objects to this function.

OUTPUTS

System.Double

Returns the free disk space in MB

NOTES

https://psappdeploytoolkit.com