> For the complete documentation index, see [llms.txt](https://docs.cipp.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cipp.app/user-documentation/tools/scheduler.md). # Scheduler The task scheduler runs CIPP functionality on a schedule and delivers the results to your PSA, a webhook, or email. Tasks can run once, or repeat every day, 7 days, 30 days, or year. {% hint style="warning" %} Scheduling a task in the past makes it run at the next interval the scheduler runs. {% endhint %} The scheduler operates on 15-minute intervals, and no other cadence is available. A task created through the API for 10:10 runs at 10:15. A recurring task returns to a planned state immediately after it executes. ## Action Buttons
Show System Jobs Reveals the tasks CIPP schedules for itself alongside your own and becomes **Hide System Jobs** once shown. These are hidden by default because they are numerous and rarely need attention.
Add Task Opens the **Add Task** drawer, which builds a scheduled task without leaving this page. The same drawer is reused for **Edit Job** and **Clone Job**, retitled accordingly. Every task needs a tenant, a name, and a command. The rest depends on which of the two task types you pick. | Field | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | Select a Tenant | The tenant the task runs against. All Tenants and tenant groups are both selectable, so one task can cover a whole estate. | | Task Name | The name the task appears under in the table. | | Post Execution Actions | Where the results go once the task has run. Choose any combination of Webhook, Email, and PSA, or none to leave the results on the task itself. | | PSA Ticket Strategy | How many tickets the task raises. Only shown once PSA is among the post execution actions. | | Reference | An optional note identifying the task. It is also added to the title of any notification the task sends, which makes it useful for routing in a PSA. | **PSA Ticket Strategy** overrides the HaloPSA **Link Tickets to affected Users** toggle for this task alone, which is useful for a task with a wide result set, such as a list of users without MFA, where the number of tickets raised matters. | Option | Description | | ---------------------------------- | ------------------------------------------------------------- | | One ticket per affected user | Raises a separate ticket for each user in the task's results. | | One consolidated ticket per tenant | Raises a single ticket per tenant listing every result. | Whichever option matches the current HaloPSA integration setting is labelled as the integration default, so you can see what the task would do before changing it. {% hint style="info" %} The field always holds one of the two options rather than an inherited setting. Selecting PSA and saving therefore fixes a strategy on the task even if you never opened the dropdown, and that strategy stays with the task afterwards regardless of how the integration setting is later changed. {% endhint %} A pair of buttons then selects the task type: **Scheduled Task** runs on a clock. A **Schedule Configuration** section asks for a **Start Date** and a **Recurrence** of Once, or every 1, 7, 14, 21, 30, or 365 days. The recurrence field also accepts a value you type yourself for intervals outside that list. **Triggered Task** runs in response to a change in the tenant rather than on a fixed schedule. A **Trigger Configuration** section defines what to watch: | Field | Description | | ---------------------------- | --------------------------------------------------------------------------------------------------------- | | Trigger Type | The kind of trigger. Delta Query is currently the only option, which watches Microsoft Graph for changes. | | Resource Type | What to watch, such as Users, Groups, Devices, Applications, Service Principals, or Directory Roles. | | Event Type | Which change fires the task: Resource Created, Resource Updated, or Resource Deleted. | | Filter Specific Resources | Optional conditions narrowing which resources count, each a property, an operator, and a value. | | Attributes to Monitor | Restricts an update trigger to changes affecting particular attributes. | | Execute Command Per Resource | Runs the command once for each matching resource rather than once for the batch. | | Execution Mode | How the command is executed against the matched resources. | | Check Frequency | How often CIPP checks for changes: every 15 or 30 minutes, or every 1, 4, 12, or 24 hours. | Both task types then share a **Command & Parameters** section. Choose a command from the list, and the drawer renders the fields that command takes so you can fill them in directly. A refresh control beside the picker re-reads the available commands. Where a command takes something the form cannot render, **Use advanced parameters** replaces the generated fields with an **Advanced Parameters (JSON Input)** box for supplying the parameters as JSON. Each section shows a one-line summary of its current settings in its header, so a collapsed drawer still reads as a complete description of the task.
## Table Details Preset filters above the table narrow the list to tasks that are **Running**, **Planned**, **Failed**, or **Completed**. | Column | Description | | -------------- | --------------------------------------------------------------------------------------------- | | Executed Time | The relative time since the task last ran. | | Task State | Whether the task is Planned, Running, Completed, or Failed. | | Tenant | The tenant the task runs against. | | Name | The task's name. | | Scheduled Time | The relative time since the task ran, or until it is next due to run. | | Command | The command the task executes. | | Parameters | The parameters passed to that command. | | Post Execution | Where the results are delivered after the task runs. | | Reference | The reference recorded against the task, used to identify it in logging and delivered output. | | Recurrence | How often the task repeats. | | Results | The results of the most recent execution. | ## Table Actions
ActionDescriptionBulk Action Available
View Task DetailsOpens the full read-only /pages/9IEli4WfY24X5AdGicij page for the task.false
Run NowQueues the task to run at the next quarter hour rather than waiting for its schedule.true
Edit JobOpens the #add-task drawer with the task loaded for editing.true
Clone JobOpens the #add-task drawer with a copy of the task, ready to adjust and save as a new one.true
Delete JobRemoves the task from the schedule.true
More InfoOpens the Extended Info flyout with the full details for the selected row.false
{% hint style="info" %} The actions available depend on your permissions. Viewing task details requires read access to the scheduler; running, editing, cloning, and deleting all require read and write access, and are hidden otherwise. {% endhint %} ## Task Details The flyout shows the full picture for a single task. ### Action Buttons
View Logs Opens a further flyout showing the logbook entries recorded for this task.
Actions The same set of actions available on the table row: Run Now, Edit Job, Clone Job, and Delete Job.
### Sections | Section | Description | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Details | The task's top-level information, including its state, the command being run, and the tenant it targets. A refresh control re-reads the task without reloading the page. | | Trigger Configuration | How and when the task fires. | | Task Parameters | The parameters passed to the task's command. | | Execution Results | The history of the task's executions, with a count of how many entries are shown against the total and a search box for narrowing a long history. | *** ## Feature Requests / Ideas We value your feedback and ideas. Please raise any [feature requests](https://github.com/CyberDrain/CIPP/issues/new?template=feature.yml) on GitHub. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.cipp.app/user-documentation/tools/scheduler.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.