COMMAND EVERYTHING.

New-SmbMapping

Creates an SMB mapping.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft SmbShare reference: Creates an SMB mapping. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

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>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for New-SmbMapping. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / SmbShare · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-AsJob: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-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.
-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.
-CompressNetworkTraffic: Indicates that SMB compression is requested for the mapped drive if the SMB server supports it.
-Confirm: Prompts you for confirmation before running the cmdlet.
-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.
-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.
-HomeFolder: Indicates that the connection is made to the home folder of the user.
-LocalPath: Specifies the local path to which the remote path is mapped.
-Password: Specifies the password to be used to connect to the SMB share.
-Persistent: Indicates that this connection is persistent.
-QuicPort: Specifies the destination port number used by the SMB server for QUIC protocol connections.
-RdmaPort: Specifies the destination port number used by the SMB server for Remote Direct Memory Access (RDMA) protocol connections.
-RemotePath: Specifies the remote path that's accessed from this computer.
-RequireIntegrity: Indicates that SMB signing is required for the mapped drive.
-RequirePrivacy: Indicates that SMB encryption is required for the mapped drive.
-SaveCredentials: Indicates that the credentials provided should be saved for when a mapping to the same SMB server also is created.
-SkipCertificateCheck: Indicates that the client doesn't need to trust the server certificate's issuer in order to connect using SMB over QUIC.
-TcpPort: Specifies the destination port number used by the SMB server for Transmission Control Protocol (TCP) connections.
-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.
-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).
-UseWriteThrough: Indicates that forced unit access (write through) is required and bypasses all OS caches, forcing IO to disk.
-UserName: Specifies the user name to use to connect to the SMB share.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Prerequisites

Windows with the SmbShare module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Create an SMB mapping

New-SmbMapping -LocalPath "X:" -RemotePath "\\Contoso-SO\VMFiles"

This command creates an SMB mapping. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/SmbShare/New-SmbMapping.md

https://learn.microsoft.com/powershell/module/smbshare/new-smbmapping?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC