salt.states.schedule¶

Management of the Salt scheduler¶

job3:
  schedule.present:
    - function: test.ping
    - seconds: 3600
    - splay: 10

This will schedule the command: test.ping every 3600 seconds
(every hour) splaying the time between 0 and 10 seconds

job2:
  schedule.present:
    - function: test.ping
    - seconds: 15
    - splay:
        start: 10
        end: 20

This will schedule the command: test.ping every 15 seconds
splaying the time between 10 and 20 seconds

job1:
  schedule.present:
    - function: state.sls
    - job_args:
      - httpd
    - job_kwargs:
        test: True
    - when:
        - Monday 5:00pm
        - Tuesday 3:00pm
        - Wednesday 5:00pm
        - Thursday 3:00pm
        - Friday 5:00pm

This will schedule the command: state.sls httpd test=True at 5pm on Monday,
Wednesday and Friday, and 3pm on Tuesday and Thursday.  Requires that
python-dateutil is installed on the minion.

job1:
  schedule.present:
    - function: state.sls
    - job_args:
      - httpd
    - job_kwargs:
        test: True
    - cron: '*/5 * * * *'

Scheduled jobs can also be specified using the format used by cron.  This will
schedule the command: state.sls httpd test=True to run every 5 minutes.  Requires
that python-croniter is installed on the minion.

job1:
  schedule.present:
    - function: state.sls
    - job_args:
      - httpd
    - job_kwargs:
        test: True
    - when:
        - Monday 5:00pm
        - Tuesday 3:00pm
        - Wednesday 5:00pm
        - Thursday 3:00pm
        - Friday 5:00pm
    - returner: xmpp
    - return_config: xmpp_state_run
    - return_kwargs:
        recipient: user@domain.com

This will schedule the command: state.sls httpd test=True at 5pm on Monday,
Wednesday and Friday, and 3pm on Tuesday and Thursday.  Using the xmpp returner
to return the results of the scheduled job, with the alternative configuration
options found in the xmpp_state_run section.

job1:
  schedule.present:
    - function: state.sls
    - job_args:
      - httpd
    - job_kwargs:
        test: True
    - hours: 1
    - skip_during_range:
        - start: 2pm
        - end: 3pm
    - run_after_skip_range: True

This will schedule the command: state.sls httpd test=True at 5pm on Monday,
Wednesday and Friday, and 3pm on Tuesday and Thursday.  Requires that
python-dateutil is installed on the minion.

salt.states.schedule.absent(name, **kwargs)¶

Ensure a job is absent from the schedule

name: The unique name that is given to the scheduled job.
persist: Whether the job should persist between minion restarts, defaults to True.

salt.states.schedule.disabled(name, **kwargs)¶

Ensure a job is disabled in the schedule

name: The unique name that is given to the scheduled job.
persist: Whether the job should persist between minion restarts, defaults to True.

salt.states.schedule.enabled(name, **kwargs)¶

Ensure a job is enabled in the schedule

name: The unique name that is given to the scheduled job.
persist: Whether the job should persist between minion restarts, defaults to True.

salt.states.schedule.present(name, **kwargs)¶

Ensure a job is present in the schedule

name: The unique name that is given to the scheduled job.
seconds: The scheduled job will be executed after the specified number of seconds have passed.
minutes: The scheduled job will be executed after the specified number of minutes have passed.
hours: The scheduled job will be executed after the specified number of hours have passed.
days: The scheduled job will be executed after the specified number of days have passed.
when: This will schedule the job at the specified time(s). The when parameter must be a single value or a dictionary with the date string(s) using the dateutil format. Requires python-dateutil.
cron: This will schedule the job at the specified time(s) using the crontab format. Requires python-croniter.
run_on_start: Whether the job will run when Salt minion starts, or the job will be skipped once and run at the next scheduled run. Value should be a boolean.
function: The function that should be executed by the scheduled job.
job_args: The arguments that will be used by the scheduled job.
job_kwargs: The keyword arguments that will be used by the scheduled job.
maxrunning: Ensure that there are no more than N copies of a particular job running.
jid_include: Include the job into the job cache.
splay: The amount of time in seconds to splay a scheduled job. Can be specified as a single value in seconds or as a dictionary range with 'start' and 'end' values.
range: This will schedule the command within the range specified. The range parameter must be a dictionary with the date strings using the dateutil format. Requires python-dateutil.
once: This will schedule a job to run once on the specified date.
once_fmt: The default date format is ISO 8601 but can be overridden by also specifying the once_fmt option.
enabled: Whether the job should be enabled or disabled. Value should be a boolean.
return_job: Whether to return information to the Salt master upon job completion.
metadata: Using the metadata parameter special values can be associated with a scheduled job. These values are not used in the execution of the job, but can be used to search for specific jobs later if combined with the return_job parameter. The metadata parameter must be specified as a dictionary, othewise it will be ignored.
returner: The returner to use to return the results of the scheduled job.
return_config: The alternative configuration to use for returner configuration options.
return_kwargs: Any individual returner configuration items to override. Should be passed as a dictionary.
persist: Whether the job should persist between minion restarts, defaults to True.
skip_during_range: This will ensure that the scheduled command does not run within the range specified. The range parameter must be a dictionary with the date strings using the dateutil format. Requires python-dateutil.
run_after_skip_range: Whether the job should run immediately after the skip_during_range time period ends.