Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-NlbClusterVip

Remove-NlbClusterVip

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Removes a virtual IP address from a Network Load Balancing (NLB) cluster.

Syntax

Remove-NlbClusterVip [-IP] [-Force] [-HostName] [-InterfaceName] [-PassThru] [<CommonParameters>]

Remove-NlbClusterVip [-Force] [-PassThru] [-InputObject] [<CommonParameters>]

Detailed 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.

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>

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

Aliases

F

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

Host,HN,H

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IP <IPAddress>

Specifies the IP address for the cluster from which the virtual IP address will be removed.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <ClusterVip[]>

Specifies the cluster virtual IP address 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

Interface,IN,I

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Pass

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

Notes

None

Examples

EXAMPLE 1

This example removes the virtual IP address from the NLB cluster without seeking user confirmation.

PS C:\>Get-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4 | Remove-NlbClusterVip -Force

Online Version
Add-NlbClusterVip
Get-NlbClusterVip
Set-NlbClusterVip