Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetLbfoTeamNic

Set-NetLbfoTeamNic

msft_netlbfoteamnic.cdxml

Synopsis

Sets a new VLAN id on a team interface, or restores the interface to Default mode.

Syntax

Set-NetLbfoTeamNic [-Name] [-Team] [-AsJob] [-CimSession] [-Default] [-PassThru] [-ThrottleLimit] [-VlanID] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetLbfoTeamNic [-AsJob] [-CimSession] [-Default] [-PassThru] [-ThrottleLimit] [-VlanID] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetLbfoTeamNic [-AsJob] [-CimSession] [-Default] [-PassThru] [-TeamOfTheTeamNic] [-ThrottleLimit] [-VlanID] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetLbfoTeamNic cmdlet sets the optional values on a team interface. Only the team interface that was created when the team was created can be set to Default mode.

You need administrator privileges to use Set-NetLbfoTeamNic.

Parameters

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

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

-Default <SwitchParameter>

Indicates that the team interface should be restored to Default mode.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the object which contains the team interface 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 interface to modify.

Aliases

ifAlias,InterfaceAlias

Required?

false

Position

1

Default value

None

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.

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 for which to modify the team interface.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TeamOfTheTeamNic <CimInstance>

Specifies the network adapter team object whose team interfaces 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

-VlanID <UInt32>

Specifies the VLAN ID of the team interface to modify.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

None

Notes

None

Examples

Example 1: Set the VLAN ID

This command modifies the current VLAN ID of the team interface named “Team1 – VLAN 42” to the specified VLAN ID 15.

PS C:\>Set-NetLbfoTeamNIC -Name "Team1 – VlanID 42"   -VlanID   15

Example 2: Set the VLAN ID of the primary interface to 5, and then revert it to default

This command sets the VLAN ID of the primary team interface named Team1 to 5.

PS C:\> Set-NetLbfoTeamNic -Name Team1 -VlanID 5

This command changes the primary team interface, “Team1 – VLAN 5” to default mode.
PS C:\> Set-NetLbfoTeamNic –Name "Team1 – VLAN 5" –Default

Online Version
Add-NetLbfoTeamNic
Get-NetLbfoTeamNic
Remove-NetLbfoTeamNic