Remove-NlbCluster
Remove-NlbCluster
Deletes an NLB cluster.
Syntax
Remove-NlbCluster [[-InterfaceName] <string>] [[-HostName] <string>] [-Force] [-PassThru] [<CommonParameters>]
Remove-NlbCluster -InputObject <Cluster[]> [[-HostName] <string>] [-Force] [-PassThru] [<CommonParameters>]
Detailed Description
The Remove-NlbCluster cmdlet deletes an 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 <SwitchParameter>
Performs the operation without prompting for confirmation. By default, this operation will seek confirmation from the user before proceeding.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-HostName <string>
Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-InputObject <Cluster[]>
Specifies the cluster to remove.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
named |
-InterfaceName <string>
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
2 |
-PassThru <SwitchParameter>
Causes the cmdlet to pass the object through to the pipeline.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Examples
EXAMPLE 1
C:\PS>
Remove-NlbCluster
Description
-----------
This command removes the NLB cluster after asking for user confirmation.
EXAMPLE 2
C:\PS>
Remove-NlbCluster -Force
Description
-----------
This command removes the NLB cluster without asking for user confirmation.
See Also
Reference
Get-NlbCluster
New-NlbCluster
Resume-NlbCluster
Set-NlbCluster
Start-NlbCluster
Stop-NlbCluster
Suspend-NlbCluster