< Back
Remove-SmbMapping
Post
NAME Remove-SmbMapping
SYNOPSIS
Removes the SMB mapping to an SMB share.
SYNTAX
Remove-SmbMapping [[-LocalPath] <String[]>] [[-RemotePath] <String[]>] [-CimSession <CimSession[]>] [-Force] [-PassThru] [-ThrottleLimit <Int32>]
[-UpdateProfile] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-SmbMapping [-CimSession <CimSession[]>] [-Force] [-PassThru] [-ThrottleLimit <Int32>] [-UpdateProfile] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-SmbMapping cmdlet removes the Server Message Block (SMB) mapping to an SMB share.
PARAMETERS
-CimSession [<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-CimSession or
Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LocalPath [<String[]>]
Specifies an array of the local paths associated with the SMB mappings that this cmdlet removes.
Required? false
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RemotePath [<String[]>]
Specifies an array of the remote paths of the SMB shares associated with the mappings that this cmdlet removes.
Required? false
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UpdateProfile [<SwitchParameter>]
Indicates that the mapping is removed persistently. The mapping is not re-established when the computer restarts. If you specify this parameter and
the mapping is persistent, the mapping is removed persistently. The mapping is not re-established when the computer restarts.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
Example 1: Remove an SMB mapping to an SMB share
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 command removes an SMB mapping to an SMB share.
Example 2: Remove an SMB mapping to an SMB share without confirmation
PS C:\\>Remove-SmbMapping -RemotePath "\\\\Contoso-SO\\VMFiles" -Force
This command removes an SMB mapping to an SMB share without user confirmation.
RELATED LINKS
Get-SmbMapping
New-SmbMapping
SYNOPSIS
Removes the SMB mapping to an SMB share.
SYNTAX
Remove-SmbMapping [[-LocalPath] <String[]>] [[-RemotePath] <String[]>] [-CimSession <CimSession[]>] [-Force] [-PassThru] [-ThrottleLimit <Int32>]
[-UpdateProfile] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-SmbMapping [-CimSession <CimSession[]>] [-Force] [-PassThru] [-ThrottleLimit <Int32>] [-UpdateProfile] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-SmbMapping cmdlet removes the Server Message Block (SMB) mapping to an SMB share.
PARAMETERS
-CimSession [<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-CimSession or
Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LocalPath [<String[]>]
Specifies an array of the local paths associated with the SMB mappings that this cmdlet removes.
Required? false
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RemotePath [<String[]>]
Specifies an array of the remote paths of the SMB shares associated with the mappings that this cmdlet removes.
Required? false
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UpdateProfile [<SwitchParameter>]
Indicates that the mapping is removed persistently. The mapping is not re-established when the computer restarts. If you specify this parameter and
the mapping is persistent, the mapping is removed persistently. The mapping is not re-established when the computer restarts.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
Example 1: Remove an SMB mapping to an SMB share
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 command removes an SMB mapping to an SMB share.
Example 2: Remove an SMB mapping to an SMB share without confirmation
PS C:\\>Remove-SmbMapping -RemotePath "\\\\Contoso-SO\\VMFiles" -Force
This command removes an SMB mapping to an SMB share without user confirmation.
RELATED LINKS
Get-SmbMapping
New-SmbMapping