New-SmbMultichannelConstraint

New-SmbMultichannelConstraint

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

Syntax

Parameter Set: ByInterfaceIndex
New-SmbMultichannelConstraint [-ServerName] <String> [-InterfaceIndex] <UInt32[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByInterfaceAlias
New-SmbMultichannelConstraint [-ServerName] <String> [-InterfaceAlias] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-ThrottleLimit <Int32> ] [-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

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

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

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

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

    The MSFT_SmbMultiChannelConnection object represents the SMB multi-channel constraints for the server against which one or more constraints are created.

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

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

Get-SmbMultichannelConstraint

Remove-SmbMultichannelConstraint