New-SmbMapping

Module:

SmbShare

Creates an SMB mapping.

Syntax

New-SmbMapping
   [[-LocalPath] <String>]
   [[-RemotePath] <String>]
   [-AsJob]
   [-BlockNTLM <Boolean>][-CimSession <CimSession[]>]
   [-CompressNetworkTraffic <Boolean>]
   [-Confirm][-Credential <PSCredential>]
   [-GlobalMapping]
   [-HomeFolder]
   [-Password <String>][-Persistent <Boolean>]
   [-QuicPort <UInt16>]
   [-RdmaPort <UInt16>]
   [-RequireIntegrity <Boolean>][-RequirePrivacy <Boolean>]
   [-SaveCredentials]
   [-SkipCertificateCheck]
   [-TcpPort <UInt16>][-ThrottleLimit <Int32>]
   [-TransportType <TransportType>]
   [-UserName <String>][-UseWriteThrough <Boolean>]
   [-WhatIf]
   [<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

New-SmbMapping -LocalPath "X:" -RemotePath "\\Contoso-SO\VMFiles"
Status                                  Local Path                              Remote Path
------                                  ----------                              -----------
OK                                      X:                                      \\Contoso-SO\VMFiles

This command creates an SMB mapping.

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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BlockNTLM

Specifies whether to block NT LAN Manager (NTLM) authentication. If this parameter is set to $true, NTLM authentication will be blocked forcing the connection to use another negotiated authentication method, such as Kerberos. If set to $false (default), NTLM authentication will be allowed.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CompressNetworkTraffic

Indicates that SMB compression is requested for the mapped drive if the SMB server supports it.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies a user account that has permission to perform a specific task, such as running a script or accessing a remote computer. When you use this parameter, PowerShell will prompt you for the password of the specified user account, and then use those credentials to perform the requested task.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-GlobalMapping

Indicates that the SMB mapping is global instead of user-specific and is equivalent to using New-SmbGlobalMapping without any explicit allow or deny settings.

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

-Persistent

Indicates that this connection is persistent.

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

-QuicPort

Specifies the destination port number used by the SMB server for QUIC protocol connections.

Type:	UInt16
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RdmaPort

Specifies the destination port number used by the SMB server for Remote Direct Memory Access (RDMA) protocol connections.

Type:	UInt16
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemotePath

Specifies the remote path that's accessed from this computer.

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

-RequireIntegrity

Indicates that SMB signing is required for the mapped drive.

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

-RequirePrivacy

Indicates that SMB encryption is required for the mapped drive.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipCertificateCheck

Indicates that the client doesn't need to trust the server certificate's issuer in order to connect using SMB over QUIC.

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

-TcpPort

Specifies the destination port number used by the SMB server for Transmission Control Protocol (TCP) connections.

Type:	UInt16
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TransportType

Specifies the network transport used by SMB. The acceptable values for this parameter are:

• TCP: Use TCP network transport.
• QUIC: Use QUIC network transport.
• None: Use default transport behavior (first try TCP then try QUIC).

Type:	TransportType
Accepted values:	None, TCP, QUIC
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseWriteThrough

Indicates that forced unit access (write through) is required and bypasses all OS caches, forcing IO to disk.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

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

Inputs

None

Outputs

CimInstance

This cmdlet returns a MSFT_SmbMapping object that represents the newly created SMB mapping.

Related Links

• Get-SmbMapping
• Remove-SmbMapping