New-NetLbfoTeam
New-NetLbfoTeam
Creates a new NIC team.
Syntax
Parameter Set: Create0
New-NetLbfoTeam [-Name] <String> [-TeamMembers] <WildcardPattern[]> [[-TeamNicName] <String> ] [[-TeamingMode] <TeamingModes> ] [[-LoadBalancingAlgorithm] <LBAlgos> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The New-NetLbfoTeam cmdlet creates a new NIC team that consists of one or more network adapters. Teaming network adapters of different speeds is not supported. You can create a team with network adapters of different speeds, but the network traffic distribution algorithms do not take the speed of each network adapter into consideration when distributing traffic.
When you create a team, you can specify additional properties such as TeamingMode and LoadBalancingAlgorithm.
You need administrator privileges to use New-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 |
-LoadBalancingAlgorithm<LBAlgos>
Specifies the load-balancing algorithm the new 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? |
6 |
Default Value |
TransportPorts |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the new NIC team.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TeamMembers<WildcardPattern[]>
Specifies the names of the network adapters that are members of the new team. Specify multiple network adapter names (or wildcard patterns) separated by a comma.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TeamNicName<String>
Specifies the name of the new team interface. This is the name used to reference the teamed network adapters.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
same as team name |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TeamingMode<TeamingModes>
Specifies the mode of the NIC teaming. You can specify one of the following three teaming modes:
LACP: Uses the IEEE 802.1ax Link Aggregation Control Protocol (LACP) to dynamically identify links that are connected between the host and a given switch. (This protocol was formerly known as IEEE 802.3ad draft)
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 interface teaming, the team interfaces can be connected to different switches.
Aliases |
tm |
Required? |
false |
Position? |
5 |
Default Value |
SwitchIndependent |
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
This cmdlet produces an MSFT_NetLbfoTeam object, corresponding to the newly created team.
Examples
Example 1: Create a new team
This command creates a new team named Team1 with two team members named NIC1 and NIC2.
PS C:\> New-NetLbfoTeam –Name Team1 –TeamMembers NIC1,NIC2
Example 2: Create a new team with specified properties
This command creates a new team named Team1 that consists of two team members named NIC1 and NIC2. The teaming mode is set to LACP and the load balancing algorithm is set to HyperVPorts.
PS C:\> New-NetLbfoTeam -Name Team1 -TeamMembers NIC1,NIC2 -TeamingMode LACP
-LoadBalancingAlgorithm HyperVPorts
Example 3: Create a new team in a virtual machine
This set of commands allows teaming in virtual machines by using the AllowTeaming parameter of the Set-VMNetworkAdapter cmdlet and then creates a team named Team2 in the virtual machine specified by VMName. You must run the following command in the host (parent partition) with administrator permissions.
PS C:\> Set-VMNetworkAdapter -VMName <VMname> -AllowTeaming
PS C:\> New-NetLbfoTeam –Name Team2 –TeamMembers NIC1,NIC2