< Back

Remove-NetLbfoTeam

Tue Jan 29, 2019 10:26 pm

NAME Remove-NetLbfoTeam



SYNOPSIS

Removes the specified NIC team from the host.





SYNTAX

Remove-NetLbfoTeam [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -InputObject <CimInstance[]> [-Confirm] [-WhatIf]

[<CommonParameters>]



Remove-NetLbfoTeam [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Remove-NetLbfoTeam cmdlet removes the specified NIC team from the host. This cmdlet disconnects all associated team members and providers from

the team. You can specify the team to remove by using either a team object retrieved by Get-NetLbfoTeam, or by specifying a team name.



You can use Remove-NetLbfoTeam to remove all NIC teams from the server.



You need administrator privileges to use Remove-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



-InputObject <CimInstance[]>

Specifies the team object which contains the NIC team to remove.



Required? true

Position? named

Default value

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String[]>

Specifies the name of the NIC team to remove.



Required? true

Position? 1

Default value

Accept pipeline input? True (ByPropertyName)

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

None



By default, this cmdlet produces no output.





Example 1: Remove a team



PS C:\\> Remove-NetLbfoTeam -Name Team1



This command removes the team named Team1.

Example 2: Remove a team using a team object



PS C:\\> $team = Get-NetLbfoTeam -Name Team1

PS C:\\> Remove-NetLbfoTeam -InputObject $team



This set of commands retrieves a team object into a variable $team using Get-NetLbfoTeam, and then passes the variable to Remove-NetLbfoTeam.

Example 3: Remove all teams from the server



PS C:\\> Get-NetLbfoTeam | Remove-NetLbfoTeam



This command retrieves all the teams from the server using Get-NetLbfoTeam cmdlet and then sends all the retrieved teams to Remove-NetLbfoTeam

which removes the teams.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?linkid=294340

New-NetLbfoTeam

Get-NetLbfoTeam

Set-NetLbfoTeam

Rename-NetLbfoTeam