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
 

Set-NetLbfoTeam

Set-NetLbfoTeam

msft_netlbfoteam.cdxml

Synopsis

Sets parameters on the specified NIC team.

Syntax

Set-NetLbfoTeam [-Name] [-AsJob] [-CimSession] [-LoadBalancingAlgorithm] [-PassThru] [-TeamingMode] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetLbfoTeam [-AsJob] [-CimSession] [-LoadBalancingAlgorithm] [-PassThru] [-TeamingMode] [-TeamNicForTheTeam] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetLbfoTeam [-AsJob] [-CimSession] [-LoadBalancingAlgorithm] [-MemberOfTheTeam] [-PassThru] [-TeamingMode] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetLbfoTeam [-AsJob] [-CimSession] [-LoadBalancingAlgorithm] [-PassThru] [-TeamingMode] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetLbfoTeam cmdlet sets the TeamingMode or LoadBalancingAlgorithm parameters on the specified NIC team.

You need administrator privileges to use Set-NetLbfoTeam.

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

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the object which contains the NIC team parameters to set.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-LoadBalancingAlgorithm <LBAlgos>

Specifies the load balancing algorithm the NIC team uses to distribute network traffic between the interfaces. You can specify one of the following load balancing algorithms:

-- Dynamic:  Uses the source and destination TCP ports and the IP addresses to create a hash for outbound traffic.  Moves outbound streams from team member to team member as needed to balance team member utilization.  When you specify this algorithm with the TeamingMode parameter and the SwitchIndependent value, inbound traffic is routed to a particular team member. 

-- TransportPorts: Uses the source and destination TCP ports and the IP addresses to create a hash, and then assigns the packets that have the matching hash value to one of the available interfaces. When you specify this algorithm with the TeamingMode parameter and the SwitchIndependent value all inbound traffic arrives on the primary team member.

-- IPAddresses: Uses the source and destination IP addresses to create a hash, and then assigns the packets that have the matching hash value to one of the available interfaces. When you specify this algorithm with the TeamingMode parameter and the SwitchIndependent value, all inbound traffic arrives on the primary team member.

-- MacAddresses: Uses the source and destination MAC addresses to create a hash and then assigns the packets that have the matching hash value to one of the available interfaces. When you specify this algorithm with the TeamingMode parameter and the SwitchIndependent value, all inbound traffic arrives on the primary team member.

-- HyperVPort: Distributes network traffic based on the source virtual machine Hyper-V switch port identifier. When you specify this algorithm with the TeamingMode parameter and the SwitchIndependent value, inbound traffic is routed to the same team member as the switch port’s outgoing traffic. 

Aliases

lba

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MemberOfTheTeam <CimInstance>

Specifies the network adapter name for which to modify the parameters.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Name <String[]>

Specifies the name of the NIC team to modify.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TeamNicForTheTeam <CimInstance>

Specifies the team interface whose associated NIC team is to be modified.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-TeamingMode <TeamingModes>

Specifies the mode of the NIC teaming. You can specify one of the following teaming modes:

-- LACP: Requires configuration on both the switch and the host to identify which links form the team. Uses the Link Aggregation Control Protocol (LACP) to identify links that are connected between the host and a given switch.

-- Static: Requires configuration on both the switch and the host to identify which links form the team.

-- SwitchIndependent: Specifies that a network switch configuration is not needed for the NIC team. Because the network switch is not configured to know about the NIC teaming, the team members can be connected to different switches.

Aliases

tm

Required?

false

Position

named

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

MSFT_NetLbfoTeam

Notes

None

Examples

Example 1: Set the teaming mode

This command sets the teaming mode of the team named Team1 to LACP.

PS C:\> Set-NetLbfoTeam -Name Team1 –TeamingMode LACP

Example 2: Set the load balancing algorithm

This command sets the load balancing algorithm of the team named Team1 to HyperVPorts.

PS C:\> Set-NetLbfoTeam -Name Team1 –LoadBalancingAlgorithm HyperVPorts

Example 3: Set the teaming mode and load balancing algorithm

This command sets the teaming mode and load balancing algorithm of the team named Team1 at the same time. The teaming mode is set to LACP and the load balancing algorithm is set to HyperVPorts.

PS C:\> Set-NetLbfoTeam -Name Team1 –TeamingMode LACP –LoadBalancingAlgorithm HyperVPorts

Online Version
New-NetLbfoTeam
Get-NetLbfoTeam
Rename-NetLbfoTeam
Remove-NetLbfoTeam