Remove-NlbClusterVip
Remove-NlbClusterVip
Removes a virtual IP address from an NLB cluster.
Syntax
Remove-NlbClusterVIP [-IP] <IPAddress> [-HostName <string>] [-InterfaceName <string>] [-Force] [-PassThru] [<CommonParameters>]
Remove-NlbClusterVIP -InputObject <ClusterVip[]> [-Force] [-PassThru] [<CommonParameters>]
Detailed Description
The Remove-NlbClusterVIP cmdlet removes a virtual IP address from an NLB cluster. Once a virtual IP address is removed, the cluster will not be accessible through this IP address.
This operation changes the configuration on all cluster nodes. As a result, the NLB cluster will have to restart the convergence process on all nodes to guarantee that configuration changes have been applied on all nodes and that a consistent state is reached. Any additional operations on the NLB cluster should not be initiated until all cluster nodes have completed the convergence process and are back to the converged state. To check the state of all cluster nodes, use the Get-NlbClusterNode cmdlet. If a configuration change results in the cluster nodes remaining in perpetual convergence, refer to the event log to resolve the configuration inconsistency between the cluster nodes.
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? |
named |
-InputObject <ClusterVip[]>
Specifies the cluster virtual IP address 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? |
named |
-IP <IPAddress>
Specifies the IP address for the cluster from which the virtual IP address will be removed.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-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? |
true (ByPropertyName) |
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>
Get-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4 | Remove-NlbClusterVip -Force
Description
-----------
This cluster removes the virtual IP address from the NLB cluster without seeking user confirmation.