Skip to main content

Cron

Manage cron drop-in files in /etc/cron.d/ on target hosts.

List​

List all osapi-managed cron entries:

$ osapi client node schedule cron list --target web-01

  NAME           SCHEDULE     USER  OBJECT
  backup-daily   0 2 * * *    root  backup-script
  log-rotate     0 0 * * 0    root  logrotate-conf

Get​

Get a specific cron entry by name:

$ osapi client node schedule cron get --target web-01 --name backup-daily

  Name:     backup-daily
  Schedule: 0 2 * * *
  User:     root
  Object:   backup-script

Create​

Upload the script to the Object Store first, then create the cron entry referencing it by object name:

$ osapi client file upload --name backup-script \
    --file /usr/local/bin/backup.sh

Then create the cron entry using --object to reference the uploaded file:

$ osapi client node schedule cron create --target web-01 \
    --name backup-daily \
    --schedule "0 2 * * *" \
    --object backup-script \
    --user root

  Name:    backup-daily
  Status:  ok
  Changed: true

The --user flag defaults to root if omitted.

Use --content-type template if the object was uploaded as a Go template and should be rendered with agent facts before being written to disk.

Update​

Update an existing cron entry:

$ osapi client node schedule cron update --target web-01 \
    --name backup-daily \
    --schedule "0 3 * * *"

  Name:    backup-daily
  Status:  ok
  Changed: true

Only the fields you specify are updated. If nothing changed, Changed: false.

Delete​

Delete a cron entry:

$ osapi client node schedule cron delete --target web-01 --name backup-daily

  Name:    backup-daily
  Status:  ok
  Changed: true

JSON Output​

All commands support --json for raw JSON output:

$ osapi client node schedule cron list --target web-01 --json
{"results":[{"name":"backup-daily","schedule":"0 2 * * *","user":"root","object":"backup-script"}],"job_id":"..."}