Edit

Share via


Get-NetSwitchTeam

Gets the extensible switch team.

Syntax

ByName (Default)

Get-NetSwitchTeam
    [[-Name] <String[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByMember

Get-NetSwitchTeam
    [-Member <CimInstance>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Get-NetSwitchTeam cmdlet gets the extensible switch team. If no parameter is specified, this cmdlet returns all of the switch teams on the server. The name may contain wildcard characters () for matching. For example, T1 would match all of the team names beginning with T and ending with 1. Alternately the switch team may be identified by a switch team member.

Examples

Example 1: Get a switch team

PS C:\> Get-NetSwitchTeam -Name "SwitchTeam01"

This command gets the switch team named SwitchTeam01.

Example 2: Get multiple switch teams

PS C:\> Get-NetSwitchTeam -Name "SwitchTeam*"

This example gets all of the switch teams with the name with the wildcard character matching SwitchTeam*.

Parameters

-AsJob

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Member

Specifies the member object of a network adapter in a switch team. This parameter is used instead of the switch team name.

Parameter properties

Type:CimInstance
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByMember
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the extensible switch team. If no parameter is supplied, then this cmdlet returns all of the teams on the server.

This parameter may contain wildcard characters () for matching. For example, T1 would match all of the team names beginning with T and ending with 1.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

None