Rename-NetLbfoTeam
Rename-NetLbfoTeam
Renames a NIC team.
Syntax
Parameter Set: Rename1
Rename-NetLbfoTeam [-Name] <String> [-NewName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Rename-NetLbfoTeam cmdlet renames the specified NIC team to the specified new name. Also updates the team interface names accordingly, if they use default values.
You need administrator privileges to use Rename-NetLbfoTeam.
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 |
-Name<String>
Specifies the name of the NIC team to rename.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies the new name of the NIC team.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
<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.
MSFT_NetLbfoTeam
If the PassThru parameter is specified, this cmdlet produces newly renamed team object. If the PassThru parameter is not specified, there is no output.
Examples
Example 1: Rename a team
This command renames the team named Team1 to TeamA.
PS C:\> Rename -NetLbfoTeam -Name Team1 -NewName TeamA