"#Ansible: <name>"corresponding to the “name” passed to the module, which is used by future ansible/module calls to find/check the state. The “name” parameter should be unique, and changing the “name” value will result in a new cron task being created (or a different one being removed).
If set, create a backup of the crontab before it is modified. The location of the backup is returned in the
If specified, uses this file instead of an individual user's crontab. If this is a relative path, it is interpreted with respect to /etc/cron.d. (If it is absolute, it will typically be /etc/crontab). To use the
Day of the month the job should run ( 1-31, *, */2, etc )
(added in 2.0)
If the job should be disabled (commented out) in the crontab. Only has effect if state=present
(added in 2.1)
If set, manages a crontab's environment variable. New variables are added on top of crontab. "name" and "value" parameters are the name and the value of environment variable.
Hour when the job should run ( 0-23, *, */2, etc )
(added in 2.1)
(added in 2.1)
The command to execute or, if env is set, the value of environment variable. Required if state=present.
Minute when the job should run ( 0-59, *, */2, etc )
Month of the year the job should run ( 1-12, *, */2, etc )
Description of a crontab entry or, if env is set, the name of environment variable. Required if state=absent. Note that if name is not set and state=present, then a new crontab entry will always be created, regardless of existing ones.
If the job should be run at reboot. This option is deprecated. Users should use special_time.
(added in 1.3)
Special time specification nickname.
Whether to ensure the job or environment variable is present or absent.
The specific user whose crontab should be modified.
Day of the week that the job should run ( 0-6 for Sunday-Saturday, *, etc )
# Ensure a job that runs at 2 and 5 exists. # Creates an entry like "0 5,2 * * ls -alh > /dev/null" - cron: name: "check dirs" minute: "0" hour: "5,2" job: "ls -alh > /dev/null" # Ensure an old job is no longer present. Removes any job that is prefixed # by "#Ansible: an old job" from the crontab - cron: name: "an old job" state: absent # Creates an entry like "@reboot /some/job.sh" - cron: name: "a job for reboot" special_time: reboot job: "/some/job.sh" # Creates an entry like "PATH=/opt/bin" on top of crontab - cron: name: PATH env: yes value: /opt/bin # Creates an entry like "APP_HOME=/srv/app" and insert it after PATH # declaration - cron: name: APP_HOME env: yes value: /srv/app insertafter: PATH # Creates a cron file under /etc/cron.d - cron: name: yum autoupdate weekday: 2 minute: 0 hour: 12 user: root job: "YUMINTERACTIVE: 0 /usr/sbin/yum-autoupdate" cron_file: ansible_yum-autoupdate # Removes a cron file from under /etc/cron.d - cron: name: "yum autoupdate" cron_file: ansible_yum-autoupdate state: absent # Removes "APP_HOME" environment variable from crontab - cron: name: APP_HOME env: yes state: absent
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is supported mainly by the community and is curated by core committers.
For more information on what this means please read Module Support