< Back
Set-NetLbfoTeamMember
Post
NAME Set-NetLbfoTeamMember
SYNOPSIS
Sets the role of a member network adapter in a NIC team.
SYNTAX
Set-NetLbfoTeamMember [[-Name] <String[]>] [[-Team] <String[]>] [-AdministrativeMode <AdminModes>] [-AsJob] [-CimSession <CimSession[]>]
[-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeamMember [-AdministrativeMode <AdminModes>] [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-TeamOfTheMember <CimInstance>]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeamMember [-AdministrativeMode <AdminModes>] [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -InputObject
<CimInstance[]> [-Confirm] [-WhatIf] [<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.
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
-InputObject <CimInstance[]>
Specifies the object which contains the team member to modify.
Required? true
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the team member to modify.
Required? false
Position? 1
Default value All members adapters across all teams
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Team <String[]>
Specifies the name of the NIC team which contains the network adapter to modify.
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.
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, 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_NetLbfoTeamMember
By default, this cmdlet produces no output.
If the PassThru parameter is specified, the cmdlet returns the updated MSFT_NetLbfoTeamMember object.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294345
Get-NetLbfoTeamMember
Add-NetLbfoTeamMember
Remove-NetLbfoTeamMember
SYNOPSIS
Sets the role of a member network adapter in a NIC team.
SYNTAX
Set-NetLbfoTeamMember [[-Name] <String[]>] [[-Team] <String[]>] [-AdministrativeMode <AdminModes>] [-AsJob] [-CimSession <CimSession[]>]
[-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeamMember [-AdministrativeMode <AdminModes>] [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-TeamOfTheMember <CimInstance>]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetLbfoTeamMember [-AdministrativeMode <AdminModes>] [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -InputObject
<CimInstance[]> [-Confirm] [-WhatIf] [<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.
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
-InputObject <CimInstance[]>
Specifies the object which contains the team member to modify.
Required? true
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the team member to modify.
Required? false
Position? 1
Default value All members adapters across all teams
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Team <String[]>
Specifies the name of the NIC team which contains the network adapter to modify.
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.
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, 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_NetLbfoTeamMember
By default, this cmdlet produces no output.
If the PassThru parameter is specified, the cmdlet returns the updated MSFT_NetLbfoTeamMember object.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294345
Get-NetLbfoTeamMember
Add-NetLbfoTeamMember
Remove-NetLbfoTeamMember