New-SmbMapping

New-SmbMapping

Creates a new Server Message Block (SMB) mapping.

Syntax

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

Detailed Description

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

Parameters

-AsJob

-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

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

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

-UserName<String>

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• None

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMapping

  The MSFT_SmbMapping object represents the newly created SMB mapping.

Examples

EXAMPLE 1

This example creates a new SMB mapping.

PS C:\> New-SmbMapping -LocalPath X: -RemotePath \\Contoso-SO\VMFiles

EXAMPLE 2

This example creates a new SMB mapping.

PS C:\> New-SmbMapping Y: -RemotePath \\Contoso-FS\VMS1

Related topics

Get-SmbMapping

Remove-SmbMapping