This is an archive version of the document. To get the most up-to-date information, see the current version.

Invoke-LoadBalance

Forces monitoring load balancing across available Collectors.

Applies to versions: 8.0, 9.0, 9a

Syntax

Invoke-LoadBalance [-MonitoringGroup] <String[]> [-Force] [-WhatIf] [-Confirm] [-VESServer <Object>] [<CommonParameters>]

Detailed Description

This cmdlet forces monitoring load balancing across available Collectors for the specified monitoring groups.

Load-balancing relocates monitoring jobs across all available Collectors within the monitoring group to equalize the monitoring load on each Collector. Jobs are balanced only within the group.

Note

Load-balancing can entail a monitoring outage of several collection intervals (for those monitoring jobs which have moved) while the VMware topology rebuilds.

Parameters

-MonitoringGroup <String[]>

Specifies the list of monitoring groups for which load-balancing should be performed.

-MonitoringGroup <String[]>

Description

Aliases

Required?

True

Position?

1

Default Value

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

False

-Force

Specifies whether the confirmation dialog should be suppressed. If the parameter is not specified, the cmdlet will prompt you to confirm the load balancing.

-Force

Description

Aliases

Required?

False

Position?

Named

Default Value

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

-VESServer

Specifies the Virtualization Extensions server. You can pass the following types of values:

  • Name of a machine (remote or local) where the Virtualization Extensions Service runs.

Acceptable formats for the input value are: server name (such as "localhost" or "."), IP address (such as "172.15.19.6") and FQDN (such as "localhost.veeam.local").

For more information, type “get-help about_VESServerParameter”.

-VESServer

Description

Aliases

Required?

False

Position?

Named

Default Value

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see Microsoft Docs.

Notes

If the -VESServer parameter is not specified, the cmdlet will connect to the Virtualization Extensions Service on the local machine.

Input

The cmdlet accepts the following types of values for the -MonitoringGroup parameter:

  • System.String (you can pass monitoring group names, the name value is used exactly as it is typed)
  • Veeam.Psves.MonitoringGroup (you can pass monitoring group objects)

Output

The cmdlet does not return any output.

Example 1

This command reallocates monitoring jobs within the Default Monitoring Group.

Invoke-LoadBalance -MonitoringGroup “Default Monitoring Group”

-OR-

Invoke-LoadBalance “Default Monitoring Group”

Example 2

This command reallocates monitoring jobs within the “mongroup1” and “mongroup2”.

Invoke-LoadBalance mongroup1, mongroup2

Example 3

This command balances monitoring load for all monitoring groups.

Get-MonitoringGroup | Invoke-LoadBalance