Network Load Balancing cmdlets in Windows PowerShell

This reference provides cmdlet descriptions and syntax for all Network Load Balancing-specific cmdlets in Windows PowerShell in Windows Server® 2008 R2. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

The Windows PowerShell cmdlets provide an alternative interface for actions that you might otherwise perform with command-line commands or the Network Load Balancing Manager snap-in. For more information about using Windows PowerShell, see "Additional references," later in this topic.

Network Load Balancing cmdlets

Cmdlet name Cmdlet use

Add-NlbClusterNode

Adds a new node to the NLB cluster.

Add-NlbClusterNodeDip

Adds a dedicated IP address to an NLB cluster.

Add-NlbClusterPortRule

Adds a new port rule to an NLB cluster.

Add-NlbClusterVip

Adds a virtual IP address to an NLB cluster.

Disable-NlbClusterPortRule

Disables a port rule on an NLB cluster or on a specific host in the cluster.

Enable-NlbClusterPortRule

Enables a port rule on an NLB cluster or on a specific node in the cluster.

Get-NlbCluster

Retrieves information about the NLB cluster object that is queried by the caller.

Get-NlbClusterDriverInfo

Retrieves information about the NLB driver on the local machine.

Get-NlbClusterNode

Retrieves information about the NLB cluster object that is queried by the caller.

Get-NlbClusterNodeDip

Retrieves the dedicated IP address that is queried by the caller.

Get-NlbClusterNodeNetworkInterface

Retrieves information about interfaces, including information about the NLB driver, on a host.

Get-NlbClusterPortRule

Retrieves the port rule objects that are queried by the caller.

Get-NlbClusterVip

Retrieves virtual IP addresses that are queried by the caller.

New-NlbCluster

Creates an NLB cluster on the specified interface that is defined by the node and network adapter name.

New-NlbClusterIpv6Address

Generates IPv6 addresses to create cluster virtual IP addresses or node dedicated IP addresses

Remove-NlbCluster

Deletes an NLB cluster.

Remove-NlbClusterNode

Removes a node from the NLB cluster.

Remove-NlbClusterNodeDip

Removes a dedicate IP address from an NLB cluster.

Remove-NlbClusterPortRule

Removes a port rule from an NLB cluster.

Remove-NlbClusterVip

Removes a virtual IP address from an NLB cluster.

Resume-NlbCluster

Resumes all nodes in an NLB cluster.

Resume-NlbClusterNode

Resumes the node in an NLB cluster that was suspended.

Set-NlbCluster

Edits the configuration of an NLB cluster.

Set-NlbClusterNode

Edits the NLB cluster node settings.

Set-NlbClusterNodeDip

Edits the dedicated IP address of an NLB cluster.

Set-NlbClusterPortRule

Edits the port rules for an NLB cluster.

Set-NlbClusterPortRuleNodeHandlingPriority

Sets the host priority of a port rule for a specific NLB node.

Set-NlbClusterPortRuleNodeWeight

Sets the load weight of a port rule for a specific NLB node.

Set-NlbClusterVip

Edits the virtual IP address of an NLB cluster.

Start-NlbCluster

Starts all nodes in an NLB cluster.

Start-NlbClusterNode

Starts an NLB cluster node.

Stop-NlbCluster

Stops all nodes of an NLB cluster.

Stop-NlbClusterNode

Stops a node in an NLB cluster.

Suspend-NlbCluster

Suspends all nodes of an NLB cluster.

Suspend-NlbClusterNode

Suspends a specific node in an NLB cluster.

Additional references