Edit

Share via

Get-SmbGlobalMapping

  • Reference
Module:
SmbShare

Retrieves the properties of a Server Message Block (SMB) global mapping.

Syntax

Get-SmbGlobalMapping
   [[-LocalPath] <String[]>]
   [[-RemotePath] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-SmbGlobalMapping cmdlet retrieves an SMB global mapping on the SMB client to an SMB share. Global mappings allow all users to use the same mapping. Its primary use is for Windows Containers.

Examples

Example 1: Retrieve SMB client directory global mappings

This command retrieves the SMB client directory global mappings created for the SMB server.

Get-SmbGlobalMapping

Status Local Path Remote Path
------ ---------- -----------
OK     G:         \\fs1.contoso.com\public

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

-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

-LocalPath

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

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
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:True
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

Inputs

String[]

Outputs

CimInstance

CimInstance