Get-TaskSchedule
Returns one or more task schedule items using the specified criteria.

Syntax

Get-TaskSchedule -Item <Item>
Get-TaskSchedule -Path <String>
Get-TaskSchedule [[-Database] <Database>] [[-Name] <String>]

Detailed Description

The Get-TaskSchedule command returns one or more task schedule items, based on name/database filter, path or simply converting a Sitecore item.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Item <Item>

Task item to be converted.
Aliases
Text
Required?
true
Position?
named
Default Value
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false

-Path <String>

Path to the item to be returned as Task Schedule.
Aliases
Text
Required?
true
Position?
named
Default Value
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false

-Database <Database>

Database containing the task items to be returned. If not provided all databases will be considered for filtering using the "Name" parameter.
Aliases
Text
Required?
false
Position?
2
Default Value
Accept Pipeline Input?
true (ByValue)
Accept Wildcard Characters?
false

-Name <String>

Task filter - supports wildcards. Works with "Database" parameter to narrow tassk to only single database.
Aliases
Text
Required?
false
Position?
1
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.
  • Sitecore.Data.Items.Item

Outputs

The output type is the type of the objects that the cmdlet emits.
  • Sitecore.Tasks.ScheduleItem

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE 1

1
PS master:\> Get-TaskSchedule
2
Name Database Active Auto Remove Is Due Expired Completed Last Run Next Run
3
---- -------- ------ ----------- ------ ------- --------- -------- --------
4
__Task Schedule master True False True False False 0001-01-01 00:00:00 0001-01-01 00:00:00
5
Check Bounced Messages master True False False False False 2014-07-29 10:18:43 2014-07-29 22:48:43
6
Check DSN Messages master True False False False False 2014-07-29 10:19:18 2014-07-29 22:49:18
7
Clean Confirmation IDs master True False False False False 2014-07-28 22:14:30 2014-07-31 02:14:30
8
Clean Message History master True False False False False 2014-07-29 10:19:18 2014-07-29 22:49:18
9
Close Outdated Connections master True False False False False 2014-07-29 12:30:22 2014-07-29 13:30:22
10
Test-PowerShell master True False False False False 2014-07-28 14:30:06 2014-08-01 17:32:07
11
__Task Schedule web True False True False False 0001-01-01 00:00:00 0001-01-01 00:00:00
12
Check Bounced Messages web True False True False False 2013-11-04 08:36:22 2013-11-04 21:06:22
13
Check DSN Messages web True False True False False 2013-11-04 08:36:22 2013-11-04 21:06:22
14
Clean Confirmation IDs web True False False False False 2013-11-04 08:36:22 2013-11-04 21:36:22
15
Clean Message History web True False True False False 2013-11-04 08:36:22 2013-11-04 21:06:22
16
Close Outdated Connections web True False True False False 2013-11-04 09:36:23 2013-11-04 10:36:23
17
Test-PowerShell web True False True False False 2013-11-04 09:46:29 2013-11-04 09:46:30
Copied!

EXAMPLE 2

1
PS master:\> Get-TaskSchedule -Name "*Check*"
2
Name Database Active Auto Remove Is Due Expired Completed Last Run Next Run
3
---- -------- ------ ----------- ------ ------- --------- -------- --------
4
Check Bounced Messages master True False False False False 2014-07-29 10:18:43 2014-07-29 22:48:43
5
Check DSN Messages master True False False False False 2014-07-29 10:19:18 2014-07-29 22:49:18
6
Check Bounced Messages web True False True False False 2013-11-04 08:36:22 2013-11-04 21:06:22
7
Check DSN Messages web True False True False False 2013-11-04 08:36:22 2013-11-04 21:06:22
Copied!

EXAMPLE 3

1
PS master:\> Get-TaskSchedule -Name "*Check*" -Database "master"
2
Name Database Active Auto Remove Is Due Expired Completed Last Run Next Run
3
---- -------- ------ ----------- ------ ------- --------- -------- --------
4
Check Bounced Messages master True False False False False 2014-07-29 10:18:43 2014-07-29 22:48:43
5
Check DSN Messages master True False False False False 2014-07-29 10:19:18 2014-07-29 22:49:18
Copied!

Related Topics