< Back
New-SmbMapping
Post
NAME New-SmbMapping
SYNOPSIS
Creates an SMB mapping.
SYNTAX
New-SmbMapping [[-LocalPath] <String>] [[-RemotePath] <String>] [-CimSession <CimSession[]>] [-HomeFolder] [-Password <String>] [-Persistent <Boolean>]
[-SaveCredentials] [-ThrottleLimit <Int32>] [-UserName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-SmbMapping cmdlet creates a Server Message Block (SMB) mapping on the SMB client 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
-HomeFolder [<SwitchParameter>]
Indicates that the connection is made to the home folder of the user.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LocalPath [<String>]
Specifies the local path to which the remote path is mapped.
Required? false
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Password [<String>]
Specifies the password to be used to connect to the SMB share.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Persistent [<Boolean>]
Indicates that this connection is persistent.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RemotePath [<String>]
Specifies the remote path that is accessed from this computer.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SaveCredentials [<SwitchParameter>]
Indicates that the credentials provided should be saved for when a mapping to the same SMB server also is created.
Required? false
Position? named
Default value none
Accept pipeline input? false
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
-UserName [<String>]
Specifies the user name to use to connect to the SMB share.
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
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMapping
This cmdlet returns a MSFT_SmbMapping object that represents the newly created SMB mapping.
Example 1: Create an SMB mapping
PS C:\\>New-SmbMapping -LocalPath 'X:' -RemotePath '\\\\Contoso-SO\\VMFiles'
Status Local Path Remote Path
------ ---------- -----------
OK X: \\\\Contoso-SO\\VMFiles
This command creates an SMB mapping.
RELATED LINKS
Get-SmbMapping
Remove-SmbMapping
SYNOPSIS
Creates an SMB mapping.
SYNTAX
New-SmbMapping [[-LocalPath] <String>] [[-RemotePath] <String>] [-CimSession <CimSession[]>] [-HomeFolder] [-Password <String>] [-Persistent <Boolean>]
[-SaveCredentials] [-ThrottleLimit <Int32>] [-UserName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-SmbMapping cmdlet creates a Server Message Block (SMB) mapping on the SMB client 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
-HomeFolder [<SwitchParameter>]
Indicates that the connection is made to the home folder of the user.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LocalPath [<String>]
Specifies the local path to which the remote path is mapped.
Required? false
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Password [<String>]
Specifies the password to be used to connect to the SMB share.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Persistent [<Boolean>]
Indicates that this connection is persistent.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RemotePath [<String>]
Specifies the remote path that is accessed from this computer.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SaveCredentials [<SwitchParameter>]
Indicates that the credentials provided should be saved for when a mapping to the same SMB server also is created.
Required? false
Position? named
Default value none
Accept pipeline input? false
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
-UserName [<String>]
Specifies the user name to use to connect to the SMB share.
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
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMapping
This cmdlet returns a MSFT_SmbMapping object that represents the newly created SMB mapping.
Example 1: Create an SMB mapping
PS C:\\>New-SmbMapping -LocalPath 'X:' -RemotePath '\\\\Contoso-SO\\VMFiles'
Status Local Path Remote Path
------ ---------- -----------
OK X: \\\\Contoso-SO\\VMFiles
This command creates an SMB mapping.
RELATED LINKS
Get-SmbMapping
Remove-SmbMapping