Skip to content

DOCS-4441: Additional config options #4683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2025
Merged

DOCS-4441: Additional config options #4683

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d20485f
DOCS-4441: Additional config options
npentrel Oct 6, 2025
bd3ad3a
Update scheduled-jobs.md
npentrel Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/manage/software/scheduled-jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Jobs are configured as part of your machine's configuration. Each job requires t
| Parameter | Type | Required | Description |
| ---------- | ------ | ------------ | ----------- |
| `name` | string | **Required** | Unique identifier for the job within the machine. |
| `schedule` | string | **Required** | Schedule specification using unix-cron format or Golang duration. Accepts <ul><li>Unix-cron expressions for time-based scheduling:<ul><li>`"0 */6 * * *"`: Every 6 hours</li><li>`"0 0 * * 0"`: Every Sunday at midnight</li><li>`"*/15 * * * *"`: Every 15 minutes</li><li>`"0 9 * * 1-5"`: Every weekday at 9 AM</li></ul></li><li>Golang duration strings for interval-based scheduling:<ul><li>`"5m"`: Every 5 minutes</li><li>`"1h"`: Every hour</li><li>`"30s"`: Every 30 seconds</li><li>`"24h"`: Every 24 hours</li></ul></li></ul>Job schedules are evaluated in the machine's local timezone. |
| `schedule` | string | **Required** | Schedule specification using unix-cron format or Golang duration. Values must be non-zero. Accepts <ul><li>Unix-cron expressions for time-based scheduling:<ul><li>`"*/5 * * * * *"`: Runs at 5 seconds past the minute</li><li>`"0 */6 * * *"`: Every 6 hours</li><li>`"0 0 * * 0"`: Every Sunday at midnight</li><li>`"*/15 * * * *"`: Every 15 minutes</li><li>`"0 9 * * 1-5"`: Every weekday at 9 AM</li></ul></li><li>Golang duration strings for interval-based scheduling:<ul><li>`"10ms"`: Every 30 milliseconds</li><li>`"30s"`: Every 30 seconds</li><li>`"5m"`: Every 5 minutes</li><li>`"1h"`: Every hour</li><li>`"24h"`: Every 24 hours</li></ul></li></ul>Job schedules are evaluated in the machine's local timezone. |
| `resource` | string | **Required** | Name of the target resource (component or service). |
| `method` | string | **Required** | Component or service API method to call on the target resource. |
| `command` | object | Optional | Command parameters for `DoCommand` operations. |
Expand Down
Loading