Skip to content

Commit f4019df

Browse files
committed
Editorial updates
1 parent 52eec51 commit f4019df

File tree

7 files changed

+468
-180
lines changed

7 files changed

+468
-180
lines changed

docset/winserver2022-ps/smbshare/Get-SmbClientConfiguration.md

Lines changed: 36 additions & 17 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: SmbClientConfiguration.cdxml-help.xml
44
Module Name: SmbShare
5-
ms.date: 12/20/2016
5+
ms.date: 06/23/2022
66
online version: https://docs.microsoft.com/powershell/module/smbshare/get-smbclientconfiguration?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-SmbClientConfiguration
@@ -16,19 +16,23 @@ Retrieves the SMB client configuration.
1616
## SYNTAX
1717

1818
```
19-
Get-SmbClientConfiguration [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm]
20-
[<CommonParameters>]
19+
Get-SmbClientConfiguration [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf]
20+
[-Confirm] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Get-SmbClientConfiguration** cmdlet retrieves the Server Message Block (SMB) client configuration.
24+
25+
The `Get-SmbClientConfiguration` cmdlet retrieves the Server Message Block (SMB) client
26+
configuration.
2527

2628
## EXAMPLES
2729

2830
### Example 1: Get the client configuration
29-
```PowerShell
31+
32+
```powershell
3033
Get-SmbClientConfiguration
3134
```
35+
3236
```Output
3337
SkipCertificateCheck : False
3438
ConnectionCountPerRssNetworkInterface : 4
@@ -60,17 +64,21 @@ EncryptionCiphers : AES_128_GCM, AES_128_CCM, AES_256_GCM, A
6064
This command retrieves the SMB client configuration.
6165

6266
> [!NOTE]
63-
> The EncryptionCiphers parameter is available beginning with 2022-06 Cumulative Update for Microsoft server operating system version 21H2 for x64-based Systems ([KB5014665](https://support.microsoft.com/help/5014665)), and Cumulative Update for Windows 11, version 22H2 ([KB5014668](https://support.microsoft.com/help/5014668)).
67+
> The **EncryptionCiphers** parameter is available beginning with 2022-06 Cumulative Update for
68+
> Microsoft server operating system version 21H2 for x64-based Systems
69+
> ([KB5014665](https://support.microsoft.com/help/5014665)), and Cumulative Update for Windows 11,
70+
> version 22H2 ([KB5014668](https://support.microsoft.com/help/5014668)).
6471
6572
## PARAMETERS
6673

6774
### -AsJob
75+
6876
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
6977

7078
```yaml
7179
Type: SwitchParameter
7280
Parameter Sets: (All)
73-
Aliases:
81+
Aliases:
7482

7583
Required: False
7684
Position: Named
@@ -80,9 +88,11 @@ Accept wildcard characters: False
8088
```
8189
8290
### -CimSession
83-
Runs the cmdlet in a remote session or on a remote computer.
84-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
85-
The default is the current session on the local computer.
91+
92+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
93+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
94+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
95+
current session on the local computer.
8696
8797
```yaml
8898
Type: CimSession[]
@@ -97,14 +107,17 @@ Accept wildcard characters: False
97107
```
98108
99109
### -ThrottleLimit
100-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
101-
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.
102-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
110+
111+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
112+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
113+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
114+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
115+
computer.
103116

104117
```yaml
105118
Type: Int32
106119
Parameter Sets: (All)
107-
Aliases:
120+
Aliases:
108121
109122
Required: False
110123
Position: Named
@@ -114,6 +127,7 @@ Accept wildcard characters: False
114127
```
115128

116129
### -Confirm
130+
117131
Prompts you for confirmation before running the cmdlet.
118132

119133
```yaml
@@ -129,8 +143,8 @@ Accept wildcard characters: False
129143
```
130144

131145
### -WhatIf
132-
Shows what would happen if the cmdlet runs.
133-
The cmdlet is not run.
146+
147+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
134148

135149
```yaml
136150
Type: SwitchParameter
@@ -145,7 +159,11 @@ Accept wildcard characters: False
145159
```
146160

147161
### CommonParameters
148-
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).
162+
163+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
164+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
165+
-WarningAction, and -WarningVariable. For more information, see
166+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
149167

150168
## INPUTS
151169

@@ -154,6 +172,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
154172
## OUTPUTS
155173

156174
### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbClientConfiguration
175+
157176
The **MSFT_SmbClientConfiguration** object represents the configuration of the SMB client.
158177

159178
## NOTES

docset/winserver2022-ps/smbshare/Get-SmbServerConfiguration.md

Lines changed: 36 additions & 16 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: SmbServerConfiguration.cdxml-help.xml
44
Module Name: SmbShare
5-
ms.date: 12/20/2016
5+
ms.date: 06/23/2022
66
online version: https://docs.microsoft.com/powershell/module/smbshare/get-smbserverconfiguration?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-SmbServerConfiguration
@@ -16,19 +16,22 @@ Retrieves the SMB server configuration.
1616
## SYNTAX
1717

1818
```
19-
Get-SmbServerConfiguration [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm]
20-
[<CommonParameters>]
19+
Get-SmbServerConfiguration [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf]
20+
[-Confirm] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Get-SmbServerConfiguration** cmdlet retrieves the Server Message Block (SMB) server configuration.
24+
25+
The `Get-SmbServerConfiguration` cmdlet retrieves the Server Message Block (SMB) server configuration.
2526

2627
## EXAMPLES
2728

2829
### Example 1: Get SMB server configuration
29-
```PowerShell
30+
31+
```powershell
3032
Get-SmbServerConfiguration
3133
```
34+
3235
```Output
3336
AnnounceComment :
3437
AnnounceServer : False
@@ -81,17 +84,22 @@ EncryptionCiphers : AES_128_GCM, AES_128_CCM, AES_256_GCM,
8184
This command retrieves the SMB server configuration.
8285

8386
> [!NOTE]
84-
> The EncryptionCiphers parameter is available beginning with 2022-06 Cumulative Update for Microsoft server operating system version 21H2 for x64-based Systems ([KB5014665](https://support.microsoft.com/help/5014665)), and Cumulative Update for Windows 11, version 22H2 ([KB5014668](https://support.microsoft.com/help/5014668)).
87+
> The **EncryptionCiphers** parameter is available beginning with 2022-06 Cumulative Update for
88+
> Microsoft server operating system version 21H2 for x64-based Systems
89+
> ([KB5014665](https://support.microsoft.com/help/5014665)), and Cumulative Update for Windows 11,
90+
> version 22H2 ([KB5014668](https://support.microsoft.com/help/5014668)).
8591
8692
## PARAMETERS
8793

8894
### -AsJob
89-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
95+
96+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
97+
complete.
9098

9199
```yaml
92100
Type: SwitchParameter
93101
Parameter Sets: (All)
94-
Aliases:
102+
Aliases:
95103

96104
Required: False
97105
Position: Named
@@ -101,9 +109,11 @@ Accept wildcard characters: False
101109
```
102110
103111
### -CimSession
104-
Runs the cmdlet in a remote session or on a remote computer.
105-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
106-
The default is the current session on the local computer.
112+
113+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
114+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
115+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
116+
current session on the local computer.
107117
108118
```yaml
109119
Type: CimSession[]
@@ -118,14 +128,17 @@ Accept wildcard characters: False
118128
```
119129
120130
### -ThrottleLimit
121-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
122-
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.
123-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
131+
132+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
133+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
134+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
135+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
136+
computer.
124137

125138
```yaml
126139
Type: Int32
127140
Parameter Sets: (All)
128-
Aliases:
141+
Aliases:
129142
130143
Required: False
131144
Position: Named
@@ -135,6 +148,7 @@ Accept wildcard characters: False
135148
```
136149

137150
### -Confirm
151+
138152
Prompts you for confirmation before running the cmdlet.
139153

140154
```yaml
@@ -150,6 +164,7 @@ Accept wildcard characters: False
150164
```
151165

152166
### -WhatIf
167+
153168
Shows what would happen if the cmdlet runs.
154169
The cmdlet is not run.
155170

@@ -166,7 +181,11 @@ Accept wildcard characters: False
166181
```
167182

168183
### CommonParameters
169-
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).
184+
185+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
186+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
187+
-WarningAction, and -WarningVariable. For more information, see
188+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
170189

171190
## INPUTS
172191

@@ -175,6 +194,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
175194
## OUTPUTS
176195

177196
### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbServerConfiguration
197+
178198
The **MSFT_SmbServerConfiguration** object represents the configuration of the SMB server.
179199

180200
## NOTES

0 commit comments

Comments
 (0)