New-SmbServerAlternativePort
Creates a new alternative port for the Server Message Block (SMB) protocol on the local server.
Syntax
New-SmbServerAlternativePort
[-TransportType] <TransportType>
[-Port] <UInt16>
[-EnableInstances] <Instance>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-SmbServerAlternativePort
cmdlet creates a new alternative port for the Server Message
Block (SMB) protocol on the local server. This cmdlet can be used to add a new port to the list of
alternate ports that are available for SMB connections.
Examples
Example 1: Create a new SMB server alternative port
New-SmbServerAlternativePort -TransportType QUIC -Port 1
This command creates a new SMB server alternative port that uses TCP transport 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: | None |
Required: | False |
Accept pipeline input: | False |
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: | False |
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 transport protocol to use for the SMB connection. The only accepted value for this
parameter is QUIC
.
Type: | TransportType[] |
Accepted values: | QUIC |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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