Test-SCLoadBalancer

Tests a load balancer.

Description

The Test-SCLoadBalancer cmdlet runs tests against a load balancer and returns the results to the user.

For more information about Test-SCLoadBalancer, type: "Get-Help Test-SCLoadBalancer -online".

Parameters

LoadBalancerAddress

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0 
Specifies the fully qualified domain name (FQDN) or IP address of a load balancer. Usual formats are FQDN, IPv4 or IPv6 addresses, but check with the load balancer manufacturer for the valid format for your load balancer.

ConfigurationProvider

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a configuration provider object. A configuration provider is a plug-in to VMM that translates VMM PowerShell commands to API calls that are specific to a type of load balancer. If no configuration provider is specified, VMM uses the Manufacturer and Model information to choose an available configuration provider. If no configuration provider is found, the load balancer will not be added.

Port

Required? true
Accept Pipeline Input? false
Position? named 
Specifies the network port to use when adding an object or creating a connection. Valid values are: 1 to 4095.

RunAsAccount

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a Run As account that contains credentials with permission to perform this action.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

Examples

1: Test a specified load balancer. 
PS C:\> $ConfigProvider = Get-SCConfigurationProvider | where { $_.Type -eq "LoadBalancer" -and $_.Manufacturer -eq "LBManufacturer" -and $_.Model -eq "LB01"}
PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "LBRunAsAcct"
PS C:\> Test-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com" -Port 123 -ConfigurationProvider $ConfigProvider -RunAsAccount $RunAsAccount

The first command gets the configuration provider object for the manufacturer LBManufacturer and model LB01, and stores the object in the $ConfigProvider variable.

The second command gets the Run As account named LBRunAsAccount and stores the object in the $RunAsAccount variable.

The last command tests the load balancer with the address LB01.Contoso.com, using providing the Run As account stored in $RunAsAccount as credentials to run the tests. The command then displays the results to the user.

See Also