Set-SmbServerAlternativePort
Configures the alternative ports for the Server Message Block (SMB) protocol on the local server.
Syntax
Set-SmbServerAlternativePort
[-TransportType] <TransportType>
[-Port] <UInt16>
[-EnableInstances] <Instance>
[[-DisableInstances] <Instance>]
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-SmbServerAlternativePort cmdlet can be used to set the alternate ports that SMB will use
for incoming connections that accepts a list of port numbers and updates the SMB configuration
accordingly.
Examples
Example 1: Configure a new SMB server alternative port
Set-SmbServerAlternativePort -TransportType QUIC -Port 1Configures an SMB server alternative port that uses the QUIC transport protocol on port number 1.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableInstances
Disables alternative ports on SMB instances. Currently only the Default instance is allowed. This setting is not used.
| Type: | Instance |
| Accepted values: | None, Default |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnableInstances
Enables alternative ports on SMB instances. Currently only the Default instance is allowed. This setting is not used.
| Type: | Instance |
| Accepted values: | None, Default |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
Specifies the port number that the SMB connection should use.
| Type: | UInt16 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TransportType
Specifies the network transport used by SMB. The acceptable values for this parameter are:
TCP: Use TCP network transport.QUIC: Use QUIC network transport.None: Use default transport behavior (first try TCP then try QUIC).
| Type: | TransportType |
| Accepted values: | None, TCP, QUIC |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbServerAlternativePort.TransportType
Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbServerAlternativePort.Instance