Skip to content

Latest commit

 

History

History
124 lines (82 loc) · 3.51 KB

start-taskschedule.md

File metadata and controls

124 lines (82 loc) · 3.51 KB
Raw

Start-TaskSchedule

Executes a task schedule.

Syntax

Start-TaskSchedule -Schedule <ScheduleItem>

Start-TaskSchedule [-Item] <Item>

Start-TaskSchedule [-Path] <String>

Start-TaskSchedule -Id <String> [-Database <String>]

Detailed Description

Executes a task schedule either passed from Get-Schedule, based on Item or Schedule path.

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Schedule <ScheduleItem>

ScheduleItem most conveniently obtained from Get-Schedule command.

Aliases
Required? true
Position? named
Default Value
Accept Pipeline Input? true (ByValue, ByPropertyName)
Accept Wildcard Characters? false

-Item <Item>

Schedule item - if Item is of wrong template - an appropriate error will be written to teh host.

Aliases
Required? true
Position? 1
Default Value
Accept Pipeline Input? true (ByValue, ByPropertyName)
Accept Wildcard Characters? false

-Path <String>

Path to the schedule item - if item is of wrong template - an appropriate error will be written to teh host.

Aliases
Required? true
Position? 1
Default Value
Accept Pipeline Input? false
Accept Wildcard Characters? false

-Id <String>

Aliases
Required? true
Position? named
Default Value
Accept Pipeline Input? false
Accept Wildcard Characters? false

-Database <String>

Aliases
Required? false
Position? named
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.Tasks.ScheduleItem

    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

PS master:\> Start-TaskSchedule -Path "master:/system/Tasks/Schedules/Email Campaign/Clean Message History"

Name                             Database        Active   Auto Remove  Is Due   Expired  Completed    Last Run               Next Run
----                             --------        ------   -----------  ------   -------  ---------    --------               --------
Clean Message History            master          True     False        False    False    False        2014-07-29 16:22:49    2014-07-30 04:52:49

EXAMPLE 2

PS master:\> Get-TaskSchedule -Name "Check Bounced Messages" -Database "master" | Start-TaskSchedule

Name                             Database        Active   Auto Remove  Is Due   Expired  Completed    Last Run               Next Run
----                             --------        ------   -----------  ------   -------  ---------    --------               --------
Check Bounced Messages           master          True     False        False    False    False        2014-07-29 16:21:33    2014-07-30 04:51:33

Related Topics