Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

New-SmbMapping

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

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

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HomeFolder

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LocalPath<String>

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


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Password<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Persistent<Boolean>

Indicates that this connection is persistent.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemotePath<String>

Specifies the remote path that is accessed from this computer.


Aliases

none

Required?

false

Position?

3

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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
Status                                  Local Path                              Remote Path 
------                                  ----------                              ----------- 
OK                                      X:                                      \\Contoso-SO\VMFiles 

EXAMPLE 2

This example creates a new SMB mapping.


PS C:\> New-SmbMapping Y: -RemotePath \\Contoso-FS\VMS1
Status                                  Local Path                              Remote Path
------                                  ----------                              -----------
OK                                      Y:                                      \\Contoso-FS\VMS1

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.