New-Smb Mapping

Module:
smbshare
Creates an SMB mapping.

Syntax 

New-SmbMapping
   [[-LocalPath] <String>]
   [[-RemotePath] <String>]
   [-UserName <String>]
   [-Password <String>]
   [-Persistent <Boolean>]
   [-SaveCredentials]
   [-HomeFolder]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-SmbMapping cmdlet creates a Server Message Block (SMB) mapping on the SMB client to an SMB share.

Examples

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.

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

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

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-HomeFolder

Indicates that the connection is made to the home folder of the user.

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

Specifies the local path to which the remote path is mapped.

Type: String
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Password

Specifies the password to be used to connect to the SMB share.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Persistent

Indicates that this connection is persistent.

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

Specifies the remote path that is accessed from this computer.

Type: String
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SaveCredentials

Indicates that the credentials provided should be saved for when a mapping to the same SMB server also is created.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
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
-UserName

Specifies the user name to use to connect to the SMB share.

Type: String
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
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

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.