Skip to content

Commit 5976cfa

Browse files
authored
Merge pull request #3786 from Xelu86/Update_SmbGlobalMapping
Added new parameters for SmbGlobalMapping
2 parents 0b2b990 + 0e6c795 commit 5976cfa

File tree

3 files changed

+264
-48
lines changed

3 files changed

+264
-48
lines changed

docset/winserver2025-ps/smbshare/Get-SmbGlobalMapping.md

+35-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: SmbGlobalMapping.cdxml-help.xml
44
Module Name: SmbShare
5-
ms.date: 08/31/2021
5+
ms.date: 02/22/2024
66
online version: https://learn.microsoft.com/powershell/module/smbshare/get-smbglobalmapping?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-SmbGlobalMapping
@@ -16,21 +16,24 @@ Retrieves the properties of a Server Message Block (SMB) global mapping.
1616
## SYNTAX
1717

1818
```
19-
Get-SmbGlobalMapping [[-LocalPath] <String[]>] [[-RemotePath] <String[]>] [-CimSession <CimSession[]>]
20-
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
19+
Get-SmbGlobalMapping [[-LocalPath] <String[]>] [[-RemotePath] <String[]>]
20+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
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.
24+
25+
The `Get-SmbGlobalMapping` cmdlet retrieves an SMB global mapping on the SMB client to an SMB
26+
share. Global mappings allow all users to use the same mapping. Its primary use is for Windows
27+
Containers.
2528

2629
## EXAMPLES
2730

28-
### Example 1 - Retrieve SMB client directory global mappings
31+
### Example 1: Retrieve SMB client directory global mappings
2932

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

3235
```powershell
33-
PS C:\> Get-SmbGlobalMapping
36+
Get-SmbGlobalMapping
3437
```
3538

3639
```output
@@ -42,7 +45,9 @@ OK G: \\fs1.contoso.com\public
4245
## PARAMETERS
4346

4447
### -AsJob
45-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
48+
49+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
50+
complete.
4651

4752
```yaml
4853
Type: SwitchParameter
@@ -57,7 +62,11 @@ Accept wildcard characters: False
5762
```
5863
5964
### -CimSession
60-
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.
65+
66+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
67+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
68+
[Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
69+
current session on the local computer.
6170
6271
```yaml
6372
Type: CimSession[]
@@ -72,6 +81,7 @@ Accept wildcard characters: False
7281
```
7382
7483
### -LocalPath
84+
7585
Specifies the local path to which the remote path is mapped.
7686
7787
```yaml
@@ -87,7 +97,8 @@ Accept wildcard characters: False
8797
```
8898
8999
### -RemotePath
90-
Specifies the remote path that is accessed from this computer.
100+
101+
Specifies the remote path that's accessed from this computer.
91102
92103
```yaml
93104
Type: String[]
@@ -102,7 +113,12 @@ Accept wildcard characters: False
102113
```
103114
104115
### -ThrottleLimit
105-
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.
116+
117+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
118+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
119+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
120+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
121+
computer.
106122

107123
```yaml
108124
Type: Int32
@@ -117,7 +133,11 @@ Accept wildcard characters: False
117133
```
118134

119135
### CommonParameters
120-
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, -`OutVariable`, -`OutBuffer`, -`PipelineVariable`, -`Verbose`, -`WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
136+
137+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
138+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
139+
-WarningAction, and -WarningVariable. For more information, see
140+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
121141

122142
## INPUTS
123143

@@ -132,3 +152,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar
132152
## NOTES
133153

134154
## RELATED LINKS
155+
156+
[New-SmbGlobalMapping](New-SmbGlobalMapping.md)
157+
158+
[Remove-SmbGlobalMapping](Remove-SmbGlobalMapping.md)

0 commit comments

Comments
 (0)