Network Load Balancing (NLB) Cmdlets in Windows PowerShell

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Network Load Balancing (NLB) clusters

This reference provides cmdlet descriptions and syntax for all Network Load Balancing (NLB) cluster-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

cmdlet	Description
Add-NlbClusterNode	Adds a new node to the Network Load Balancing (NLB) cluster.
Add-NlbClusterNodeDip	Adds a dedicated IP address to a Network Load Balancing (NLB) cluster.
Add-NlbClusterPortRule	Adds a new port rule to a Network Load Balancing (NLB) cluster.
Add-NlbClusterVip	Adds a virtual IP address to a Network Load Balancing (NLB) cluster.
Disable-NlbClusterPortRule	Disables a port rule on a Network Load Balancing (NLB) cluster or on a specific host in the cluster.
Enable-NlbClusterPortRule	Enables a port rule on a Network Load Balancing (NLB) cluster or on a specific node in the cluster.
Get-NlbCluster	Retrieves information about the Network Load Balancing (NLB) cluster object that is queried by the caller.
Get-NlbClusterDriverInfo	Retrieves information about the Network Load Balancing (NLB) driver on the local machine.
Get-NlbClusterNode	Retrieves information about the Network Load Balancing (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 Network Load Balancing (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 a Network Load Balancing (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 a Network Load Balancing (NLB) cluster.
Remove-NlbClusterNode	Removes a node from the Network Load Balancing (NLB) cluster.
Remove-NlbClusterNodeDip	Removes a dedicate IP address from a Network Load Balancing (NLB) cluster.
Remove-NlbClusterPortRule	Removes a port rule from a Network Load Balancing (NLB) cluster.
Remove-NlbClusterVip	Removes a virtual IP address from a Network Load Balancing (NLB) cluster.
Resume-NlbCluster	Resumes all nodes in a Network Load Balancing (NLB) cluster.
Resume-NlbClusterNode	Resumes the node in a Network Load Balancing (NLB) cluster that was suspended.
Set-NlbCluster	Edits the configuration of a Network Load Balancing (NLB) cluster.
Set-NlbClusterNode	Edits the Network Load Balancing (NLB) cluster node settings.
Set-NlbClusterNodeDip	Edits the dedicated IP address of a Network Load Balancing (NLB) cluster.
Set-NlbClusterPortRule	Edits the port rules for a Network Load Balancing (NLB) cluster.
Set-NlbClusterPortRuleNodeHandlingPriority	Sets the host priority of a port rule for a specific Network Load Balancing (NLB) node.
Set-NlbClusterPortRuleNodeWeight	Sets the load weight of a port rule for a specific Network Load Balancing (NLB) node.
Set-NlbClusterVip	Edits the virtual IP address of a Network Load Balancing (NLB) cluster.
Start-NlbCluster	Starts all nodes in a Network Load Balancing (NLB) cluster.
Start-NlbClusterNode	Starts a Network Load Balancing (NLB) cluster node.
Stop-NlbCluster	Stops all nodes of a Network Load Balancing (NLB) cluster.
Stop-NlbClusterNode	Stops a node in a Network Load Balancing (NLB) cluster.
Suspend-NlbCluster	Suspends all nodes of a Network Load Balancing (NLB) cluster.
Suspend-NlbClusterNode	Suspends a specific node in a Network Load Balancing (NLB) cluster.

Note

To list all the cmdlets that are available, use the Get-Command *-NlbCluster* cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

● Get-Help <cmdlet name> -Detailed
● Get-Help <cmdlet name> -Examples
● Get-Help <cmdlet name> -Full

More Information

For more information about Network Load Balancing, see Network Load Balancing on TechNet.