Set-NetLbfoTeamNic
Set-NetLbfoTeamNic
Sets a new VLAN id on a team interface, or restores the interface to Default mode.
Syntax
Parameter Set: ByNameOrTeam
Set-NetLbfoTeamNic [[-Name] <String[]> ] [[-Team] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-Default] [-PassThru] [-ThrottleLimit <Int32> ] [-VlanID <UInt32> ] [ <CommonParameters>]
Parameter Set: __cmdletization_InputObject
Set-NetLbfoTeamNic -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Default] [-PassThru] [-ThrottleLimit <Int32> ] [-VlanID <UInt32> ] [ <CommonParameters>]
Parameter Set: ByTeamOfTheTeamNic
Set-NetLbfoTeamNic [-AsJob] [-CimSession <CimSession[]> ] [-Default] [-PassThru] [-TeamOfTheTeamNic <CimInstance> ] [-ThrottleLimit <Int32> ] [-VlanID <UInt32> ] [ <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
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Default
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 |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-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 for which to modify the team interface.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.
None
By default, this cmdlet produces no output.
If the PassThru parameter is specified, the cmdlet returns the newly modified MSFT_NetLbfoTeamNic object.
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