Share via

Test-SCLoadBalancer

  • Reference
Module:
VirtualMachineManager

Tests a load balancer.

Syntax

Test-SCLoadBalancer
    [-VMMServer <ServerConnection>]
    [-LoadBalancerAddress] <String>
    -Port <UInt16>
    -ConfigurationProvider <ConfigurationProvider>
    -RunAsAccount <RunAsAccount>
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

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

Examples

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

Parameters

-ConfigurationProvider

Specifies a configuration provider object. A configuration provider is a plug-in to Virtual Machine Manager (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 is not added.

Type:ConfigurationProvider
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LoadBalancerAddress

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.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Port

Specifies the network port to use when adding an object or creating a connection. Valid values are: 1 to 4095.

Type:UInt16
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsAccount

Specifies a Run As account that contains credentials with permission to perform this action.

Type:RunAsAccount
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

LoadBalancer

This cmdlet returns a LoadBalancer object.