< Back
Get-NetLbfoTeam
Post
NAME Get-NetLbfoTeam
SYNOPSIS
Retrieves a list of NIC teams on the system, as specified by the input parameters.
SYNTAX
Get-NetLbfoTeam [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-MemberOfTheTeam <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-TeamNicForTheTeam <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
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 [<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
-MemberOfTheTeam <CimInstance>
Specifies the member network adapter name to retrieve the associated NIC team.
Required? false
Position? named
Default value
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.
Required? false
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TeamNicForTheTeam <CimInstance>
Specifies the team interface to retrieve the associated NIC team.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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
This cmdlet returns an array of MSFT_NetLbfoTeam objects containing the teams that match the query.
Example 1: Get a specific 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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294336
New-NetLbfoTeam
Remove-NetLbfoTeam
Rename-NetLbfoTeam
Set-NetLbfoTeam
SYNOPSIS
Retrieves a list of NIC teams on the system, as specified by the input parameters.
SYNTAX
Get-NetLbfoTeam [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-MemberOfTheTeam <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-TeamNicForTheTeam <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
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 [<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
-MemberOfTheTeam <CimInstance>
Specifies the member network adapter name to retrieve the associated NIC team.
Required? false
Position? named
Default value
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.
Required? false
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TeamNicForTheTeam <CimInstance>
Specifies the team interface to retrieve the associated NIC team.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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
This cmdlet returns an array of MSFT_NetLbfoTeam objects containing the teams that match the query.
Example 1: Get a specific 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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294336
New-NetLbfoTeam
Remove-NetLbfoTeam
Rename-NetLbfoTeam
Set-NetLbfoTeam