| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
SmbClientConfiguration.cdxml-help.xml |
SmbShare |
02/22/2024 |
2.0.0 |
Set-SmbClientConfiguration |
Sets the SMB client configuration.
Set-SmbClientConfiguration [-AuditInsecureGuestLogon <Boolean>]
[-AuditServerDoesNotSupportEncryption <Boolean>] [-AuditServerDoesNotSupportSigning <Boolean>]
[-BlockNTLM <Boolean>] [-CompressibilitySamplingSize <UInt64>] [-CompressibleThreshold <UInt64>]
[-ConnectionCountPerRssNetworkInterface <UInt32>] [-DirectoryCacheEntriesMax <UInt32>]
[-DirectoryCacheEntrySizeMax <UInt32>] [-DirectoryCacheLifetime <UInt32>]
[-DisableCompression <Boolean>] [-DormantFileLimit <UInt32>]
[-EnableBandwidthThrottling <Boolean>] [-EnableByteRangeLockingOnReadOnlyFiles <Boolean>]
[-EnableCompressibilitySampling <Boolean>] [-EnableInsecureGuestLogons <Boolean>]
[-EnableLargeMtu <Boolean>] [-EnableLoadBalanceScaleOut <Boolean>] [-EnableMailslots <Boolean>]
[-EnableMultiChannel <Boolean>] [-EnableSecuritySignature <Boolean>] [-EnableSMBQUIC <Boolean>]
[-EncryptionCiphers <String>] [-ExtendedSessionTimeout <UInt32>]
[-FileInfoCacheEntriesMax <UInt32>] [-FileInfoCacheLifetime <UInt32>]
[-FileNotFoundCacheEntriesMax <UInt32>] [-FileNotFoundCacheLifetime <UInt32>]
[-ForceSMBEncryptionOverQuic <Boolean>] [-InvalidAuthenticationCacheLifetime <UInt32>]
[-KeepConn <UInt32>] [-MaxCmds <UInt32>] [-MaximumConnectionCountPerServer <UInt32>]
[-OplocksDisabled <Boolean>] [-RequestCompression <Boolean>] [-RequireEncryption <Boolean>]
[-RequireSecuritySignature <Boolean>] [-SessionTimeout <UInt32>] [-SkipCertificateCheck <Boolean>]
[-Smb2DialectMax <Smb2DialectMax>] [-Smb2DialectMin <Smb2DialectMin>]
[-UseOpportunisticLocking <Boolean>] [-WindowSizeThreshold <UInt32>] [-Force]
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm]
[<CommonParameters>]
The Set-SmbClientConfiguration cmdlet sets the Server Message Block (SMB) client configuration.
Note
The EnableSMBQUIC parameter is available starting with Windows 11 Insider Preview build 26090 and later.
Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 8 -Confirm:$falseThis command sets the SMB client configuration without user confirmation.
Set-SmbClientConfiguration -EncryptionCiphers "AES_128_GCM, AES_256_GCM" -Confirm:$falseThis command specifies the encryption ciphers used by the SMB client, and the preferred order without user confirmation.
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether to audit insecure guest logon attempts. Audit events are written to the Windows event log.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether to audit when a server doesn't support encryption. If this parameter is specified, events will be logged when a server doesn't support encryption.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether to audit when a server doesn't support message signing. If this parameter is specified, events will be logged when a server doesn't support message signing.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether to block NT LAN Manager (NTLM) authentication. If this parameter is set to
$true, NTLM authentication will be blocked forcing the connection to use another negotiated
authentication method, such as Kerberos. If set to $false (default), NTLM authentication will be
allowed.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns 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.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the size in bytes to sample in a file to look for compressible data. Although the
parameter type is UInt64, the sampling size can be specified up to a maximum of
9,007,199,254,740,992 (9 PiB).
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the threshold in bytes in which to attempt to find compressible data. Although the
parameter type is UInt64, the threshold can be specified up to a maximum of
9,007,199,254,740,992 (9 PiB).
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the SMB connection count per each RSS network interface.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum cache entries that can be in the directory cache.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum size of directory cache entry.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the directory cache lifetime.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies that the SMB client ignores all requests for compression from applications or SMB servers.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the dormant file limit.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that bandwidth throttling is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that byte range locking on read-only files is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseControls the sampling behavior. SMB by default always attempts to compress the entire file when a
client or server requests it. With EnableCompressibilitySampling set to $true, SMB uses the
compression sampling algorithm where it attempts to compress the file based on the values
configured in the CompressibiltySamplingSize and CompressibleThreshold parameters.
When you specify EnableCompressibilitySampling as $true and don't specify either the
CompressibiltySamplingSize or CompressibleThreshold parameters, the algorithm attempts to
compress the first 524,288,000 bytes (500 MiB) of a file during transfer. The algorithm tries to
track that at least 104,857,600 bytes (100 MiB) compresses within that 500 MiB range. If fewer
than 100 MiB was compressible, SMB compression stops trying to compress the rest of the file. If at
least 100 MiB compressed, SMB compression attempts to compress the rest of the file.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates whether SMB client will allow insecure guest logons to an SMB server.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that large MTU is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates whether load balance scale out is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether to enable mailslots. If this parameter is specified, mailslots will be enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that multi-channel is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that the security signature is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether the SMB over QUIC client protocol is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the encryption ciphers used by the SMB client and the preferred order.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the extended session time-out.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum number entries that can be in the file information cache.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the file information cache lifetime.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum number entries that can be in the file not found cache.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the file not found cache lifetime.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseForces the command to run without asking for user confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies that the SMB client uses SMB encryption inside of the SMB over QUIC TLS 1.3 encrypted tunnel even if the SMB server doesn't require it.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the length of time (in seconds) that an invalid authentication cache entry should be kept before being removed. An authentication cache is used to store information about successful authentication attempts, and this parameter allows you to control how long unsuccessful attempts should be remembered before being purged.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the time, in seconds, before the SMB client session is automatically disconnected.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum number of concurrent outstanding network requests that the SMB client supports.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum connection count per server.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that opportunistic locks are disabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates if an SMB client should always request compression even if the server or application didn't specify it.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether or not encryption should be required for all SMB traffic. When this parameter is
set to $true, all SMB traffic must be encrypted, which is required by the server. If it is set to
$false (the default), encryption is not required, but may still be negotiated if both the client
and server support it.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that the security signature is required.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the session time-out.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies that the SMB client not trust the SMB over QUIC SMB server certificate issuer. Required when using a self-signed certificate.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter specifies the maximum version of the SMB protocol to be used. Acceptable values are:
- None – There is no maximum protocol version specified, the client can use any supported version.
- SMB202 – SMB 2.0.2 is the maximum version accepted by the SMB client.
- SMB210 - SMB 2.1.0 is the maximum version accepted by the SMB client.
- SMB300 - SMB 3.0.0 is the maximum version accepted by the SMB client.
- SMB302 - SMB 3.0.2 is the maximum version accepted by the SMB client.
- SMB311 - SMB 3.1.1 is the maximum version accepted by the SMB client.
Type: Smb2DialectMax
Parameter Sets: (All)
Aliases:
Accepted values: None, SMB202, SMB210, SMB300, SMB302, SMB311
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter specifies the minimum version of the SMB protocol to be used. Acceptable values are:
- None – There is no minimum protocol version specified, the client can use any supported version.
- SMB202 – SMB 2.0.2 is the minimum version accepted by the SMB client.
- SMB210 - SMB 2.1.0 is the minimum version accepted by the SMB client.
- SMB300 - SMB 3.0.0 is the minimum version accepted by the SMB client.
- SMB302 - SMB 3.0.2 is the minimum version accepted by the SMB client.
- SMB311 - SMB 3.1.1 is the minimum version accepted by the SMB client.
Type: Smb2DialectMin
Parameter Sets: (All)
Aliases:
Accepted values: None, SMB202, SMB210, SMB300, SMB302, SMB311
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that opportunistic locks are used.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the window size threshold.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet isn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.