Edit

Rename-NetLbfoTeam

  • Reference
Module:
NetLbfo

Renames a NIC team.

Syntax

Rename-NetLbfoTeam
      [-Name] <String>
      [-NewName] <String>
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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 must have administrator rights to run Rename-NetLbfoTeam.

Examples

Example 1: Rename a team

PS C:\> Rename -NetLbfoTeam -Name "Team1" -NewName "TeamA"

This command renames the team named Team1 to TeamA.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the NIC team to rename.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-NewName

Specifies the new name of the NIC team.

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

This cmdlet takes no input objects.

Outputs

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.