< Back
Set-NetLbfoTeam
Post
NAME Set-NetLbfoTeam
SYNOPSIS
Sets parameters on the specified NIC team.
SYNTAX
Set-NetLbfoTeam [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-PassThru] [-TeamingMode
<TeamingModes>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-PassThru] [-TeamingMode <TeamingModes>]
[-TeamNicForTheTeam <CimInstance>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-MemberOfTheTeam <CimInstance>] [-PassThru]
[-TeamingMode <TeamingModes>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-PassThru] [-TeamingMode <TeamingModes>]
[-ThrottleLimit <Int32>] -InputObject <CimInstance[]> [-Confirm] [-WhatIf] [<CommonParameters>]
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InputObject <CimInstance[]>
Specifies the object which contains the NIC team parameters to set.
Required? true
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MemberOfTheTeam <CimInstance>
Specifies the network adapter name for which to modify the parameters.
Required? false
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the NIC team to modify.
Required? false
Position? 1
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TeamNicForTheTeam <CimInstance>
Specifies the team interface whose associated NIC team is to be modified.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294344
New-NetLbfoTeam
Get-NetLbfoTeam
Rename-NetLbfoTeam
Remove-NetLbfoTeam
SYNOPSIS
Sets parameters on the specified NIC team.
SYNTAX
Set-NetLbfoTeam [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-PassThru] [-TeamingMode
<TeamingModes>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-PassThru] [-TeamingMode <TeamingModes>]
[-TeamNicForTheTeam <CimInstance>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-MemberOfTheTeam <CimInstance>] [-PassThru]
[-TeamingMode <TeamingModes>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-LoadBalancingAlgorithm <LBAlgos>] [-PassThru] [-TeamingMode <TeamingModes>]
[-ThrottleLimit <Int32>] -InputObject <CimInstance[]> [-Confirm] [-WhatIf] [<CommonParameters>]
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InputObject <CimInstance[]>
Specifies the object which contains the NIC team parameters to set.
Required? true
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MemberOfTheTeam <CimInstance>
Specifies the network adapter name for which to modify the parameters.
Required? false
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the NIC team to modify.
Required? false
Position? 1
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TeamNicForTheTeam <CimInstance>
Specifies the team interface whose associated NIC team is to be modified.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294344
New-NetLbfoTeam
Get-NetLbfoTeam
Rename-NetLbfoTeam
Remove-NetLbfoTeam