Veeam Management Pack 9.0 for Microsoft System Center
Veeam MP VEShell Reference
Related documents

Get-CollectorJobs

Gets monitoring jobs assigned to the Collector.

Applies to versions: 8.0, 9.0

Syntax

Get-CollectorJobs [-CollectorId] <String> [[-Include] <String[]>] [-VESServer <Object>] [<CommonParameters>]

Detailed Description

This cmdlet retrieves monitoring jobs assigned to the Collector. The cmdlet returns a collection of objects that represent monitoring jobs and store monitoring job details (job name, Collector to which the job is assigned, number of monitored objects and number of sockets used for the job).

Parameters

-CollectorId <String>

Specifies an ID of a Collector for which the list of monitoring jobs should be retrieved.

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, ByPropertyName)

Accept Wildcard Characters?

False

-Include <String[]>

Specifies name(s) of monitoring job(s) that should be retrieved. If the parameter is not specified, the cmdlet will return all monitoring jobs.

Note

This parameter supports wildcards. Search is not case sensitive.

 

Description

Aliases

 

Required?

False

Position?

2

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

True

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

The cmdlet returns a collection of Veeam.Psves.MonitoringJob objects that represent monitoring jobs.

Example 1

This command retrieves all monitoring jobs assigned to the Collector with the specified Id.

Get-CollectorJobs -CollectorId 1234abc5-6d78-9e11-fgh-98765i54321j

Example 2

This command retrieves all monitoring jobs assigned to the “veeamcol1” Collector.

Get-Collector veeamcol1 -SelectByName | Get-CollectorJobs

References

To learn more about supporting wildcard characters in cmdlet parameters, see Microsoft Docs.

This Document Help Center
Veeam MP for VMware User GuidesVeeam MP for VMware ReferenceVeeam MP for VMware Online Knowledge BaseVeeam MP for Microsoft Hyper-V User GuideVeeam MP for Hyper-V ReferenceMP for Veeam Backup & Replication User GuideMP for Veeam Backup & Replication ReferenceVeeam Capacity Planning for Hybrid Clouds User GuideVeeam MP Report KnowledgeVeeam MP VEShell ReferenceVeeam MP Resource Kit GuideVeeam Backup & Replication DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.