Set-NetLbfoTeam
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 HyperVPort
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 HyperVPort
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
| Type: | CimInstance[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject (cdxml)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LacpTimer
Specifies how often inter-connected devices exchange LACP protocol data units (PDUs) or control messages.
Parameter properties
| Type: | LacpTimers |
| Default value: | None |
| Accepted values: | Slow, Fast |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | lt |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | LBAlgos |
| Default value: | None |
| Accepted values: | TransportPorts, IPAddresses, MacAddresses, HyperVPort, Dynamic |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | lba |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MemberOfTheTeam
Specifies the network adapter name for which to modify the parameters.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByMemberOfTheTeam
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the NIC team to modify.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | TeamingModes |
| Default value: | None |
| Accepted values: | Static, SwitchIndependent, Lacp |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | tm |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TeamNicForTheTeam
Specifies the team interface whose associated NIC team is to be modified.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByTeamNicForTheTeam
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -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.