ansible.builtin.cron 模块 – 管理 cron.d 和 crontab 条目

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定集合关键字，也可以使用短模块名称 cron。但是，我们建议您使用完全限定集合名称 (FQCN) ansible.builtin.cron，以便轻松链接到模块文档并避免与其他可能具有相同模块名称的集合冲突。

概要

• 使用此模块来管理 crontab 和环境变量条目。此模块允许您创建环境变量和命名的 crontab 条目，更新或删除它们。

• 当管理 crontab 作业时：该模块包含一行，其中包含与传递给模块的 name 对应的 crontab 条目描述 "#Ansible: <name>"，未来的 ansible/模块调用会使用该描述来查找/检查状态。name 参数应该是唯一的，更改 name 值将导致创建新的 cron 任务（或删除不同的任务）。

• 当管理环境变量时，不会添加注释行，但是，当模块需要查找/检查状态时，它会使用 name 参数来查找环境变量定义行。

• 当使用 % 等符号时，必须正确转义它们。

要求

执行此模块的主机需要满足以下要求。

• cron（任何符合 “vixie cron” 标准的变体，如 cronie）

参数

参数	注释
backup 布尔值	如果设置，则在修改 crontab 之前创建其备份。备份的位置由该模块返回在 backup_file 变量中。 选择 false ←（默认） true
cron_file 路径	如果指定，则使用此文件而不是单个用户的 crontab。假设此文件由模块独占管理，如果该文件包含多个条目，则不要使用，永远不要用于 /etc/crontab。 如果这是一个相对路径，则相对于 /etc/cron.d 进行解释。 许多 Linux 发行版都期望（有些要求）文件名部分仅包含大写和小写字母、数字、下划线和连字符。 使用此参数需要您也指定 user，除非 state=absent。 需要此参数或 name。
day 别名：dom 字符串	作业应该运行的月份中的某天（1-31，*，*/2，等等）。 不能与 special_time 组合使用。 默认： "*"
disabled 布尔值	如果应该在 crontab 中禁用（注释掉）作业。 仅在 state=present 时生效。 选择 false ←（默认） true
env 布尔值	如果设置，则管理 crontab 的环境变量。 新变量添加到 crontab 的顶部。 name 和 value 参数是环境变量的名称和值。 选择 false ←（默认） true
hour 字符串	作业应该运行的小时（0-23，*，*/2，等等）。 不能与 special_time 组合使用。 默认： "*"
insertafter 字符串	与 state=present 和 env 一起使用。 如果指定，则会在指定的环境变量声明之后插入环境变量。
insertbefore 字符串	与 state=present 和 env 一起使用。 如果指定，则会在指定的环境变量声明之前插入环境变量。
job 别名：value 字符串	要执行的命令，或者如果设置了 env，则为环境变量的值。 该命令不应包含换行符。 如果 state=present，则为必填项。
minute 字符串	作业应该运行的分钟（0-59，*，*/2，等等）。 不能与 special_time 组合使用。 默认： "*"
month 字符串	作业应该运行的年份中的月份（JAN-DEC 或 1-12，*，*/2，等等）。 不能与 special_time 组合使用。 默认： "*"
name 字符串 / 必需	crontab 条目的描述，或者如果设置了 env，则为环境变量的名称。 从 ansible-core 2.12 开始，此参数始终是必需的。
special_time 字符串	特殊时间规范昵称。 不能与 minute、hour、day、month 或 weekday 组合使用。 选择 "annually" "daily" "hourly" "monthly" "reboot" "weekly" "yearly"
state 字符串	是否确保作业或环境变量存在或不存在。 选择 "absent"（不存在） "present" ← (默认)
user (用户) 字符串	应修改其 crontab 的特定用户。 如果未设置，此参数默认为当前用户。
weekday（星期几） 别名: dow 字符串	作业应运行的星期几 (SUN-SAT 或 0-6, *，等等)。 不能与 special_time 组合使用。 默认： "*"

属性

属性	支持	描述
check_mode（检查模式）	支持: 完全支持	可以在检查模式下运行并返回更改状态预测，而无需修改目标，如果不支持，则会跳过该操作。
diff_mode（差异模式）	支持: 完全支持	在差异模式下，将返回已更改的内容的详细信息（或可能需要在检查模式下更改的内容）。
platform（平台）	平台: posix	可以操作的目标操作系统/系列

备注

注意

• 如果您在 cron 和 MacOS 上遇到权限问题，您应该查阅官方 MacOS 文档以获取更多信息。

示例

- name: Ensure a job that runs at 2 and 5 exists. Creates an entry like "0 5,2 * * ls -alh > /dev/null"
  ansible.builtin.cron:
    name: "check dirs"
    minute: "0"
    hour: "5,2"
    job: "ls -alh > /dev/null"

- name: 'Ensure an old job is no longer present. Removes any job that is prefixed by "#Ansible: an old job" from the crontab'
  ansible.builtin.cron:
    name: "an old job"
    state: absent

- name: Creates an entry like "@reboot /some/job.sh"
  ansible.builtin.cron:
    name: "a job for reboot"
    special_time: reboot
    job: "/some/job.sh"

- name: Creates an entry like "PATH=/opt/bin" on top of crontab
  ansible.builtin.cron:
    name: PATH
    env: yes
    job: /opt/bin

- name: Creates an entry like "APP_HOME=/srv/app" and insert it after PATH declaration
  ansible.builtin.cron:
    name: APP_HOME
    env: yes
    job: /srv/app
    insertafter: PATH

- name: Creates a cron file under /etc/cron.d
  ansible.builtin.cron:
    name: yum autoupdate
    weekday: "2"
    minute: "0"
    hour: "12"
    user: root
    job: "YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate"
    cron_file: ansible_yum-autoupdate

- name: Removes a cron file from under /etc/cron.d
  ansible.builtin.cron:
    name: "yum autoupdate"
    cron_file: ansible_yum-autoupdate
    state: absent

- name: Removes "APP_HOME" environment variable from crontab
  ansible.builtin.cron:
    name: APP_HOME
    env: yes
    state: absent

作者

• Dane Summers (@dsummersl)

• Mike Grozak (@rhaido)

• Patrick Callahan (@dirtyharrycallahan)

• Evan Kaufman (@EvanK)

• Luca Berruti (@lberruti)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通