Set-NetLbfoTeam
Set-NetLbfoTeam
Sets parameters on the specified NIC team.
Syntax
Parameter Set: ByName
Set-NetLbfoTeam [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-LoadBalancingAlgorithm <LBAlgos> ] [-PassThru] [-TeamingMode <TeamingModes> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: __cmdletization_InputObject
Set-NetLbfoTeam -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-LoadBalancingAlgorithm <LBAlgos> ] [-PassThru] [-TeamingMode <TeamingModes> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByMemberOfTheTeam
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]> ] [-LoadBalancingAlgorithm <LBAlgos> ] [-MemberOfTheTeam <CimInstance> ] [-PassThru] [-TeamingMode <TeamingModes> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByTeamNicForTheTeam
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]> ] [-LoadBalancingAlgorithm <LBAlgos> ] [-PassThru] [-TeamingMode <TeamingModes> ] [-TeamNicForTheTeam <CimInstance> ] [-ThrottleLimit <Int32> ] [ <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
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 |
-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 four load balancing algorithms:
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.
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.
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.
HyperVPort: Distributes network traffic based on the source virtual machine Hyper-V switch port identifier.
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? |
true |
-PassThru
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 three 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 |
<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
This cmdlet takes no input objects.
Outputs
The output type is the type of the objects that the cmdlet emits.
MSFT_NetLbfoTeam
By default, this cmdlet produces no output.
If the PassThru parameter is specified, the cmdlet returns the updated MSFT_NetLbfoTeam object.
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