Edit

Remove-NetLbfoTeam

  • Reference
Module:
NetLbfo

Removes the specified NIC team from the host.

Syntax

Remove-NetLbfoTeam
      [-Name] <String[]>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-NetLbfoTeam
      -InputObject <CimInstance[]>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<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.

Examples

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.

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
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

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

-Name

Specifies the name of the NIC team to remove.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
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

-WhatIf

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

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

Inputs

None

This cmdlet takes no input objects.

Outputs

None

By default, this cmdlet produces no output.