Skip to content

Commit c3a920f

Browse files
committed
Updated cmdlet & parameters
1 parent da96ad6 commit c3a920f

File tree

3 files changed

+274
-64
lines changed

3 files changed

+274
-64
lines changed

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

Lines changed: 31 additions & 10 deletions
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,6 +45,7 @@ OK G: \\fs1.contoso.com\public
4245
## PARAMETERS
4346

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

4751
```yaml
@@ -57,7 +61,10 @@ Accept wildcard characters: False
5761
```
5862
5963
### -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.
64+
65+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
66+
object, such as the output of a `New-CimSession` or `Get-CimSession` cmdlet. The default is the
67+
current session on the local computer.
6168

6269
```yaml
6370
Type: CimSession[]
@@ -72,6 +79,7 @@ Accept wildcard characters: False
7279
```
7380

7481
### -LocalPath
82+
7583
Specifies the local path to which the remote path is mapped.
7684

7785
```yaml
@@ -87,7 +95,8 @@ Accept wildcard characters: False
8795
```
8896

8997
### -RemotePath
90-
Specifies the remote path that is accessed from this computer.
98+
99+
Specifies the remote path that's accessed from this computer.
91100

92101
```yaml
93102
Type: String[]
@@ -102,7 +111,11 @@ Accept wildcard characters: False
102111
```
103112

104113
### -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.
114+
115+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
116+
this parameter is omitted or a value of 0 is entered, then Windows PowerShell calculates an optimum
117+
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
118+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
106119

107120
```yaml
108121
Type: Int32
@@ -117,7 +130,11 @@ Accept wildcard characters: False
117130
```
118131

119132
### 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).
133+
134+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
135+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
136+
-WarningAction, and -WarningVariable. For more information, see
137+
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
121138

122139
## INPUTS
123140

@@ -132,3 +149,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar
132149
## NOTES
133150

134151
## RELATED LINKS
152+
153+
[New-SmbGlobalMapping.md](./New-SmbGlobalMapping.md)
154+
155+
[Remove-SmbGlobalMapping.md](./Remove-SmbGlobalMapping.md)

0 commit comments

Comments
 (0)