Skip to content

Commit bcf0083

Browse files
authored
Merge pull request MicrosoftDocs#2998 from robinharwood/roharwoo_smbshare_update
Servicing updates for the SmbShare module
2 parents ac6eef7 + a361d81 commit bcf0083

File tree

7 files changed

+1873
-192
lines changed

7 files changed

+1873
-192
lines changed

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

Lines changed: 46 additions & 20 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,54 +16,69 @@ 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
31+
32+
```powershell
33+
Get-SmbClientConfiguration
2934
```
30-
PS C:\>Get-SmbClientConfiguration
35+
36+
```Output
37+
SkipCertificateCheck : False
3138
ConnectionCountPerRssNetworkInterface : 4
3239
DirectoryCacheEntriesMax : 16
33-
DirectoryCacheEntrySizeMax : 65536
40+
DirectoryCacheEntrySizeMax : 0
3441
DirectoryCacheLifetime : 10
42+
DormantFileLimit : 1023
3543
EnableBandwidthThrottling : True
3644
EnableByteRangeLockingOnReadOnlyFiles : True
3745
EnableLargeMtu : True
46+
EnableLoadBalanceScaleOut : True
3847
EnableMultiChannel : True
39-
DormantFileLimit : 1023
40-
EnableSecuritySignature : True
4148
ExtendedSessionTimeout : 1000
4249
FileInfoCacheEntriesMax : 64
4350
FileInfoCacheLifetime : 10
4451
FileNotFoundCacheEntriesMax : 128
4552
FileNotFoundCacheLifetime : 5
53+
ForceSMBEncryptionOverQuic : False
4654
KeepConn : 600
4755
MaxCmds : 50
4856
MaximumConnectionCountPerServer : 32
4957
OplocksDisabled : False
50-
RequireSecuritySignature : False
5158
SessionTimeout : 60
5259
UseOpportunisticLocking : True
5360
WindowSizeThreshold : 1
61+
EncryptionCiphers : AES_128_GCM, AES_128_CCM, AES_256_GCM, AES_256_CCM
5462
```
5563

5664
This command retrieves the SMB client configuration.
5765

66+
> [!NOTE]
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)).
71+
5872
## PARAMETERS
5973

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

6378
```yaml
6479
Type: SwitchParameter
6580
Parameter Sets: (All)
66-
Aliases:
81+
Aliases:
6782

6883
Required: False
6984
Position: Named
@@ -73,9 +88,11 @@ Accept wildcard characters: False
7388
```
7489
7590
### -CimSession
76-
Runs the cmdlet in a remote session or on a remote computer.
77-
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.
78-
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.
7996
8097
```yaml
8198
Type: CimSession[]
@@ -90,14 +107,17 @@ Accept wildcard characters: False
90107
```
91108
92109
### -ThrottleLimit
93-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
94-
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.
95-
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.
96116

97117
```yaml
98118
Type: Int32
99119
Parameter Sets: (All)
100-
Aliases:
120+
Aliases:
101121
102122
Required: False
103123
Position: Named
@@ -107,6 +127,7 @@ Accept wildcard characters: False
107127
```
108128

109129
### -Confirm
130+
110131
Prompts you for confirmation before running the cmdlet.
111132

112133
```yaml
@@ -122,8 +143,8 @@ Accept wildcard characters: False
122143
```
123144

124145
### -WhatIf
125-
Shows what would happen if the cmdlet runs.
126-
The cmdlet is not run.
146+
147+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
127148

128149
```yaml
129150
Type: SwitchParameter
@@ -138,7 +159,11 @@ Accept wildcard characters: False
138159
```
139160

140161
### CommonParameters
141-
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).
142167

143168
## INPUTS
144169

@@ -147,6 +172,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
147172
## OUTPUTS
148173

149174
### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbClientConfiguration
175+
150176
The **MSFT_SmbClientConfiguration** object represents the configuration of the SMB client.
151177

152178
## NOTES

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

Lines changed: 86 additions & 56 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,72 +16,90 @@ 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
30+
31+
```powershell
32+
Get-SmbServerConfiguration
2933
```
30-
PS C:\>Get-SmbServerConfiguration
31-
AnnounceServer : False
32-
AsynchronousCredits : 64
33-
AutoShareServer : True
34-
AutoShareWorkstation : True
35-
CachedOpenLimit : 5
36-
AnnounceComment :
37-
EnableDownlevelTimewarp : False
38-
EnableLeasing : True
39-
EnableMultiChannel : True
40-
EnableStrictNameChecking : True
41-
AutoDisconnectTimeout : 0
42-
DurableHandleV2TimeoutInSeconds : 30
43-
EnableAuthenticateUserSharing : False
44-
EnableForcedLogoff : True
45-
EnableOplocks : True
46-
EnableSecuritySignature : False
47-
ServerHidden : True
48-
IrpStackSize : 15
49-
KeepAliveTime : 2
50-
MaxChannelPerSession : 32
51-
MaxMpxCount : 50
52-
MaxSessionPerConnection : 16384
53-
MaxThreadsPerQueue : 20
54-
MaxWorkItems : 1
55-
NullSessionPipes :
56-
NullSessionShares :
57-
OplockBreakWait : 35
58-
PendingClientTimeoutInSeconds : 120
59-
RequireSecuritySignature : False
60-
EnableSMB1Protocol : True
61-
EnableSMB2Protocol : True
62-
Smb2CreditsMax : 2048
63-
Smb2CreditsMin : 128
64-
SmbServerNameHardeningLevel : 0
65-
TreatHostAsStableStorage : False
66-
ValidateAliasNotCircular : True
67-
ValidateShareScope : True
68-
ValidateShareScopeNotAliased : True
69-
ValidateTargetName : True
70-
EncryptData : False
71-
RejectUnencryptedAccess : True
34+
35+
```Output
36+
AnnounceComment :
37+
AnnounceServer : False
38+
AsynchronousCredits : 512
39+
AuditSmb1Access : False
40+
AutoDisconnectTimeout : 15
41+
AutoShareServer : True
42+
AutoShareWorkstation : True
43+
CachedOpenLimit : 10
44+
DisableSmbEncryptionOnSecureConnection : True
45+
DurableHandleV2TimeoutInSeconds : 180
46+
EnableAuthenticateUserSharing : False
47+
EnableDownlevelTimewarp : False
48+
EnableForcedLogoff : True
49+
EnableLeasing : True
50+
EnableMultiChannel : True
51+
EnableOplocks : True
52+
EnableSecuritySignature : False
53+
EnableSMB1Protocol : False
54+
EnableSMB2Protocol : True
55+
EnableStrictNameChecking : True
56+
EncryptData : False
57+
IrpStackSize : 15
58+
KeepAliveTime : 2
59+
MaxChannelPerSession : 32
60+
MaxMpxCount : 50
61+
MaxSessionPerConnection : 16384
62+
MaxThreadsPerQueue : 20
63+
MaxWorkItems : 1
64+
NullSessionPipes :
65+
NullSessionShares :
66+
OplockBreakWait : 35
67+
PendingClientTimeoutInSeconds : 120
68+
RejectUnencryptedAccess : True
69+
RequireSecuritySignature : False
70+
ServerHidden : True
71+
Smb2CreditsMax : 8192
72+
Smb2CreditsMin : 512
73+
SmbServerNameHardeningLevel : 0
74+
TreatHostAsStableStorage : False
75+
ValidateAliasNotCircular : True
76+
ValidateShareScope : True
77+
ValidateShareScopeNotAliased : True
78+
ValidateTargetName : True
79+
RestrictNamedpipeAccessViaQuic : True
80+
EnableSMBQUIC : True
81+
EncryptionCiphers : AES_128_GCM, AES_128_CCM, AES_256_GCM, AES_256_CCM
7282
```
7383

7484
This command retrieves the SMB server configuration.
7585

86+
> [!NOTE]
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)).
91+
7692
## PARAMETERS
7793

7894
### -AsJob
79-
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.
8098

8199
```yaml
82100
Type: SwitchParameter
83101
Parameter Sets: (All)
84-
Aliases:
102+
Aliases:
85103

86104
Required: False
87105
Position: Named
@@ -91,9 +109,11 @@ Accept wildcard characters: False
91109
```
92110
93111
### -CimSession
94-
Runs the cmdlet in a remote session or on a remote computer.
95-
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.
96-
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.
97117
98118
```yaml
99119
Type: CimSession[]
@@ -108,14 +128,17 @@ Accept wildcard characters: False
108128
```
109129
110130
### -ThrottleLimit
111-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
112-
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.
113-
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.
114137

115138
```yaml
116139
Type: Int32
117140
Parameter Sets: (All)
118-
Aliases:
141+
Aliases:
119142
120143
Required: False
121144
Position: Named
@@ -125,6 +148,7 @@ Accept wildcard characters: False
125148
```
126149

127150
### -Confirm
151+
128152
Prompts you for confirmation before running the cmdlet.
129153

130154
```yaml
@@ -140,6 +164,7 @@ Accept wildcard characters: False
140164
```
141165

142166
### -WhatIf
167+
143168
Shows what would happen if the cmdlet runs.
144169
The cmdlet is not run.
145170

@@ -156,7 +181,11 @@ Accept wildcard characters: False
156181
```
157182

158183
### CommonParameters
159-
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).
160189

161190
## INPUTS
162191

@@ -165,6 +194,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
165194
## OUTPUTS
166195

167196
### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbServerConfiguration
197+
168198
The **MSFT_SmbServerConfiguration** object represents the configuration of the SMB server.
169199

170200
## NOTES

0 commit comments

Comments
 (0)