Skip to content

Commit 68a636c

Browse files
authored
Merge pull request #3785 from Xelu86/Update_SmbClientConfiguration
Added new parameters for SMBClientConfiguration
2 parents 79b42e7 + a2fa2da commit 68a636c

File tree

3 files changed

+400
-93
lines changed

3 files changed

+400
-93
lines changed

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

+10-14
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: 06/23/2022
5+
ms.date: 02/22/2024
66
online version: https://learn.microsoft.com/powershell/module/smbshare/get-smbclientconfiguration?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-SmbClientConfiguration
@@ -33,7 +33,7 @@ configuration.
3333
Get-SmbClientConfiguration
3434
```
3535

36-
```Output
36+
```output
3737
SkipCertificateCheck : False
3838
ConnectionCountPerRssNetworkInterface : 4
3939
DirectoryCacheEntriesMax : 16
@@ -63,17 +63,12 @@ EncryptionCiphers : AES_128_GCM, AES_128_CCM, AES_256_GCM, A
6363

6464
This command retrieves the SMB client configuration.
6565

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-
7266
## PARAMETERS
7367

7468
### -AsJob
7569

76-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
70+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
71+
complete.
7772

7873
```yaml
7974
Type: SwitchParameter
@@ -90,8 +85,8 @@ Accept wildcard characters: False
9085
### -CimSession
9186
9287
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
88+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
89+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
9590
current session on the local computer.
9691
9792
```yaml
@@ -144,7 +139,7 @@ Accept wildcard characters: False
144139

145140
### -WhatIf
146141

147-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
142+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
148143

149144
```yaml
150145
Type: SwitchParameter
@@ -163,7 +158,7 @@ Accept wildcard characters: False
163158
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
164159
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
165160
-WarningAction, and -WarningVariable. For more information, see
166-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
161+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
167162

168163
## INPUTS
169164

@@ -179,5 +174,6 @@ The **MSFT_SmbClientConfiguration** object represents the configuration of the S
179174

180175
## RELATED LINKS
181176

182-
[Set-SmbClientConfiguration](./Set-SmbClientConfiguration.md)
177+
[Reset-SmbClientConfiguration](Reset-SmbClientConfiguration.md)
183178

179+
[Set-SmbClientConfiguration](Set-SmbClientConfiguration.md)

docset/winserver2025-ps/smbshare/Reset-SmbClientConfiguration.md

+177-31
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
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: 10/20/2022
6-
online version: http://go.microsoft.com/fwlink/?LinkID=241959
5+
ms.date: 02/22/2024
6+
online version: https://learn.microsoft.com/powershell/module/smbshare/reset-smbclientconfiguration?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Reset-SmbClientConfiguration
99
---
@@ -16,34 +16,26 @@ Resets the Server Message Block (SMB) client configuration parameters to their d
1616
## SYNTAX
1717

1818
```
19-
Reset-SmbClientConfiguration [-All] [-CompressibilitySampling]
20-
[-ConnectionCountPerRssNetworkInterface] [-DirectoryCacheEntriesMax] [-DirectoryCacheEntrySizeMax]
21-
[-DirectoryCacheLifetime] [-DisableCompression] [-DormantFileLimit] [-EnableBandwidthThrottling]
22-
[-EnableByteRangeLockingOnReadOnlyFiles] [-EnableLargeMtu] [-EnableLoadBalanceScaleOut]
23-
[-EnableMultiChannel] [-EncryptionCiphers] [-ExtendedSessionTimeout] [-FileInfoCacheEntriesMax]
24-
[-FileInfoCacheLifetime] [-FileNotFoundCacheEntriesMax] [-FileNotFoundCacheLifetime]
25-
[-ForceSMBEncryptionOverQuic] [-KeepConn] [-MaxCmds] [-MaximumConnectionCountPerServer]
26-
[-OplocksDisabled] [-RequestCompression] [-SessionTimeout] [-SkipCertificateCheck]
27-
[-UseOpportunisticLocking] [-WindowSizeThreshold] [-Force] [-CimSession <CimSession[]>]
28-
[-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
Reset-SmbClientConfiguration [-All] [-AuditInsecureGuestLogon]
20+
[-AuditServerDoesNotSupportEncryption] [-AuditServerDoesNotSupportSigning] [-BlockNTLM]
21+
[-CompressibilitySampling] [-ConnectionCountPerRssNetworkInterface] [-DirectoryCacheEntriesMax]
22+
[-DirectoryCacheEntrySizeMax] [-DirectoryCacheLifetime] [-DisableCompression] [-DormantFileLimit]
23+
[-EnableBandwidthThrottling] [-EnableByteRangeLockingOnReadOnlyFiles] [-EnableLargeMtu]
24+
[-EnableLoadBalanceScaleOut] [-EnableMailslots] [-EnableMultiChannel] [-EncryptionCiphers]
25+
[-ExtendedSessionTimeout] [-FileInfoCacheEntriesMax] [-FileInfoCacheLifetime]
26+
[-FileNotFoundCacheEntriesMax] [-FileNotFoundCacheLifetime] [-ForceSMBEncryptionOverQuic]
27+
[-InvalidAuthenticationCacheLifetime] [-KeepConn] [-MaxCmds] [-MaximumConnectionCountPerServer]
28+
[-OplocksDisabled] [-RequestCompression] [-RequireEncryption] [-SessionTimeout]
29+
[-SkipCertificateCheck] [-Smb2DialectMax] [-Smb2DialectMin] [-UseOpportunisticLocking]
30+
[-WindowSizeThreshold] [-Force] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
31+
[-WhatIf] [-Confirm] [<CommonParameters>]
2932
```
3033

3134
## DESCRIPTION
3235

3336
The `Reset-SmbClientConfiguration` cmdlet resets SMB client configuration parameters to their
3437
default values.
3538

36-
> [!NOTE]
37-
> - This cmdlet is available beginning with 2022-06 Cumulative Update for Microsoft server operating
38-
> system version 21H2 for x64-based Systems
39-
> ([KB5014665](https://support.microsoft.com/help/5014665)), and Cumulative Update for Windows 11,
40-
> version 22H2 ([KB5014668](https://support.microsoft.com/help/5014668)).
41-
>
42-
> - The **CompressibilitySampling** and **RequestCompression** parameters are available beginning
43-
> with 2022-08 Cumulative Update for Microsoft server operating system version 21H2 for x64-based
44-
> Systems ([KB5016693](https://support.microsoft.com/help/5016693)), and Cumulative Update for
45-
> Windows 11, version 22H2 ([KB5016691](https://support.microsoft.com/help/5016691)).
46-
4739
## EXAMPLES
4840

4941
### Example 1: Reset the large MTU behavior
@@ -89,11 +81,75 @@ Accept pipeline input: False
8981
Accept wildcard characters: False
9082
```
9183
84+
### -AuditInsecureGuestLogon
85+
86+
Resets whether to audit insecure guest logon attempts to its default value.
87+
88+
```yaml
89+
Type: SwitchParameter
90+
Parameter Sets: (All)
91+
Aliases:
92+
93+
Required: False
94+
Position: Named
95+
Default value: None
96+
Accept pipeline input: False
97+
Accept wildcard characters: False
98+
```
99+
100+
### -AuditServerDoesNotSupportEncryption
101+
102+
Resets whether to audit when a server doesn't support encryption to its default value.
103+
104+
```yaml
105+
Type: SwitchParameter
106+
Parameter Sets: (All)
107+
Aliases:
108+
109+
Required: False
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
116+
### -AuditServerDoesNotSupportSigning
117+
118+
Resets whether to audit when a server doesn't support message signing to its default value.
119+
120+
```yaml
121+
Type: SwitchParameter
122+
Parameter Sets: (All)
123+
Aliases:
124+
125+
Required: False
126+
Position: Named
127+
Default value: None
128+
Accept pipeline input: False
129+
Accept wildcard characters: False
130+
```
131+
132+
### -BlockNTLM
133+
134+
Resets whether to block NT LAN Manager (NTLM) authentication to its default value.
135+
136+
```yaml
137+
Type: SwitchParameter
138+
Parameter Sets: (All)
139+
Aliases:
140+
141+
Required: False
142+
Position: Named
143+
Default value: None
144+
Accept pipeline input: False
145+
Accept wildcard characters: False
146+
```
147+
92148
### -CimSession
93149
94150
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
95-
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
96-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
151+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
152+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
97153
current session on the local computer.
98154
99155
```yaml
@@ -284,6 +340,28 @@ Accept pipeline input: False
284340
Accept wildcard characters: False
285341
```
286342
343+
### -EnableMailslots
344+
345+
Resets mailslots to its default value.
346+
347+
Beginning with Windows Server 2025 and Windows 11 Insider Preview Build 25314, remote mailslots are
348+
disabled by default.
349+
350+
To learn more about remote mailslot deprecation, see [Features removed or no longer developed
351+
starting with Windows Server 2025](/windows-server/get-started/removed-deprecated-features-windows-server-2025).
352+
353+
```yaml
354+
Type: SwitchParameter
355+
Parameter Sets: (All)
356+
Aliases:
357+
358+
Required: False
359+
Position: Named
360+
Default value: None
361+
Accept pipeline input: False
362+
Accept wildcard characters: False
363+
```
364+
287365
### -EnableMultiChannel
288366
289367
Resets the enable multi-channel value to its default value.
@@ -428,6 +506,23 @@ Accept pipeline input: False
428506
Accept wildcard characters: False
429507
```
430508
509+
### -InvalidAuthenticationCacheLifetime
510+
511+
Resets the length of time (in seconds) that an invalid authentication cache entry should be kept
512+
before being removed to its default value.
513+
514+
```yaml
515+
Type: SwitchParameter
516+
Parameter Sets: (All)
517+
Aliases:
518+
519+
Required: False
520+
Position: Named
521+
Default value: None
522+
Accept pipeline input: False
523+
Accept wildcard characters: False
524+
```
525+
431526
### -KeepConn
432527
433528
Reset the time, in seconds, before the SMB client session is automatically disconnected to its
@@ -510,6 +605,24 @@ Accept pipeline input: False
510605
Accept wildcard characters: False
511606
```
512607
608+
### -RequireEncryption
609+
610+
Specifies whether or not encryption should be required for all SMB traffic. When this parameter is
611+
set to `$true`, all SMB traffic must be encrypted. If it is set to `$false` (the default),
612+
encryption is not required, but may still be negotiated if both the client and server support it.
613+
614+
```yaml
615+
Type: SwitchParameter
616+
Parameter Sets: (All)
617+
Aliases:
618+
619+
Required: False
620+
Position: Named
621+
Default value: None
622+
Accept pipeline input: False
623+
Accept wildcard characters: False
624+
```
625+
513626
### -SessionTimeout
514627

515628
Resets the session time-out value to its default value.
@@ -542,6 +655,40 @@ Accept pipeline input: False
542655
Accept wildcard characters: False
543656
```
544657

658+
### -Smb2DialectMax
659+
660+
Resets the maximum version of the SMB protocol to be used back to its default value.
661+
662+
```yaml
663+
Type: SwitchParameter
664+
Parameter Sets: (All)
665+
Aliases:
666+
Accepted values: None, SMB202, SMB210, SMB300, SMB302, SMB311
667+
668+
Required: False
669+
Position: Named
670+
Default value: None
671+
Accept pipeline input: False
672+
Accept wildcard characters: False
673+
```
674+
675+
### -Smb2DialectMin
676+
677+
Resets the minimum version of the SMB protocol to be used back to its default value.
678+
679+
```yaml
680+
Type: SwitchParameter
681+
Parameter Sets: (All)
682+
Aliases:
683+
Accepted values: None, SMB202, SMB210, SMB300, SMB302, SMB311
684+
685+
Required: False
686+
Position: Named
687+
Default value: None
688+
Accept pipeline input: False
689+
Accept wildcard characters: False
690+
```
691+
545692
### -ThrottleLimit
546693

547694
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
@@ -612,8 +759,7 @@ Accept wildcard characters: False
612759

613760
### -WhatIf
614761

615-
Shows what would happen if the cmdlet runs.
616-
The cmdlet isn't run.
762+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
617763

618764
```yaml
619765
Type: SwitchParameter
@@ -622,7 +768,7 @@ Aliases: wi
622768
623769
Required: False
624770
Position: Named
625-
Default value: None
771+
Default value: False
626772
Accept pipeline input: False
627773
Accept wildcard characters: False
628774
```
@@ -632,7 +778,7 @@ Accept wildcard characters: False
632778
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
633779
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
634780
-WarningAction, and -WarningVariable. For more information, see
635-
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
781+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
636782

637783
## INPUTS
638784

@@ -646,6 +792,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
646792

647793
## RELATED LINKS
648794

649-
[Get-SmbClientConfiguration](./Get-SmbClientConfiguration.md)
795+
[Get-SmbClientConfiguration](Get-SmbClientConfiguration.md)
650796

651-
[Set-SmbClientConfiguration](./Set-SmbClientConfiguration.md)
797+
[Set-SmbClientConfiguration](Set-SmbClientConfiguration.md)

0 commit comments

Comments
 (0)