Remove-NlbCluster
Removes a NLB cluster.
Syntax
NonPipeline (Default)
Remove-NlbCluster
[[-HostName] <String>]
[[-InterfaceName] <String>]
[-PassThru]
[-Force]
[<CommonParameters>]
Pipeline
Remove-NlbCluster
[[-HostName] <String>]
-InputObject <Cluster[]>
[-PassThru]
[-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | F |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Host, HN, H |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies an array of clusters that this cmdlet removes.
Parameter properties
| Type: | Cluster[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Pipeline
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InterfaceName
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Interface, IN, I |
Parameter sets
NonPipeline
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Pass |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.