Set-Net Lbfo Team Member

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

Syntax 

Set-NetLbfoTeamMember
   [[-Name] <String[]>]
   [[-Team] <String[]>]
   [-AdministrativeMode <AdminModes>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetLbfoTeamMember
   [-TeamOfTheMember <CimInstance>]
   [-AdministrativeMode <AdminModes>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetLbfoTeamMember
   -InputObject <CimInstance[]>
   [-AdministrativeMode <AdminModes>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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 .

Examples

Example 1: Set the team member role 

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

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

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional 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.

Type: AdminModes
Aliases: am
Parameter Sets: Active, Standby
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.

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

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the name of the team member to modify.

Type: String[]
Aliases: ifAlias, InterfaceAlias
Position: 0
Default value: None
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.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Team

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

Type: String[]
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TeamOfTheMember

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

Type: CimInstance
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

None

This cmdlet takes no input objects.

Outputs

MSFT_NetLbfoTeamMember

By default, this cmdlet produces no output.

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