< Back
Rename-NetLbfoTeam
Post
NAME Rename-NetLbfoTeam
SYNOPSIS
Renames a NIC team.
SYNTAX
Rename-NetLbfoTeam [-Name] <String> [-NewName] <String> [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm]
[-WhatIf] [<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 need administrator privileges to use Rename-NetLbfoTeam.
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Specifies the name of the NIC team to rename.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NewName <String>
Specifies the new name of the NIC team.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
Example 1: Rename a team
PS C:\\> Rename -NetLbfoTeam -Name Team1 -NewName TeamA
This command renames the team named Team1 to TeamA.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294343
New-NetLbfoTeam
Get-NetLbfoTeam
Set-NetLbfoTeam
Remove-NetLbfoTeam
SYNOPSIS
Renames a NIC team.
SYNTAX
Rename-NetLbfoTeam [-Name] <String> [-NewName] <String> [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm]
[-WhatIf] [<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 need administrator privileges to use Rename-NetLbfoTeam.
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Specifies the name of the NIC team to rename.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NewName <String>
Specifies the new name of the NIC team.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
Example 1: Rename a team
PS C:\\> Rename -NetLbfoTeam -Name Team1 -NewName TeamA
This command renames the team named Team1 to TeamA.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?linkid=294343
New-NetLbfoTeam
Get-NetLbfoTeam
Set-NetLbfoTeam
Remove-NetLbfoTeam