Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Set-NetLbfoTeam

Last Updated: 3/31/2017

SYNOPSIS

Sets parameters on the specified NIC team.

SYNTAX

ByName (Default)

Set-NetLbfoTeam [[-Name] <String[]>] [-TeamingMode <TeamingModes>] [-LoadBalancingAlgorithm <LBAlgos>]
 [-LacpTimer <LacpTimers>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ByMemberOfTheTeam

Set-NetLbfoTeam [-MemberOfTheTeam <CimInstance>] [-TeamingMode <TeamingModes>]
 [-LoadBalancingAlgorithm <LBAlgos>] [-LacpTimer <LacpTimers>] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

ByTeamNicForTheTeam

Set-NetLbfoTeam [-TeamNicForTheTeam <CimInstance>] [-TeamingMode <TeamingModes>]
 [-LoadBalancingAlgorithm <LBAlgos>] [-LacpTimer <LacpTimers>] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject (cdxml)

Set-NetLbfoTeam -InputObject <CimInstance[]> [-TeamingMode <TeamingModes>] [-LoadBalancingAlgorithm <LBAlgos>]
 [-LacpTimer <LacpTimers>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

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

You must have administrator rights to run Set-NetLbfoTeam.

EXAMPLES

Example 1: Set the teaming mode

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

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

Example 2: Set the load balancing algorithm

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

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

Example 3: Set the teaming mode and load balancing algorithm

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

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.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-LacpTimer

{{Fill LacpTimer Description}}

Type: LacpTimers
Parameter Sets: (All)
Aliases: lt
Accepted values: Slow, Fast

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoadBalancingAlgorithm

Specifies the load-balancing algorithm the new 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.

Type: LBAlgos
Parameter Sets: (All)
Aliases: lba
Accepted values: TransportPorts, IPAddresses, MacAddresses, HyperVPort, Dynamic

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MemberOfTheTeam

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

Type: CimInstance
Parameter Sets: ByMemberOfTheTeam
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the NIC team to modify.

Type: String[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PassThru

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TeamNicForTheTeam

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

Type: CimInstance
Parameter Sets: ByTeamNicForTheTeam
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TeamingMode

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.
Type: TeamingModes
Parameter Sets: (All)
Aliases: tm
Accepted values: Static, SwitchIndependent, Lacp

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

This cmdlet takes no input objects.

OUTPUTS

MSFT_NetLbfoTeam

By default, this cmdlet produces no output. If the PassThru parameter is specified, the cmdlet returns the updated MSFT_NetLbfoTeam object.

NOTES

Get-NetLbfoTeam

New-NetLbfoTeam

Rename-NetLbfoTeam

Remove-NetLbfoTeam

© 2017 Microsoft