Export (0) Print
Expand All

Set-NetLbfoTeamMember

Windows Server 2012 R2 and Windows 8.1

Updated: April 21, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-NetLbfoTeamMember

Sets the role of a member network adapter in a NIC team.

Syntax

Parameter Set: ByNameAndOrTeam
Set-NetLbfoTeamMember [[-Name] <String[]> ] [[-Team] <String[]> ] [-AdministrativeMode <AdminModes> ] [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByTeamOfTheMember
Set-NetLbfoTeamMember [-AdministrativeMode <AdminModes> ] [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-TeamOfTheMember <CimInstance> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-NetLbfoTeamMember -InputObject <CimInstance[]> [-AdministrativeMode <AdminModes> ] [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-NetLbfoTeamMember cmdlet sets the role of a specified network adapter (team member) in the NIC team. You can specify the team member either by specifying the name or by specifying the network adapter object retrieved using the Get-NetLbfoTeamMember cmdlet.

You need administrative privileges to use Set-NetLbfoTeamMember.

Parameters

-AdministrativeMode<AdminModes>

Specifies the administrative mode of the network adapter to modify.

You can specify one of the following two administrative modes:

Active: Allows the team member to participate in the NIC team. By default, the role of the team member is Active.

Standby: Places the member in a standby state where it does not participate in the team. The team member will be automatically moved to Active state if any other member of the team fails.

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


Aliases

am

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AsJob

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.


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

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies the object which contains the team member to modify.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the name of the team member to modify.


Aliases

ifAlias,InterfaceAlias

Required?

false

Position?

1

Default Value

All members adapters across all teams

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Team<String[]>

Specifies the name of the NIC team which contains the network adapter to modify.


Aliases

none

Required?

false

Position?

2

Default Value

All teams on the host

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TeamOfTheMember<CimInstance>

Specifies the NIC team object whose associated member objects are to be modified.


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

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

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.

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_NetLbfoTeamMember

    By default, this cmdlet produces no output.

    If the PassThru parameter is specified, the cmdlet returns the updated MSFT_NetLbfoTeamMember object.


Examples

Example 1: Set the team member role

This command sets the administrative mode of the specified team member named NIC4 to Standby.


PS C:\> Set-NetLbfoTeamMember -Name "NIC4" -AdministrativeMode Standby

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft