New-SmbMultichannelConstraint

  • Reference
Module:
SmbShare

Creates an SMB multi-channel constraint for the specified server.

Syntax

New-SmbMultichannelConstraint
   [-ServerName] <String>
   [-InterfaceIndex] <UInt32[]>
   [-Force]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-SmbMultichannelConstraint
   [-ServerName] <String>
   [-Force]
   [-InterfaceAlias] <String[]>
   [-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.

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

-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

-InterfaceAlias

Specifies the interface aliases of the network interfaces that is used to connect to the server.

Type:String[]
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InterfaceIndex

Specifies the interface indexes of the network interfaces that are used to connect to the server.

Type:UInt32[]
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ServerName

Specifies, when the SMB client is connecting to this server, that the constraints determine which network interfaces are used.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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.