Rename-NetSwitchTeam
Rename-NetSwitchTeam
Changes the name of a switch team.
Syntax
Parameter Set: Rename1
Rename-NetSwitchTeam [-Name] <String> [-NewName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Rename-NetSwitchTeam cmdlet changes the name of a switch team. Only the name of a switch team can be changed using this cmdlet.
The current switch team name may contain wildcard characters, as long as the wildcard mask resolves to a single switch team.
The new switch team name must not match an existing switch team name.
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 current name of switch team to rename. Wildcard characters may be used to specify the current switch team name, as long as the wildcard mask resolves to a single switch team. The wildcard mask must not resolve to one than one switch team name.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies the new name to give to the switch team. The new name must not already exist. The new name cannot be an existing switch team or Load-Balancing/Fail-Over (LBFO) team name.
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
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example renames the switch team named MyTeam1 to the new name SwitchTeam1.
PS C:\> Rename-NetSwitchTeam -Name "MyTeam1" -NewName "SwitchTeam1"