一、概述
cron 模块可以帮助我们管理远程主机中的计划任务,功能相当于 crontab 命令。
在了解cron模块的参数之前,先写出一些计划任务的示例:
# 示例1,每天的1点5分输出 test 字符
5 1 * * * echo test
# 示例2,每3天执行一次计划任务,于当天的1点1分执行,具体任务为输出 test 字符
1 1 */3 * * echo test
# 示例3,每次系统启动后需要执行一次计划任务,具体任务为输出 test 字符
@reboot echo test
# 示例4,每小时执行一次计划任务,具体任务为输出 test 字符
@hourly echo test
根据上述示例,下面可以更好的了解 cron 模块的参数。
二、常用参数
minute参数:此参数用于设置计划任务中分钟设定位的值,比如,上述示例1中分钟设定位的值为5,即 minute=5,当不使用此参数时,分钟设定位的值默认为”*”。
hour参数:此参数用于设置计划任务中小时设定位的值,比如,上述示例1中小时设定位的值为1,即 hour=1,当不使用此参数时,小时设定位的值默认为”*”。
day参数:此参数用于设置计划任务中日设定位的值,当不使用此参数时,日设定位的值默认为”*”。
month参数:此参数用于设置计划任务中月设定位的值,当不使用此参数时,月设定位的值默认为”*”。
weekday参数:此参数用于设置计划任务中周几设定位的值,当不使用此参数时,周几设定位的值默认为”*”。
special_time参数:在上述示例3与示例4中,计划任务的时间设定格式为 @reboot 或者@hourly。@reboot 表示重启时执行,@hourly 表示每小时执行一次,相当于设置成”0 0 *” ,这种@开头的时间设定格式则需要使用 special_time 参数进行设置,special_time 参数的可用值有 reboot(重启后)、yearly(每年)、annually(每年,与yearly相同)、monthly(每月)、weekly(每周)、daily(每天)、hourly(每时)。
注意:当上述时间单位设定参数都未指定时,计划任务的时间设定默认会被设定为” *”,这样表示每秒都会执行一次计划任务,所以,在使用cron模块时,我们应该确定对应的时间参数设置正确。
user参数:此参数用于设置当前计划任务属于哪个用户,当不使用此参数时,默认为管理员用户。
job参数:此参数用于指定计划的任务中需要实际执行的命令或者脚本,比如上例中的 “echo test” 命令。
name参数:此参数用于设置计划任务的名称,计划任务的名称会在注释中显示,当不指定计划任务的名称时,ansible 会默认为计划任务加入注释,注释的内容为 #Ansible: None,假设指定计划任务的名称为 test,那么注释的内容为#Ansible: test,在一台机器中,计划任务的名称应该具有唯一性,方便我们以后根据名称修改或删除计划任务。
state参数:当计划任务有名称时,我们可以根据名称修改或删除对应的任务,当删除计划任务时,需要将 state 的值设置为 absent。
disabled参数:当计划任务有名称时,我们可以根据名称使对应的任务”失效”(注释掉对应的任务)。注意,使用此参数时,除了需要指定任务的名称,还需要同时指定任务的job 以及任务的时间设定,而且任务的时间设定必须和对应任务完全相同,否则在注释任务的同时,任务的时间设定会被修改,除非你确定这样做。
backup参数:如果此参数的值设置为 yes,那么当修改或者删除对应的计划任务时,会先对计划任务进行备份,然后再对计划任务进行修改或者删除,cron 模块会在远程主机的 /tmp 目录下创建备份文件,以 crontab 开头并且随机加入一些字符,具体的备份文件名称会在返回信息的 backup_file 字段中看到,推荐将此此参数设置为 yes。
三、示例
1.在 ansible-demo3 主机上创建计划任务,任务名称为”crontab test”,任务于每天1点5分执行,任务内容为输出test字符。
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='crontab test' minute=5 hour=1 job='echo test' "
ansible-demo3 | SUCCESS => {
"changed": true,
"envs": [],
"jobs": [
"crontab test"
]
}
执行上述命令后,在 ansible-demo3 主机中 root 用户下会有如下计划任务被创建:
[root@ansible-demo3 ~]# crontab -u root -l
#Ansible: crontab test
5 1 * * * echo test
2.在 ansible-demo3 主机上创建计划任务,任务名称为”crontab day test”,任务每3天执行一次,于执行当天的1点1分开始执行,任务内容为输出 test 字符。
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='crontab day test' minute=1 hour=1 day=*/3 job='echo test' "
ansible-demo3 | SUCCESS => {
"changed": true,
"envs": [],
"jobs": [
"crontab test",
"crontab day test"
]
}
执行上述命令后,在 ansible-demo3 主机中 root 用户下会有如下计划任务被创建:
[root@ansible-demo3 ~]# crontab -u root -l
#Ansible: crontab test
5 1 * * * echo test
#Ansible: crontab day test
1 1 */3 * * echo test
3.在 ansible-demo3 主机上创建计划任务,任务名称为”special time test”,任务将在重启时执行,任务内容为输出 test 字符。
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='special time test' special_time=reboot job='echo test' "
ansible-demo3 | SUCCESS => {
"changed": true,
"envs": [],
"jobs": [
"crontab test",
"crontab day test",
"special time test"
]
}
执行上述命令后,在 ansible-demo3 主机中 root 用户下会有如下计划任务被创建:
[root@ansible-demo3 ~]# crontab -u root -l
#Ansible: crontab test
5 1 * * * echo test
#Ansible: crontab day test
1 1 */3 * * echo test
#Ansible: special time test
@reboot echo test
4.由于”special time test”已经存在,所以,当我们再次操作同名的任务时,ansible 将会认为是修改原来的任务。执行如下命令,原计划任务会被修改,因为启用了 backup,所以任务在修改前会被备份。
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='special time test' special_time=hourly job='echo test' backup=yes "
ansible-demo3 | SUCCESS => {
"backup_file": "/tmp/crontabX6CMO1",
"changed": true,
"envs": [],
"jobs": [
"crontab test",
"crontab day test",
"special time test"
]
}
执行上述命令后,从返回信息的 backup_file 字段中可以看到备份文件的远程主机中的位置,内容如下:
[root@ansible-demo3 ~]# cat /tmp/crontabX6CMO1
#Ansible: crontab test
5 1 * * * echo test
#Ansible: crontab day test
1 1 */3 * * echo test
#Ansible: special time test
@reboot echo test
原来的”special time test”任务会变成如下设定:
#Ansible: special time test
@hourly echo test
5.任务”special time test”已经存在于 ansible-demo3 主机中,如果我们想要删除这个计划任务,可以执行如下命令,删除任务的同时可以进行备份。
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='special time test' state=absent backup=yes "
ansible-demo3 | SUCCESS => {
"backup_file": "/tmp/crontabiaObgL",
"changed": true,
"envs": [],
"jobs": [
"crontab test",
"crontab day test"
]
}
命令执行后,从返回信息的 backup_file 字段中可以看到备份文件的远程主机中的位置。
6.默认操作的是 root 用户的计划任务,如果想要操作远程主机中其他用户的计划任务,可以指定要操作的用户。
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a "user=ding name='special time test' special_time=hourly job='echo test' "
ansible-demo3 | SUCCESS => {
"changed": true,
"envs": [],
"jobs": [
"special time test"
]
}
上述命令执行后,可以在远程主机中使用 crontab -u ding -l 查看对应的计划任务。
[root@ansible-demo3 ~]# crontab -u ding -l
#Ansible: special time test
@hourly echo test
7.上文已经创建了名称为 “crontab test” 的计划任务,如果我们想要暂时注释这个计划任务,可以使用如下命令。但是需要注意,在注释任务时,所有设定需要跟原设定保持一致,否则计划任务的设置将会发生改变,示例如下:
比如,我们想要将 crontab day test 这个任务注释掉,则需要使用如下命令。注意,最好与 backup 参数同时使用。
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='crontab day test' minute=1 hour=1 day=*/3 job='echo test' disabled=yes backup=yes"
ansible-demo3 | SUCCESS => {
"backup_file": "/tmp/crontabx0pB5J",
"changed": true,
"envs": [],
"jobs": [
"crontab test",
"crontab day test"
]
}
执行上述命令后,对应的计划任务将会被注释:
[root@ansible-demo3 ~]# crontab -u root -l
#Ansible: crontab test
5 1 * * * echo test
#Ansible: crontab day test
#1 1 */3 * * echo test
如果在使用 disabled 参数时,设置了错误的时间,那么对应任务被注释的同时,时间设定也会发生改变。比如,如果执行了如下命令:
[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='crontab day test' minute=55 job='echo test' disabled=yes backup=yes"
ansible-demo3 | SUCCESS => {
"backup_file": "/tmp/crontab1IuX2g",
"changed": true,
"envs": [],
"jobs": [
"crontab test",
"crontab day test"
]
}
那么对应任务被注释的同时,还会进行如下设置:
[root@ansible-demo3 ~]# crontab -u root -l
#Ansible: crontab test
5 1 * * * echo test
#Ansible: crontab day test
#55 * * * * echo test
如果忘记了任何时间设定,那么在任务被注释时,还会被设置为默认的时间设定,也就是 “ *”。
所以,在使用 disabled 参数时,最好结合 backup 参数一起使用,万一一时大意,还有回旋的余地。