Set-SmbClientConfiguration

Syntax

Default (Default)

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>]

Description

Examples

Example 1: Set the SMB client configuration

Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 8 -Confirm:$false

Example 2: Specify encryption ciphers

Set-SmbClientConfiguration -EncryptionCiphers "AES_128_GCM, AES_256_GCM" -Confirm:$false

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Parameter sets

-AuditInsecureGuestLogon

Specifies whether to audit insecure guest logon attempts. Audit events are written to the Windows event log.

Parameter properties

Parameter sets

-AuditServerDoesNotSupportEncryption

Specifies 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.

Parameter properties

Parameter sets

-AuditServerDoesNotSupportSigning

Specifies 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.

Parameter properties

Parameter sets

-BlockNTLM

Specifies 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.

Parameter properties

Parameter sets

-CimSession

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.

Parameter properties

Parameter sets

-CompressibilitySamplingSize

Specifies 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).

Parameter properties

Parameter sets

-CompressibleThreshold

Specifies 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).

Parameter properties

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-ConnectionCountPerRssNetworkInterface

Specifies the SMB connection count per each RSS network interface.

Parameter properties

Parameter sets

-DirectoryCacheEntriesMax

Specifies the maximum cache entries that can be in the directory cache.

Parameter properties

Parameter sets

-DirectoryCacheEntrySizeMax

Specifies the maximum size of directory cache entry.

Parameter properties

Parameter sets

-DirectoryCacheLifetime

Specifies the directory cache lifetime.

Parameter properties

Parameter sets

-DisableCompression

Specifies that the SMB client ignores all requests for compression from applications or SMB servers.

Parameter properties

Parameter sets

-DormantFileLimit

Specifies the dormant file limit.

Parameter properties

Parameter sets

-EnableBandwidthThrottling

Indicates that bandwidth throttling is enabled.

Parameter properties

Parameter sets

-EnableByteRangeLockingOnReadOnlyFiles

Indicates that byte range locking on read-only files is enabled.

Parameter properties

Parameter sets

-EnableCompressibilitySampling

Controls 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.

Parameter properties

Parameter sets

-EnableInsecureGuestLogons

Indicates whether SMB client will allow insecure guest logons to an SMB server.

Parameter properties

Parameter sets

-EnableLargeMtu

Indicates that large MTU is enabled.

Parameter properties

Parameter sets

-EnableLoadBalanceScaleOut

Indicates whether load balance scale out is enabled.

Parameter properties

Parameter sets

-EnableMailslots

Specifies whether to enable mailslots. If this parameter is specified, mailslots will be enabled.

Parameter properties

Parameter sets

-EnableMultiChannel

Indicates that multi-channel is enabled.

Parameter properties

Parameter sets

-EnableSecuritySignature

Indicates that the security signature is enabled.

Parameter properties

Parameter sets

-EnableSMBQUIC

Specifies whether the SMB over QUIC client protocol is enabled.

Parameter properties

Parameter sets

-EncryptionCiphers

Specifies the encryption ciphers used by the SMB client and the preferred order.

Parameter properties

Parameter sets

-ExtendedSessionTimeout

Specifies the extended session time-out.

Parameter properties

Parameter sets

-FileInfoCacheEntriesMax

Specifies the maximum number entries that can be in the file information cache.

Parameter properties

Parameter sets

-FileInfoCacheLifetime

Specifies the file information cache lifetime.

Parameter properties

Parameter sets

-FileNotFoundCacheEntriesMax

Specifies the maximum number entries that can be in the file not found cache.

Parameter properties

Parameter sets

-FileNotFoundCacheLifetime

Specifies the file not found cache lifetime.

Parameter properties

Parameter sets

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Parameter sets

-ForceSMBEncryptionOverQuic

Specifies 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.

Parameter properties

Parameter sets

-InvalidAuthenticationCacheLifetime

Specifies 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.

Parameter properties

Parameter sets

-KeepConn

Specifies the time, in seconds, before the SMB client session is automatically disconnected.

Parameter properties

Parameter sets

-MaxCmds

Specifies the maximum number of concurrent outstanding network requests that the SMB client supports.

Parameter properties

Parameter sets

-MaximumConnectionCountPerServer

Specifies the maximum connection count per server.

Parameter properties

Parameter sets

-OplocksDisabled

Indicates that opportunistic locks are disabled.

Parameter properties

Parameter sets

-RequestCompression

Indicates if an SMB client should always request compression even if the server or application didn't specify it.

Parameter properties

Parameter sets

-RequireEncryption

Specifies 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.

Parameter properties

Parameter sets

-RequireSecuritySignature

Indicates that the security signature is required.

Parameter properties

Parameter sets

-SessionTimeout

Specifies the session time-out.

Parameter properties

Parameter sets

-SkipCertificateCheck

Specifies that the SMB client not trust the SMB over QUIC SMB server certificate issuer. Required when using a self-signed certificate.

Parameter properties

Parameter sets

-Smb2DialectMax

This 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.

Parameter properties

Parameter sets

-Smb2DialectMin

This 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.

Parameter properties

Parameter sets

-ThrottleLimit

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.

Parameter properties

Parameter sets

-UseOpportunisticLocking

Indicates that opportunistic locks are used.

Parameter properties

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Parameter properties

Parameter sets

-WindowSizeThreshold

Specifies the window size threshold.

Parameter properties

Parameter sets

CommonParameters

Inputs

None

Outputs

Object

Related Links

• Get-SmbClientConfiguration
• Reset-SmbClientConfiguration