Get-SmbMapping

Get-SmbMapping

Retrieves the Server Message Block (SMB) client directory mappings created for a server.

Syntax

Parameter Set: Query (cdxml)
Get-SmbMapping [[-LocalPath] <String[]> ] [[-RemotePath] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-SmbMapping cmdlet retrieves the Server Message Block (SMB) client directory mappings created for a server. This can be a mapping from a local drive letter to a remote shared folder, or it can be a mapping without a local path.

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.

-LocalPath<String[]>

Specifies the local path used to map the remote path on this computer.

-RemotePath<String[]>

Specifies the remote path that is accessed from this computer.

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

<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 Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
  The MSFT_SmbMapping object represents the mappings created from the SMB client to SMB shares.

Examples

EXAMPLE 1

This example retrieves the SMB client directory mappings created for the SMB server.

PS C:\> Get-SmbMapping

EXAMPLE 2

This example retrieves the SMB client directory mapping for the X: directory created for the SMB server.

PS C:\> Get-SmbMapping -LocalPath X: | Select-Object - Property *

Related topics

New-SmbMapping

Remove-SmbMapping