Get-NetLbfoTeam
Get-NetLbfoTeam
Retrieves a list of NIC teams on the system, as specified by the input parameters.
Syntax
Parameter Set: ByName
Get-NetLbfoTeam [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByMemberOfTheTeam
Get-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]> ] [-MemberOfTheTeam <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByTeamNicForTheTeam
Get-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]> ] [-TeamNicForTheTeam <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-NetLbfoTeam cmdlet retrieves the list of all available NIC teams on the system.
You can retrieve the list of NIC teams by specifying the name or name pattern of the team. You can also use Get-NetLbfoTeam to retrieve the team associated with a team interface or a team member (network adapter).
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 |
-MemberOfTheTeam<CimInstance>
Specifies the member network adapter name to retrieve the associated NIC team.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name (or name wildcard pattern) of the NIC team for which to retrieve information.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-TeamNicForTheTeam<CimInstance>
Specifies the team interface to retrieve the associated NIC team.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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 returns an array of MSFT_NetLbfoTeam objects containing the teams that match the query.
Examples
Example 1: Get a specific team
This command retrieves a NIC team named Team1.
PS C:\> Get-NetLbfoTeam –Name Team1
Example 2: Get the list of all teams whose name starts with ‘T’ and then remove
This command retrieves the list of teams whose name starts with T using Get-NetLbfoTeam. A pipeline operator (|) sends all the teams to Remove-NetLbfoTeam which removes them.
PS C:\> Get-NetLbfoTeam –Name T*| Remove-NetLbfoTeam
Example 3: Get the team associated with a particular member network adapter
This command retrieves the NIC team associated with a particular member network adapter named NIC1 using Get-NetLbfoTeam.
PS C:\> Get-NetLbfoTeamMember NIC1 | Get-NetLbfoTeam
Or
PS C:\> $mObj = Get-NetLbfoTeamMember NIC1
PS C:\> Get-NetLbfoTeam –MemberOfTheTeam $mObj
Example 4: Get the team associated with a particular team interface
This command retrieves the NIC team associated with a particular team interface named Team1 – VLAN 42 using Get-NetLbfoTeam.
PS C:\> Get-NetLbfoTeamNic ‘Team1 – VLAN 42’ | Get-NetLbfoTeam
Or
PS C:\> $tNicObj = Get-NetLbfoTeamNic ‘Team1 – VLAN 42’
PS C:\> Get-NetLbfoTeam –TeamNicForTheTeam $tNicObj