# SchedulerShutdown

Shutdown a scheduler by name.

The default will do a graceful shutdown, but if the force argument is set to true, it will force shutdown the scheduler.

If the timeout argument is set, it will wait for the specified amount of time in seconds before forcing the shutdown. The default is 30 seconds.

## Method Signature

```
SchedulerShutdown(name=[string], force=[boolean], timeout=[integer])
```

### Arguments

| Argument  | Type      | Required | Description                                                                                     | Default |
| --------- | --------- | -------- | ----------------------------------------------------------------------------------------------- | ------- |
| `name`    | `string`  | `true`   | The name of the scheduler to shutdown.                                                          |         |
| `force`   | `boolean` | `false`  | If true, will force shutdown the scheduler. Default is false.                                   | `false` |
| `timeout` | `integer` | `false`  | The timeout in seconds to wait for the scheduler to shutdown gracefully. Default is 30 seconds. | `30`    |

## Examples

## Related

* [SchedulerGet](/boxlang-language/reference/built-in-functions/scheduler/schedulerget.md)
* [SchedulerGetAll](/boxlang-language/reference/built-in-functions/scheduler/schedulergetall.md)
* [SchedulerList](/boxlang-language/reference/built-in-functions/scheduler/schedulerlist.md)
* [SchedulerRestart](/boxlang-language/reference/built-in-functions/scheduler/schedulerrestart.md)
* [SchedulerStart](/boxlang-language/reference/built-in-functions/scheduler/schedulerstart.md)
* [SchedulerStats](/boxlang-language/reference/built-in-functions/scheduler/schedulerstats.md)


---

# Agent Instructions: 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:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/scheduler/schedulershutdown.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.