New-SmbMultichannelConstraint
Creates an SMB multi-channel constraint for the specified server.
Syntax
ByInterfaceIndex (Default)
New-SmbMultichannelConstraint
[-ServerName] <String>
[-InterfaceIndex] <UInt32[]>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByInterfaceAlias
New-SmbMultichannelConstraint
[-ServerName] <String>
[-InterfaceAlias] <String[]>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-SmbMultichannelConstraint cmdlet creates a Server Message Block (SMB) multi-channel constraint for the specified server. This constraint applies to the Default instance of SMB used for normal sharing. It does not apply to SMB-using application instances like Storage Replica, Storage Spaces Direct SBL, or CSV.
Examples
Example 1: Create an SMB multi-channel constraint for an SMB server
PS C:\>New-SmbMultichannelConstraint -ServerName "Contoso-SO" -InterfaceAlias "RDMA1", "RDMA2"
Confirm
Are you sure you want to perform this action?
Performing operation 'New-SmbMultichannelConstraint' on Target 'Contoso-SO'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
InterfaceAlias : RDMA1
InterfaceGuid : {597b0a73-2b66-4be0-9e6d-f42eae8a35d6}
InterfaceIndex : 12
ServerName : Contoso-SO
PSComputerName :
InterfaceAlias : RDMA2
InterfaceGuid : {bd3c4a04-64cf-4205-88f5-38c4c35dfc38}
InterfaceIndex : 15
ServerName : Contoso-SO
PSComputerName :
This command creates an SMB multi-channel constraint for the SMB server named Contoso-SO.
Example 2: Create an SMB multi-channel constraint for an SMB server without confirmation
PS C:\>New-SmbMultichannelConstraint -ServerName "Contoso-SO" -InterfaceIndex 12, 15 -Force
InterfaceAlias : RDMA1
InterfaceGuid : {597b0a73-2b66-4be0-9e6d-f42eae8a35d6}
InterfaceIndex : 12
ServerName : Contoso-SO
PSComputerName :
InterfaceAlias : RDMA2
InterfaceGuid : {bd3c4a04-64cf-4205-88f5-38c4c35dfc38}
InterfaceIndex : 15
ServerName : Contoso-SO
PSComputerName :
This command creates an SMB multi-channel constraint for the SMB server named Contoso-SO without user confirmation.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InterfaceAlias
Specifies the interface aliases of the network interfaces that is used to connect to the server.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByInterfaceAlias
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InterfaceIndex
Specifies the interface indexes of the network interfaces that are used to connect to the server.
Parameter properties
| Type: | UInt32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByInterfaceIndex
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServerName
Specifies, when the SMB client is connecting to this server, that the constraints determine which network interfaces are used.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
CimInstance
This cmdlet returns a MSFT_SmbMultiChannelConnection object that represents the SMB multi-channel constraints for the server against which one or more constraints are created.