Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-SmbMultichannelConstraint

New-SmbMultichannelConstraint

smbmultichannelconstraint.cdxml

Synopsis

Creates a new Server Message Block (SMB) multi-channel constraint for the specified server.

Syntax

New-SmbMultichannelConstraint [-ServerName] [-InterfaceIndex] [-AsJob] [-CimSession] [-Force] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

New-SmbMultichannelConstraint [-ServerName] [-InterfaceAlias] [-AsJob] [-CimSession] [-Force] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The New-SmbMultichannelConstraint cmdlet creates a new Server Message Block (SMB) multi-channel constraint for the specified server.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InterfaceAlias <String[]>

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

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InterfaceIndex <UInt32[]>

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

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ServerName <String>

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

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMultiChannelConnection

Notes

None

Examples

EXAMPLE 1

This example creates a new SMB multi-channel constraint for the SMB server named Contoso-SO.

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 : 

EXAMPLE 2

This example creates a new SMB multi-channel constraint for the SMB server named Contoso-SO without user 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 : 

Online Version
Get-SmbMultichannelConstraint
Remove-SmbMultichannelConstraint