Windows PowerShell command on Get-command Get-SmbMapping

NAME
    Get-SmbMapping
    
SYNOPSIS
    Retrieves the SMB client directory mappings created for a server.
    
    
SYNTAX
    Get-SmbMapping [[-LocalPath] ] [[-RemotePath] ] [-CimSession ] [-ThrottleLimit 
    ] []
    
    
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
    -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.
        
        Required?                    false
        Position?                    named
        Default value                none
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -LocalPath []
        Specifies the local path used to map the remote path on this computer.
        
        Required?                    false
        Position?                    2
        Default value                none
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -RemotePath []
        Specifies the remote path that is accessed from this computer.
        
        Required?                    false
        Position?                    3
        Default value                none
        Accept pipeline input?       True (ByPropertyName)
        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 PowerShellr 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.
        
        Required?                    false
        Position?                    named
        Default value                none
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216). 
    
INPUTS
        None
    
        
    
    
OUTPUTS
        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.
        This cmdlet returns a MSFT_SmbMapping object that represents the mappings created from the SMB client to SMB 
        shares.
    
    
    Example 1: Get SMB client directory mappings
    
    PS C:\>Get-SmbMapping
    Status                                  Local Path                              Remote Path 
    ------                                  ----------                              ----------- 
    OK                                      X:                                      \\Contoso-SO\VMFiles 
    OK                                      Y:                                      \\Contoso-FS\VMS1
    
    This command retrieves the SMB client directory mappings created for the SMB server.
    
    
    Example 2: Get SMB client directory mapping for a directory
    
    PS C:\>Get-SmbMapping -LocalPath X: | Select-Object - Property *
    Status                : OK 
    LocalPath             : X: 
    RemotePath            : \\Contoso-SO\VMFiles 
    PSComputerName        : 
    CimClass              : ROOT/Microsoft/Windows/SMB:MSFT_SmbMapping 
    CimInstanceProperties : {LocalPath, RemotePath, Status} 
    CimSystemProperties   : Microsoft.Management.Infrastructure.CimSystemProperties
    
    This command retrieves the SMB client directory mapping for the X: directory created for the SMB server.
    
    
    
RELATED LINKS
    New-SmbMapping 
    Remove-SmbMapping