Edit

Share via

Get-NetLbfoTeam

  • Reference
Module:
NetLbfo

Gets a list of NIC teams on the system.

Syntax

Get-NetLbfoTeam
   [[-Name] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-NetLbfoTeam
   [-MemberOfTheTeam <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-NetLbfoTeam
   [-TeamNicForTheTeam <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NetLbfoTeam cmdlet gets 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 get the team associated with a team interface or a team member (network adapter).

Examples

Example 1: Get a specified team

PS C:\> Get-NetLbfoTeam -Name Team1

This command retrieves a NIC team named Team1.

Example 2: Get the list of all teams whose name starts with T and then remove

PS C:\> Get-NetLbfoTeam -Name T*| Remove-NetLbfoTeam

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.

Example 3: Get the team associated with a particular member network adapter

PS C:\> Get-NetLbfoTeamMember NIC1 | Get-NetLbfoTeam

Or


PS C:\> $mObj = Get-NetLbfoTeamMember NIC1
PS C:\> Get-NetLbfoTeam -MemberOfTheTeam $mObj

This command retrieves the NIC team associated with a particular member network adapter named NIC1 using Get-NetLbfoTeam.

Example 4: Get the team associated with a particular team interface

PS C:\> Get-NetLbfoTeamNic "Team1 - VLAN 42" | Get-NetLbfoTeam

Or


PS C:\> $tNicObj = Get-NetLbfoTeamNic "Team1 - VLAN 42"
PS C:\> Get-NetLbfoTeam -TeamNicForTheTeam $tNicObj

This command retrieves the NIC team associated with a particular team interface named Team1 - VLAN 42 using Get-NetLbfoTeam.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MemberOfTheTeam

Specifies the member network adapter name to retrieve the associated NIC team.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name (or name wildcard pattern) of the NIC team for which to retrieve information.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TeamNicForTheTeam

Specifies the team interface to retrieve the associated NIC team.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

This cmdlet takes no input objects.

Outputs

MSFT_NetLbfoTeam

This cmdlet returns an array of MSFT_NetLbfoTeam objects containing the teams that match the query.