Get-PSDrive PowerShell Get-Help Output

This is the built-in help made by Microsoft for the command 'Get-PSDrive', in PowerShell version 2 - as retrieved from Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

SYNTAX

Get-PSDrive [-LiteralName] <string[]> [-PSProvider <string[]>] [-Scope <string>] [-UseTransaction] [<CommonParameters>]
Get-PSDrive [[-Name] <string[]>] [-PSProvider <string[]>] [-Scope <string>] [-UseTransaction] [<CommonParameters>]

Search powershellhelp.space

DESCRIPTION

The Get-PSDrive cmdlet gets the Windows PowerShell drives in the current session. You can get a particular drive or all drives in the console.

Get-PSDrive gets the following drives:

-- Windows logical drives on the computer, including drives mapped to network shares.

-- Drives exposed by Windows PowerShell providers (such as the Certificate:, Function:, and Alias: drives) and the HKLM: and HKCU: drives that ar
e exposed by the Windows PowerShell Registry provider.

-- Drives that you create by using New-PSDrive.

Get-PSDrive does not get Windows mapped drives that are added or created after the Windows PowerShell console is opened.

RELATED LINKS

REMARKS

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>get-psdrive

Name Provider Root
---- -------- ----
Alias Alias
C FileSystem C:\
cert Certificate \
D FileSystem D:\
Env Environment
Function Function
HKCU Registry HKEY_CURRENT_USER
HKLM Registry HKEY_LOCAL_MACHINE
Variable Variable
X FileSystem X:\

Description
-----------
This command gets the Windows PowerShell drives in the current session.

The output shows the hard drive (C:) and CD-ROM drive (D:) on the computer, the drives exposed by the Windows PowerShell providers (Alias:, Cert:
, Env:, Function:, HKCU:, HKLM:, and Variable:), and a drive mapped to a network share (X:).

-------------------------- EXAMPLE 2 --------------------------

C:\PS>get-psdrive d

Name Provider Root
---- -------- ----
D FileSystem D:\

Description
-----------
This command displays the D: drive on the computer. Note that the drive letter is not followed by a colon.

-------------------------- EXAMPLE 3 --------------------------

C:\PS>get-psdrive -psprovider filesystem

Name Provider Root
---- -------- ----
C FileSystem C:\
D FileSystem D:\
X FileSystem X:\
Y FileSystem \\Server01\Public
Z FileSystem C:\Windows\System32

Description
-----------
This command displays all of the drives that are supported by the Windows PowerShell FileSystem provider. This includes fixed drives, logical par
titions, mapped network drives, and drives that you create by using New-PSDrive that are mapped to the file system drives.

This example shows that drives created by New-PSDrive have the name of the mapped location in the value of the Root property. Windows drives just
have the root of the drive letter.

-------------------------- EXAMPLE 4 --------------------------

C:\PS>if (!(get-psdrive X)) {
new-psdrive -name X -psprovider Registry -root HKLM:\Network
}
else { write-host "The X: drive is already in use." }

Description
-----------
This command checks to see whether the X drive is already in use as the Windows PowerShell drive name. If it is not, the command uses the New-PSD
rive cmdlet to create a Windows PowerShell drive that is mapped to the HKLM:\Network registry key.

-------------------------- EXAMPLE 5 --------------------------

C:\PS>get-psdrive -provider filesystem

C:\PS> get-psdrive -provider filesystem

Name Provider Root
---- -------- ----
C FileSystem C:\
D FileSystem D:\
X FileSystem X:\
Y FileSystem \\Server01\Public
Z FileSystem C:\Windows\System32

C:\PS> net use
New connections will be remembered.

Status Local Remote Network
-------------------------------------------------------------------------------
X: \\Server01\Public Microsoft Windows Network

C:\PS> [System.IO.DriveInfo]::getdrives()

Name : C:\
DriveType : Fixed
DriveFormat : NTFS
IsReady : True
AvailableFreeSpace : 39831498752
TotalFreeSpace : 39831498752
TotalSize : 79900368896
RootDirectory : C:\
VolumeLabel :
Name : D:\
DriveType : CDRom
DriveFormat :
IsReady : False
AvailableFreeSpace :
TotalFreeSpace :
TotalSize :
RootDirectory : D:\
VolumeLabel :
Name : X:\
DriveType : Network
DriveFormat : NTFS
IsReady : True
AvailableFreeSpace : 36340559872
TotalFreeSpace : 36340559872
TotalSize : 36413280256
RootDirectory : X:\
VolumeLabel : D_Drive

C:\PS> get-wmiobject win32_logicaldisk

DeviceID : C:
DriveType : 3
ProviderName :
FreeSpace : 39831252992
Size : 79900368896
VolumeName :
DeviceID : D:
DriveType : 5
ProviderName :
FreeSpace :
Size :
VolumeName :
DeviceID : X:
DriveType : 4
ProviderName : \\server01\public
FreeSpace : 36340559872
Size : 36413280256
VolumeName : D_Drive

C:\PS> get-wmiobject win32_networkconnection
LocalName RemoteName
-------------- ------------
x: \\server01\public

Description
-----------
This example compares the types of file system drives that are displayed by Get-PSDrive to those displayed by using other methods. This example d
emonstrates different ways to display drives in Windows PowerShell, and it shows that the drives created by using New-PSDrive are accessible only
in Windows PowerShell.

The first command uses Get-PSDrive to get all of the file system drives in the Windows PowerShell console. This includes the fixed drives (C: and
D:), the mapped network drive (X:), and two Windows PowerShell drives (Y: and Z:) that were created by using New-PsDrive.

A "net use" command, which displays Windows mapped network drives, displays only the X drive. It does not display drives that are created by New-
PSDrive. It shows that the X: drive is also mapped to \\Server01\Public.

The third command uses the GetDrives method of the Microsoft .NET Framework System.IO.DriveInfo class. This command gets the Windows file system
drives, including drive X:, but it does not get the drives created by New-PSDrive.

The fourth command uses the Get-WmiObject cmdlet to display the instances of the Win32_LogicalDisk class. It returns the C:, D:, and X: drives, b
ut not the drives created by New-PSDrive.

The last command uses the Get-WmiObject cmdlet to display the instances of the Win32_NetworkConnection class. Like "net use", it returns only the
X: drive.