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