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
 

Rename-NetSwitchTeam

Rename-NetSwitchTeam

msft_netswitchteam.cdxml

Synopsis

Changes the name of a switch team.

Syntax

Rename-NetSwitchTeam [-Name] [-NewName] [-AsJob] [-CimSession] [-ThrottleLimit] [<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 <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

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

Input Type

None

Return Type

None

Notes

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"

Online Version
Get-NetSwitchTeam
New-NetSwitchTeam
Remove-NetSwitchTeam