Remove-SmbMapping

Removes the Server Message Block (SMB) mapping to an SMB share.

Syntax

Remove-SmbMapping
      [[-LocalPath] <String[]>]
      [[-RemotePath] <String[]>]
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-Force]
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-UpdateProfile]
      [-Confirm]
      [-WhatIf]
Remove-SmbMapping
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-Force]
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-UpdateProfile]
      -InputObject <CimInstance[]>
      [-Confirm]
      [-WhatIf]

Description

The Remove-SmbMapping cmdlet removes the Server Message Block (SMB) mapping to an SMB share.

Examples

EXAMPLE 1

PS C:\>Remove-SmbMapping -LocalPath Y:
Confirm 
Are you sure you want to perform this action? 
Performing operation 'Close-Connection' on Target 'Y:,\\Contoso-FS\VMS1'. 
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"):

This example removes an SMB mapping to an SMB share.

EXAMPLE 2

PS C:\>Remove-SmbMapping -RemotePath \\Contoso-SO\VMFiles -Force

This example removes an SMB mapping to an SMB share without user confirmation.

Required Parameters

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LocalPath

Specifies the local path associated with the SMB mapping being removed.

Type:String[]
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RemotePath

Specifies the remote path, the path of the SMB share, associated with the mapping being removed.

Type:String[]
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UpdateProfile

Indicates that the mapping is removed persistently and the mapping will not be re-established when the computer reboots. If this parameter is set to True and the mapping is persistent, then the mapping is removed persistently and the mapping will not be re-established when the computer reboots.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

None