Get-SPTimerJob
Published: May 12, 2010
Returns timer jobs.
Get-SPTimerJob [[-Identity] <SPTimerJobPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Type <String>] [-WebApplication <SPWebApplicationPipeBind>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
Identity |
Optional |
Microsoft.SharePoint.PowerShell.SPTimerJobPipeBind |
Specifies the timer job to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. |
||
|
AssignmentCollection |
Optional |
Microsoft.SharePoint.PowerShell.SPAssignmentCollection |
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
|
||
|
Type |
Optional |
System.String |
Filters to return timer jobs of a specified type. The type must be a name of a valid timer job type; for example, TimerJob1. |
||
|
WebApplication |
Optional |
Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind |
Filters to return timer jobs defined for the scope of a specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. |
Detailed Description
The Get-SPTimerJob cmdlet reads a specified timer job, timer jobs of a specified type, or timer jobs defined for a specified scope. If no parameters are specified, this cmdlet returns all timer job definitions for the farm.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
|
| Exceptions | Description |
|---|---|
|
|
|
---------------------EXAMPLE---------------------
Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName
This example displays all timer jobs for a specified Web application.
Change History
| Date | Description | Reason |
|---|---|---|
|
May 12, 2010 |
Initial publication |
|

Note: