Edit

Rename-NetSwitchTeam

  • Reference
Module:
NetSwitchTeam

Changes the name of a switch team.

Syntax

Rename-NetSwitchTeam
      [-Name] <String>
      [-NewName] <String>
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]

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.

Examples

EXAMPLE 1

PS C:\>Rename-NetSwitchTeam -Name "MyTeam1" -NewName "SwitchTeam1"

This example renames the switch team named MyTeam1 to the new name SwitchTeam1.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NewName

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.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

None