22.16.179. salt.modules.schedule

Module for manging the Salt schedule on a minion

New in version 2014.7.0.

salt.modules.schedule.add(name, **kwargs)

Add a job to the schedule

CLI Example:

salt '*' schedule.add job1 function='test.ping' seconds=3600
salt.modules.schedule.build_schedule_item(name, **kwargs)

Build a schedule job

CLI Example:

salt '*' schedule.build_schedule_item job1 function='test.ping' seconds=3600
salt.modules.schedule.delete(name, **kwargs)

Delete a job from the minion's schedule

CLI Example:

salt '*' schedule.delete job1
salt.modules.schedule.disable(**kwargs)

Disable all scheduled jobs on the minion

CLI Example:

salt '*' schedule.disable
salt.modules.schedule.disable_job(name, **kwargs)

Disable a job in the minion's schedule

CLI Example:

salt '*' schedule.disable_job job1
salt.modules.schedule.enable(**kwargs)

Enable all scheduled jobs on the minion

CLI Example:

salt '*' schedule.enable
salt.modules.schedule.enable_job(name, **kwargs)

Enable a job in the minion's schedule

CLI Example:

salt '*' schedule.enable_job job1
salt.modules.schedule.list(show_all=False, return_yaml=True)

List the jobs currently scheduled on the minion

CLI Example:

salt '*' schedule.list

salt '*' schedule.list show_all=True
salt.modules.schedule.modify(name, **kwargs)

Modify an existing job in the schedule

CLI Example:

salt '*' schedule.modify job1 function='test.ping' seconds=3600
salt.modules.schedule.purge(**kwargs)

Purge all the jobs currently scheduled on the minion

CLI Example:

salt '*' schedule.purge
salt.modules.schedule.reload()

Reload saved scheduled jobs on the minion

CLI Example:

salt '*' schedule.reload
salt.modules.schedule.run_job(name, force=False)

Run a scheduled job on the minion immediately

CLI Example:

salt '*' schedule.run_job job1

salt '*' schedule.run_job job1 force=True
Force the job to run even if it is disabled.
salt.modules.schedule.save()

Save all scheduled jobs on the minion

CLI Example:

salt '*' schedule.save

Docs for previous releases are available on salt.rtfd.org.

Latest Salt release: 2014.1.13

Try the shiny new release candidate of Salt, v2014.7.0rc6! More info here.

Previous topic

22.16.178. salt.modules.saltutil

Next topic

22.16.180. salt.modules.seed

SaltStack News

Upcoming SaltStack events, webinars and local meet ups and user groups.