PowerShell Commands

Remove-PSDrive

Remove-PSDrive [-LiteralName*] <String[]> [-Confirm] [-Force] [-PSProvider <String[]>] [-Scope <String>][-UseTransaction] [-WhatIf] [<CommonParameters>]
Remove-PSDrive [-Name*] <String[]> [-Confirm] [-Force] [-PSProvider <String[]>] [-Scope <String>] [-UseTransaction][-WhatIf] [<CommonParameters>]

The Remove-PSDrive cmdlet deletes temporary Windows PowerShell drives that were created by using the New-PSDrive cmdlet.

Starting in Windows PowerShell 3.0, Remove-PSDrive also disconnects mapped network drives, including, but not limited to, drives created by using the Persist parameter of New-PSDrive . Remove-PSDrive cannot delete Windows physical or logical drives.

Starting in Windows PowerShell 3.0, when an external drive is connected to the computer, Windows PowerShell automatically adds a PSDrive to the file system that represents the new drive. You do not have to restart Windows PowerShell. Similarly, when an external drive is disconnected from the computer, Windows PowerShell automatically deletes the PSDrive that represents the removed drive.

Parameters

-Confirm [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Prompts you for confirmation before running the cmdlet.

-Force [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Removes the current Windows PowerShell drive.

-LiteralName <String[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByPropertyName

Specifies the name of the drive.

The value of LiteralName is used exactly as typed. No characters are interpreted as wildcard characters. If the name includes escape characters, enclose it in single quotation marks. Single quotation marks instruct Windows PowerShell not to interpret any characters as escape sequences.

-Name <String[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByPropertyName

Specifies the names of the drives to remove. Do not type a colon (:) after the drive name.

-PSProvider <String[]>

  • Default value is None
  • Accepts pipeline input ByPropertyName

Specifies an array of PSProvider objects. This cmdlet removes and disconnects all of the drives associated with the specified Windows PowerShell provider.

-Scope <String>

  • Default value is None
  • Accepts pipeline input ByPropertyName

Specifies an index that identifies the scope from which the drive is being removed.

-UseTransaction [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.

-WhatIf [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
System.Management.Automation.PSDriveInfo
You can pipe a drive object, such as one from the Get-PSDrive cmdlet, to the this cmdlet.
Outputs
None
This cmdlet does not return any output.
Examples
  1. Remove a file system drive:
    PS C:\> Remove-PSDrive -Name smp
    

    This command removes a temporary file system drive named smp.

  2. Remove mapped network drives:
    PS C:\> Get-PSDrive X, S | Remove-PSDrive
    

    This command disconnects the X: mapped network drive that was created in File Explorer and the S: mapped network drive that was created by using the Persist parameter of the New-PSDrive cmdlet.

    The command uses the Get-PSDrive cmdlet to get the drives and Remove-PSDrive to disconnect them.

Additional Notes
 Remove-PSDrive * is designed to work with the data exposed by any Windows PowerShell provider. To list the 
 providers in your session, use the Get-PSProvider cmdlet. For more information, see about_Providers 
 (http://go.microsoft.com/fwlink/?LinkID=113250).

 *

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands