Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-NlbCluster

Last Updated: 3/31/2017

SYNOPSIS

Removes a NLB cluster.

SYNTAX

NonPipeline (Default)

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

Pipeline

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

PS C:\>Remove-NlbCluster

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

Example 2: Remove an NLB cluster without confirmation

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
Parameter Sets: (All)
Aliases: F

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: Host, HN, H

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

-InputObject

Specifies an array of clusters that this cmdlet removes.

Type: Cluster[]
Parameter Sets: Pipeline
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Parameter Sets: NonPipeline
Aliases: Interface, IN, I

Required: False
Position: 1
Default value: None
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
Parameter Sets: (All)
Aliases: Pass

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

OUTPUTS

None or Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

NOTES

Get-NlbCluster

New-NlbCluster

Resume-NlbCluster

Set-NlbCluster

Start-NlbCluster

Stop-NlbCluster

Suspend-NlbCluster

© 2017 Microsoft