Remove-NlbCluster

Remove-NlbCluster

Deletes a Network Load Balancing (NLB) cluster.

Syntax

Parameter Set: NonPipeline
Remove-NlbCluster [[-HostName] <String> ] [[-InterfaceName] <String> ] [-Force] [-PassThru] [ <CommonParameters>]

Parameter Set: Pipeline
Remove-NlbCluster [[-HostName] <String> ] -InputObject <Cluster> [-Force] [-PassThru] [ <CommonParameters>]

Detailed Description

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

Parameters

-Force

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HostName<String>

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.

Aliases

hn

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<Cluster>

Specifies the cluster to remove.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-InterfaceName<String>

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

Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Sends items from the interactive window down the pipeline as input to other cmdlets. 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 supported.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None or Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Examples

EXAMPLE 1

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

PS C:\> Remove-NlbCluster

EXAMPLE 2

This example removes the NLB cluster without asking for user confirmation.

PS C:\> Remove-NlbCluster -Force

Get-NlbCluster

New-NlbCluster

Resume-NlbCluster

Set-NlbCluster

Start-NlbCluster

Stop-NlbCluster

Suspend-NlbCluster