ansible中 常用模块之系统模块
- 一、cron模块
- 模块介绍
- 模型参数
- 模块示例
- 二、service模块
- 模块介绍
- 模块参数
- 模块示例
- 三、user模块
- 模块介绍
- 模块参数
- 模块示例
- 四、group模块
- 模块介绍
- 模块参数
- 模块示例
前文中,我们介绍了一些常用的文件类模块和命令类模块,这篇文章中我们会介绍一些常用的系统类操作模块。
一、cron模块
模块介绍
cron模块可以帮助我们管理远程主机中的计划任务,功能相当于crontab命令。
模型参数
在了解cron模块的参数之前,先写出一些计划任务的示例,示例如下
#示例1
5 1 * * * echo test
#示例2
1 1 */3 * * echo test
#示例3
@reboot echo test
#示例4
@hourly echo test
上述示例1表示每天的1点5分输出test字符
上述示例2表示每3天执行一次计划任务,于当天的1点1分执行,具体任务为输出test字符
上述示例3表示每次系统启动后需要执行一次计划任务,具体任务为输出test字符
上述示例4表示每小时执行一次计划任务,具体任务 为输出test字符
根据上述示例,可以更好的了解cron模块的参数
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。 |
模块示例
cron模块的ad-hoc示例命令如下:
在testB(server3)主机上创建计划任务,任务名称为”test crontab”,任务于每天1点5分执行,任务内容为输出test字符
[root@server4 ~]# ansible testB -m cron -a " name='test crontab' minute=5 hour=1 job='echo test' "
执行上述命令后,在testB主机中root用户下会有如下计划任务被创建
#Ansible: test crontab
5 1 * * * echo test
在testB(server3)主机上创建计划任务,任务名称为”crontab day test”,任务每3天执行一次,于执行当天的1点1分开始执行,任务内容为输出test字符
[root@server4 ~]# ansible testB -m cron -a " name='crontab day test' minute=1 hour=1 day=*/3 job='echo test' "
执行上述命令后,在testB(server3)主机中root用户下会有如下计划任务被创建
#Ansible: crontab day test
1 1 */3 * * echo test
在testB(server3)主机上创建计划任务,任务名称为”test special time”,任务将在重启时执行,任务内容为输出test字符
[root@server4 ~]# ansible testB -m cron -a " name='test special time' special_time=reboot job='echo test' "
执行上述命令后,在testB(server3)主机中root用户下会有如下计划任务被创建
#Ansible: test special time
@reboot echo test
在testB(server3)主机上创建计划任务,任务名称为”test special time”,任务将在重启时执行,任务内容为输出test字符
ansible test70 -m cron -a " name='test special time' special_time=reboot job='echo test' "
执行上述命令后,在test70主机中root用户下会有如下计划任务被创建
#Ansible: test special time
@reboot echo test
由于”test special time”已经存在,所以,当我们再次操作同名的任务时,ansible将会认为是修改原来的任务。
在”test special time”已经存在的情况下,执行如下命令,原计划任务会被修改,因为启用了backup,所以任务在修改前会被备份。
[root@server4 ~]# ansible testB -m cron -a " name='test special time' special_time=reboot job='echo aabb' " #先修改crontab内容
[root@server4 ~]# ansible testB -m cron -a " name='test special time' special_time=reboot job='echo test' backup=yes" #再修改回来并进行备份
执行上述命令后,从返回信息的backup_file字段中可以看到备份文件的远程主机中的位置,原来的”test special time”任务会变成如下设定
#Ansible: test special time
@reboot echo test
任务”test special time”已经存在于testB(server3)主机中,如果我们想要删除这个计划任务,可以执行如下命令,删除任务的同时可以进行备份。
ansible testB -m cron -a " name='test special time' state=absent backup=yes "
命令执行后,从返回信息的backup_file字段中可以看到备份文件的远程主机中的位置
默认操作root用户的计划任务,如果想要操作远程主机中其他用户的计划任务,可以指定要操作的用户
[root@server4 ~]# ansible testB -m cron -a " user=cl name='special_test_cl' special_time=hourly job='echo test' "
上述命令执行后,可以在远程主机中使用crontab -lu cl
查看对应的计划任务。
之前已经创建了名称为test crontab的计划任务,如果我们想要暂时注释这个计划任务,可以使用如下命令,但是需要注意,在注释任务时,所有设定需要 跟原设定保持一致,否则计划任务的设置将会发生改变,示例如下
比如,我们想要将crontab day test这个任务注释掉,则需要使用如下命令,注意,最好与backup参数同时使用
[root@server4 ~]# ansible testB -m cron -a " name='crontab day test' minute=1 hour=1 day=*/3 job='echo test' disabled=yes backup=yes"
执行上述命令后,对应的计划任务将会被注释,如下
#Ansible: crontab day test
#1 1 */3 * * echo test
如果你在使用disabled参数时,设置了错误的时间,那么对应任务被注释的同时,时间设定也会发生改变,比如,如果你执行了如下命令
ansible testB -m cron -a " name='crontab day test' minute=55 job='echo test' disabled=yes backup=yes"
那么对应任务被注释的同时,同时还会进行如下设置
#Ansible: crontab day test
#55 * * * * echo test
如果你忘记了任何时间设定,那么在任务被注释时,还会被设置为默认的时间设定,也就是 * * * * *
所以,在使用disabled参数时,最后结合backup参数一起使用,万一一时大意,还有回旋的余地。
二、service模块
模块介绍
service模块可以帮助我们管理远程主机上的服务,比如,启动或停止远程主机中的nginx服务。
注意:假如你想要管理远程主机中的某个服务,那么这个服务必须能被 BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart 中的任意一种所管理,否则service模块也无法管理远程主机的对应服务,这样说可能不容易理解,那么我们换个方式来解释,假设你在使用centos6,那么你的centos6中的nginx则必须能够通过”service nginx start”启动,如果你的nginx无法通过”service nginx start”进行启动,那么它将同样无法通过ansible的service模块启动,假设你在使用centos7,那么你的centos7中的nginx则必须能够通过”systemctl start nginx”启动,如果它无法通过”systemctl start nginx”进行启动,那么它将同样无法通过ansible的service模块进行启动,centos6中默认通过sysv管理服务,centos7中默认通过systemd管理服务,如果你的服务无法通过 BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart 中的任意一种所管理,那么它也无法被ansible的service模块管理。
模块参数
service模块通常使用的参数如下,你可以先大概的了解一下这些参数,然后再结合后面的示例去理解:
参数 | 含义 |
name参数 | 此参数用于指定需要操作的服务名称,比如nginx |
state参数 | 此参数用于指定服务的状态,比如,我们想要启动远程主机中的nginx,则可以将state的值设置为started,如果想要停止远程主机中的服务,则可以将state的值设置为stopped,此参数的可用值有started、stopped、restarted、reloaded。 |
enabled参数 | 此参数用于指定是否将服务设置为开机 启动项,设置为yes表示将对应服务设置为开机启动,设置为no表示不会开机启动。 |
模块示例
在测试主机server3安装httpd服务
yum install httpd -y
service模块的ad-hoc示例命令如下:
将testB(server3)中的httpd服务处于启动状态:
[root@server4 ~]# ansible testB -m service -a "name=httpd state=started"
在server3查看服务状态:
将testB(server3)中的httpd服务处于停止状态
[root@server4 ~]# ansible testB -m service -a "name=httpd state=stopped"
在server3查看服务状态:
将testB(server3)中的httpd服务被设置为开机自动启动项
[root@server4 ~]# ansible testB -m service -a "name=httpd enabled=yes"
在server3查看服务状态:
三、user模块
模块介绍
user模块可以帮助我们管理远程主机上的用户,比如创建用户、修改用户、删除用户、为用户创建密钥对等操作。
模块参数
此处我们介绍一些user模块的常用参数,你可以先对这些参数有一个大概了解,然后再看小示例。
参数 | 含义 |
name参数 | 必须参数,用于指定要操作的用户名称,可以使用别名user。 |
group参数 | 此参数用于指定用户所在的基本组 |
gourps参数 | 此参数用于指定用户所在的附加组,注意,如果说用户已经存在并且已经拥有多个附加组,那么如果想要继续添加新的附加组,需要结合append参数使用,否则在默认情况下,当再次使用groups参数设置附加组时,用户原来的附加组会被覆盖。 |
append参数 | 如果用户原本就存在多个附加组,那么当使用groups参数设置附加组时,当前设置会覆盖原来的附加组设置,如果不想覆盖原来的附加组设置,需要结合append参数,将append设置为yes,表示追加附加组到现有的附加组设置,append默认值为no。 |
shell参数 | 此参数用于指定用户的默认shell |
uid参数 | 此参数用于指定用户的uid号 |
expires参数 | 此参数用于指定用户的过期时间,相当于设置/etc/shadow文件中的的第8列,比如,你想要设置用户的过期日期为2018年12月31日,那么你首先要获取到2018年12月31日的unix时间戳,使用命令”date -d 2018-12-31 +%s”获取到的时间戳为1546185600,所以,当设置expires=1546185600时,表示用户的过期时间为2018年12月31日0点0分,设置成功后,查看远程主机的/etc/shadow文件,对应用户的第八列的值将变成17895(表示1970年1月1日到2018年12月31日的天数,unix时间戳的值会自动转换为天数,我们不用手动的进行换算),目前此参数只支持在Linux和FreeBSD系统中使用。 |
comment参数 | 此参数用于指定用户的注释信息 |
state参数 | 此参数用于**指定用户是否存在于远程主机中,**可选值有present、absent,默认值为present,表示用户需要存在,当设置为absent时表示删除用户。 |
remove参数 | 当state的值设置为absent时,表示要删除远程主机中的用户,但是在删除用户时,不会删除用户的家目录等信息,这是因为remove参数的默认值为no,如果设置为yes,在删除用户的同时,会删除用户的家目录,当state=absent并且remove=yes时,相当于执行”userdel –remove”命令 |
password参数 | 此参数用于指定用户的密码,但是这个密码不能是明文的密码,而是一个对明文密码”加密后”的字符串,相当于/etc/shadow文件中的密码字段,是一个对明文密码进行哈希后的字符串,你可以在python的命令提示符下输入如下命令,生成明文密码对应的加密字符串。 |
update_password参数 | 此参数有两个值可选,always和on_create,当此参数的值设置为always时表示,如果password参数设置的值与用户当前的加密过的密码字符串不一致,则直接更新用户的密码,默认值即为always,但是当此参数设置为on_create时,如果password参数设置的值与用户当前的加密过的密码字符串不一致,则不会更新用户的密码字符串,保持之前的密码设定,如果是新创建的用户,即使此参数设置为on_create,也会将用户的密码设置为password参数对应的值。 |
generate_ssh_key参数 | 此参数默认值为no,如果设置为yes,表示为对应的用户生成ssh密钥对,默认在用户家目录的./ssh目录中生成名为id_rsa的私钥和名为id_rsa.pub的公钥,如果同名的密钥已经存在与对应的目录中,原同名密钥并不会被覆盖(不做任何操作) |
ssh_key_file参数 | 当generate_ssh_key参数的值为yes时,使用此参数自定义生成ssh私钥的路径和名称,对应公钥会在同路径下生成,公钥名以私钥名开头,以”.pub”结尾。 |
ssh_key_comment参数 | 当generate_ssh_key参数的值为yes时,在创建证书时,使用此参数设置公钥中的注释信息,但是如果同名的密钥对已经存在,则并不会修改原来的注释信息,即不做任何操作,当不指定此参数时,默认的注释信息为”ansible-generated on 远程主机的主机名” |
ssh_key_passphrase参数 | 当generate_ssh_key参数的值为yes时,在创建证书时,使用此参数设置私钥的密码,但是如果同名的密钥对已经存在,则并不会修改原来的密码,即不做任何操作 |
ssh_key_type参数 | 当generate_ssh_key参数的值为yes时,在创建证书时,使用此参数设置密钥对的类型,默认密钥类型为rsa,但是如果同名的密钥对已经存在,并不会对同名密钥做任何操作 |
模块示例
user模块的ad-hoc示例命令如下:
在testB(server3)主机上创建名为pp的用户,如果用户已经存在,则不进行任何操作。
[root@server4 ~]# ansible testB -m user -a "name=pp"
在testB(server3)主机上删除名为pp的用户,但是不会删除pp用户的家目录
[root@server4 ~]# ansible testB -m user -a "name=pp state=absent"
在testB(server3)主机上删除名为pp的用户,同时会删除pp用户的家目录等信息
[root@server4 ~]# ansible testB -m user -a "name=pp" #上一步把测试用户删除了,先添加回来
[root@server4 ~]# ansible testB -m user -a "name=pp state=absent remove=yes"
指定testB(server3)主机上的pp用户的主组为student,student组需要提前存在,当不使用group设置主组时,默认主组与用户名相同。
[root@server4 ~]# ansible testB -m user -a "name=pp group=student"
指定testB(server3)主机上的pp用户的附加组为student,student组需要提前存在,当不使用groups设置附属组时,默认附加组与用户名相同,注意,为了保险起见,在不知道用户原来的附加组设定的情况下,最好将append参数设置为yes,我们也可以一次性设置多个附加组,附加组之间用逗号隔开,比如groups=redhat,aaaa 示例命令如下
添加附加组:
[root@server4 ~]# ansible testB -m user -a "name=pp groups=cl"
添加附加组不复改原来组:
[root@server4 ~]# ansible testB -m user -a "name=pp groups=linux append=yes"
添加多个附加组:
[root@server4 ~]# ansible testB -m user -a "name=pp groups=redhat,aaaa append=yes"
指定testB(server3)主机上的zsy用户使用/bin/csh作为默认shell
ansible testB -m user -a "name=pp shell=/bin/csh"
指定testB(server3)主机上的pp用户的uid为2002
ansible test70 -m user -a "name=pp uid=2002"
指定testB(server3)主机上的pp用户的过期时间为2020年12月31日,使用”date -d 2020-12-31 +%s”命令可以获取到对应日期的unix时间戳
root@server4 ~]# date -d 2020-12-31 +%s
1609344000
[root@server4 ~]# ansible testB -m user -a "name=pp expires=1609344000"
指定testB(server3)主机上的pp用户的注释信息
[root@server4 ~]# ansible testB -m user -a "name=pp comment="www.redhat.org""
将testB(server3)主机上的pp用户的密码设置为666666:
首先生成666666的加密字符串
[root@server4 ~]# python
>>> import crypt
>>> crypt.crypt('666666')
'$6$6XORMx/Za8UseKry$yrC2QjWhUpUIGpfxgboJC8MracmKPntqwwBIZe4mbzpLS2xTzR/K3q3m5C8iq6Goq9JZyPWan9/5mF15T80Tl0'
使用生成的密码字符串设置用户密码
[root@server4 ~]# ansible testB -m user -a 'name=pp password="$6$6XORMx/Za8UseKry$yrC2QjWhUpUIGpfxgboJC8MracmKPntqwwBIZe4mbzpLS2xTzR/K3q3m5C8iq6Goq9JZyPWan9/5mF15T80Tl0"'
如下命令表示设置testB(server3)主机上的pp用户的密码,但是如果用户当前的加密字符串与命令中设置的加密字符串不一致,则不进行密码更新的操作。
[root@server4 ~]# ansible testB -m user -a 'name=pp password="$6$6XORMx/Za8UseKry$yrC2QjWhUpUIGpfxgboJC8MracmKPntqwwBIZe4mbzpLS2xTzR/K3q3m5C8iq6Goq9JZyPWan9/5mF15T80Tl0" update_password=on_create'
为testB(server3)上的pp用户生成ssh密钥对,默认在用户家目录的./ssh目录中生成名为id_rsa的私钥和名为id_rsa.pub的公钥,如果已经存在同名密钥,并不会覆盖原来的密钥,即不做任何操作。
[root@server4 ~]# ansible testB -m user -a "name=pp generate_ssh_key=yes"
为testB(server3)上的pp用户生成ssh密钥对,密钥对生成在/opt目录下,私钥名为id_rsa_pp,公钥名为id_rsa_pp.pub
[root@server4 ~]# ansible testB -m user -a "name=pp generate_ssh_key=yes ssh_key_file=/opt/id_rsa_pp"
为testB(server3)上的zsy用户生成ssh密钥对,同时指定公钥中的注释信息为”www.123.net”,此参数只能在创建密钥时使用才会生效,并不能操作同名的老密钥
ansible testB -m user -a 'name=pp generate_ssh_key=yes ssh_key_comment="www.123.net"'
为testB(server3)上的zsy用户生成ssh密钥对,同时指定私钥的密码为123456,此参数只能在创建密钥时使用才会生效,并不能操作同名的老密钥
ansible testB -m user -a 'name=pp generate_ssh_key=yes ssh_key_passphrase="123456"'
为testB(server3)上的pp用户生成ssh密钥对,同时指定密钥对的类型为dsa,当不显式指定密钥类型时,默认类型为rsa,此参数只能在创建密钥时使用才会生效,并不能操作同名的老密钥
ansible testB -m user -a 'name=pp generate_ssh_key=yes ssh_key_type=dsa'
四、group模块
模块介绍
group模块可以帮助我们管理远程主机上的组。
模块参数
此处我们介绍一些group模块的常用参数,你可以先对这些参数有一个大概了解,然后再看小示例。
参数 | 含义 |
name参数 | 必须参数,用于指定要操作的组名称。 |
state参数 | 用于指定组的状态,两个值可选,present,absent,默认为present,设置为absent表示删除组。 |
gid参数 | 用于指定组的gid |
模块示例
group模块的ad-hoc示例命令如下:
创建testB(server3)主机中存在名为python的组
[root@server4 ~]# ansible testB -m group -a "name=python state=absent"
删除testB(server3)主机中存在名为python的组,删除成功的前提是不能有用户把被删除的组当成主组。
[root@server4 ~]# ansible testB -m group -a "name=python state=absent"
当删除的组是某用户的主组时:
[root@server4 ~]# ansible testB -m group -a "name=student state=absent"
不能删除
确保testB(server3)主机中存在名为test的组,并且确定test组的组id为8888
[root@server4 ~]# ansible testB -m group -a "name=test gid=8888"
修改test组的gid为8111:
[root@server4 ~]# ansible testB -m group -a "name=test gid=8111"