Edit

Share via

Remove-NlbCluster

  • Reference
Module:
NetworkLoadBalancingClusters

Removes a NLB cluster.

Syntax

PowerShell 
Remove-NlbCluster
      [-PassThru]
      [[-HostName] <String>]
      [[-InterfaceName] <String>]
      [-Force]
      [<CommonParameters>]
PowerShell 
Remove-NlbCluster
      -InputObject <Cluster[]>
      [-PassThru]
      [[-HostName] <String>]
      [-Force]
      [<CommonParameters>]

Description

The Remove-NlbCluster cmdlet removes a Network Load Balancing (NLB) cluster. When the cluster is removed, all existing connections to the hosts in the cluster are lost and the cluster will no longer exist.

Examples

Example 1: Remove an NLB cluster with confirmation

PowerShell 
PS C:\>Remove-NlbCluster

This command removes the NLB cluster after asking for user confirmation.

Example 2: Remove an NLB cluster without confirmation

PowerShell 
PS C:\>Remove-NlbCluster -Force

This command removes the NLB cluster. Because the Force parameter is used, the cmdlet does not ask for user confirmation.

Parameters

-Force

Forces the command to run without asking for user confirmation.

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

-HostName

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or a value of . is entered, then the local cluster is assumed.

Type:String
Aliases:Host, HN, H
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies an array of clusters that this cmdlet removes.

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

-InterfaceName

Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.

Type:String
Aliases:Interface, IN, I
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Passthru By default, this cmdlet does not generate any output.

To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are also supported.

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

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

None or Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster