Edit

Share via


Add-NetLbfoTeamMember

Adds a new member (network adapter) to a specified NIC team.

Syntax

Default (Default)

Add-NetLbfoTeamMember
    [-Name] <WildcardPattern>
    [-Team] <String>
    [[-AdministrativeMode] <AdminModes>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Add-NetLbfoTeamMember cmdlet adds a new network adapter as a member to the specified team. You can use the AdministrativeMode parameter to specify the initial role of the new team member.

Examples

Example 1: Add a new team member

PS C:\> Add-NetLbfoTeamMember -Name "NIC1" -Team "Team1"

This command adds a new member named NIC1 to the specified team named Team1.

Example 2: Add a new team member with initial status

PS C:\> Add-NetLbfoTeamMember -Name "NIC2" -Team "Team2" -AdministrativeMode Standby

This command adds a new member named NIC2 to the specified team named Team2 with the initial status Standby.

Example 3: Add new team members using wildcard pattern

PS C:\> Add-NetLbfoTeamMember -Name "NIC*" -Team "Team1"

This command adds new members whose name starts with NIC to the specified team named Team1.

Parameters

-AdministrativeMode

Specifies the initial role of the new member (network adapter). The acceptable values for this parameter are:

  • Active. Allows the team member to participate in the NIC team.
  • Standby. Places the member in a standby state where it does not participate in the team. The team member is automatically moved to the Active state if any other member of the team fails.

By default, the initial role of the team member is Active.

At most one member in a team can be in Standby mode.

Parameter properties

Type:AdminModes
Default value:None
Accepted values:Active, Standby
Supports wildcards:False
DontShow:False
Aliases:am

Parameter sets

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

-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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-Name

Specifies the name (Interface Alias or Connection Name) of the network adapter to add.

Parameter properties

Type:WildcardPattern
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ifAlias, InterfaceAlias

Parameter sets

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

-Team

Specifies the name of the NIC team to which to add the new network adapter.

Parameter properties

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

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

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

This cmdlet takes no input objects.

Outputs

MSFT_NetLbfoTeamMember

This cmdlet returns an array of MSFT_NetLbfoTeamMember objects consisting of the newly added member network adapter objects to the team.