Skip to content
PowerShell Commands

New-SmbMapping

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

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.

-HomeFolder [<SwitchParameter>]

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

-LocalPath [<String>]

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

-Password [<String>]

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

-Persistent [<Boolean>]

Indicates that this connection is persistent.

-RemotePath [<String>]

Specifies the remote path that is accessed from this computer.

-SaveCredentials [<SwitchParameter>]

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

-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 PowerShellr 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.

-UserName [<String>]

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

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

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.

<CommonParameters>

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

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.
Examples
  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.

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