Remove-NlbClusterVip
Removes a virtual IP address from a Network Load Balancing (NLB) cluster.
Syntax
Remove-NlbClusterVip
[-PassThru]
[-Force]
[-HostName <String>]
[-InterfaceName <String>]
[-IP] <IPAddress>
[<CommonParameters>]
Remove-NlbClusterVip
-InputObject <ClusterVip[]>
[-PassThru]
[-Force]
[<CommonParameters>]
Description
The Remove-NlbClusterVIP cmdlet removes a virtual IP address from a Network Load Balancing (NLB) cluster. Once a virtual IP address is removed, the cluster will not be accessible through this IP address.
This cmdlet 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.
ps_nlbc_checkstate_remark
Examples
EXAMPLE 1
PS C:\>Get-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4 | Remove-NlbClusterVip -Force
This example removes the virtual IP address from the NLB cluster without seeking user confirmation.
Parameters
-Force
Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.
Type: | SwitchParameter |
Aliases: | F |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Aliases: | Host, HN, H |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the cluster virtual IP address to remove.
Type: | ClusterVip[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Aliases: | Interface, IN, I |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IP
Specifies the IP address for the cluster from which the virtual IP address will be removed.
Type: | IPAddress |
Position: | 0 |
Default value: | None |
Required: | True |
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.
Type: | SwitchParameter |
Aliases: | Pass |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip
Outputs
Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for