Help Center
Choose product document...
Veeam Management Pack 8.0 Update 5 for System Center
Veeam MP VEShell Reference

Move-Collector

Moves the Collector from one monitoring group to another.

Applies to versions: 6.0, 6.5, 7.0, 8.0

Syntax

Move-Collector [-CollectorId <String>] -[NewMonitoringGroup] <String> [-VESServer <Object>] [<CommonParameters>]

Detailed Description

This cmdlet moves the specified Collector from one monitoring group to another.

Move-Collector Note:

When you move a Collector that has monitoring jobs assigned, mind the following restriction: you cannot break monitoring jobs of a split cluster across different monitoring groups. Monitoring jobs associated with a single vSphere cluster can only belong to the same monitoring group. If you want to assign cluster jobs to a Collector in another monitoring group, you should move all cluster jobs at once.

Parameters

-CollectorId <String>

Defines the Id of the Collector that you want to move.

Move-Collector Tip:

To get the list of registered Collectors, their Ids and names, use the Get-Collector cmdlet.

 

Description

Aliases

 

Required?

True

Position?

1

Default Value

 

Accept Pipeline Input?

True (ByValue, ByPropertyValue)

Accept Wildcard Characters?

False

-NewMonitoringGroup <String>

Defines the name of the monitoring group to which you want to move the Collector.

Description

Aliases

 

Required?

False

Position?

2

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

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  http://go.microsoft.com/fwlink/p/?LinkID=113216.

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 -CollectorId parameter:

  • System.String (you can pass Collector Ids, the Id value is used exactly as it is typed)
  • Veeam.Psves.Collector (you can pass Collector objects)

Output

If an error occurs when moving a Collector, the cmdlet will return a list of Veeam.PsVes.MoveCollectorJobRescription objects. These objects describe the reason for the failure.

Example

The following command moves the specified Collector to the monitoring group named "Seattle".

Move-Collector -CollectorId 1234abc5-6d78-9e11-fgh-98765i54321j -GroupName Seattle

Veeam Large Logo

Veeam MP for VMware User Guides

Veeam MP for VMware Reference

Veeam MP for VMware Online Knowledge Base

Veeam MP for Microsoft Hyper-V User Guide

Veeam MP for Hyper-V Reference

MP for Veeam Backup & Replication User Guide

MP for Veeam Backup & Replication Reference

Veeam Capacity Planning for Hybrid Clouds User Guide

Veeam MP Report Knowledge

Veeam MP VEShell Reference

Veeam MP Resource Kit Guide