备注:文章事例部分代码会出现不对齐的情况,使用时,请注意格式对齐!!
第2章 ansible的常用模块
可以使用如下命令来找出想要的模块:
[root@~]# ansible-doc -l | grep
再使用如下命令来查看此模块的用法:
[root@~]# ansible-doc -s modulename
可以查看官方模块列表和说明文档,地址如下:https://docs.ansible.com/ansible/latest/modulesbycategory.html
另外关于模块的使用方法,需要注意的是"state"。有很多模块都会有该参数选项,且其值几乎都包含有"present"和"absent",表示肯定(安装)和否定(卸载)的意思。ansible的一重要特性是绝大多数模块都具有幂等特性,只有极少数模块如shell和command模块不具备幂等性。而所谓的幂等性是指多次执行同一个操作不会影响最终结果。比如,ansible的yum模块安装rpm包时,如果待安装的包已经安装过了,则再次或多次执行安装操作都不会真正的执行下去。
由于ansible模块非常多,以下仅介绍在playbook中常用到的模块的使用:
2.1 command 模块
注意,该命令不支持| 管道命令。
下面来看一看该模块下常用的几个命令:
chdir # 在执行命令之前,先切换到该目录
executable # 切换shell来执行命令,需要使用命令的绝对路径
free_form # 要执行的Linux指令,一般使用Ansible的-a参数代替。
creates # 一个文件名,当这个文件存在,则该命令不执行,可以用来做判断
removes # 一个文件名,这个文件不存在,则该命令不执行
下面我们来看看这些命令的执行效果:
[root@ ~]# ansible web -m command -a 'chdir=/data/ ls'
#先切换到/data 目录 在执行ls
2.2 shell模块
shell模块可以在远程主机上调用shell解释器运行命令,支持shell的各种功能,例如管道等。
[root@ ~]# ansible web -m shell -a 'cat /etc/passwd | tail -1 '
2.3 copy模块
这个模块用于将文件复制到远程主机,同时支持给定内容生成文件和修改权限等。
其相关选项如下:
src #被复制到远程主机的本地文件。可以是绝对路径,也可以是相对路径。如果路径是一个目录,则会递归复制,用法类似于"rsync"
content #用于替换"src",可以直接指定文件的值
dest #必选项,将源文件复制到的远程主机的绝对路径
backup #当文件内容发生改变后,在覆盖之前把源文件备份,备份文件包含时间信息
directory_mode #递归设定目录的权限,默认为系统默认权限
force #当目标主机包含该文件,但内容不同时,设为"yes",表示强制覆盖;设为"no",表示目标主机的目标位置不存在该文件才复制。默认为"yes"
others #所有的 file 模块中的选项可以在这里使用
用法举例如下:
[root@ ~]# ansible web -m copy -a 'src=~/copy.txt dest=/data/copy.txt backup=yes mode=666'
[root@ ~]# ansible web -m copy -a 'content="I am keer\n" dest=/data/copy.txt mode=666'
2.4 file模块
该模块主要用于设置文件的属性,比如创建文件、创建链接文件、删除文件等。
下面是一些常见的命令:
force #需要在两种情况下强制创建软链接,一种是源文件不存在,但之后会建立的情况下;另一种是目标软链接已存在,需要先取消之前的软链,然后创建新的软链,有两个选项:yes|no
group #定义文件/目录的属组。后面可以加上mode:定义文件/目录的权限
owner #定义文件/目录的属主。后面必须跟上path:定义文件/目录的路径
recurse #递归设置文件的属性,只对目录有效,后面跟上src:被链接的源文件路径,只应用于state=link的情况
dest #被链接到的路径,只应用于state=link的情况
state #状态,有以下选项:
directory:如果目录不存在,就创建目录
file:即使文件不存在,也不会被创建
link:创建软链接
hard:创建硬链接
touch:如果文件不存在,则会创建一个新的文件,如果文件或目录已存在,则更新其最后修改时间
absent:删除目录、文件或者取消链接文件
用法举例如下:
1、创建文件夹
[root@ ~]# ansible web -m file -a 'path=/data/app state=directory'
2、创建软链接
[root@ ~]# ansible web -m file -a 'path=/data/a.jpg src=b.jpg state=link'
3、删除文件
[root@ ~]# ansible web -m file -a 'path=/data/a.jpg state=absent'
2.5 fetch模块
该模块用于从远程某主机获取(复制)文件到本地。
有两个选项:
dest:用来存放文件的目录
src:在远程拉取的文件,并且必须是一个file,不能是目录
具体举例如下:
[root@ ~]# ansible web -m fetch -a 'src=/data/fetch.txt dest=/data'
2.6 yum模块
该模块主要用于软件的安装。
其选项如下:
name= #所安装的包的名称
state= #present--->安装, latest--->安装最新的, absent---> 卸载软件。
update_cache #强制更新yum的缓存
conf_file #指定远程yum安装时所依赖的配置文件(安装本地已有的包)。
disable_pgp_check #是否禁止GPG checking,只用于presentor latest。
disablerepo #临时禁止使用yum库。 只用于安装或更新时。
enablerepo #临时使用的yum库。只用于安装或更新时。
举例如下:
[root@ ~]# ansible web -m yum -a 'name=nginx state=present'
2.7 service模块
该模块用于服务程序的管理。
其主要选项如下:
arguments #命令行提供额外的参数
enabled #设置开机启动。
name= #服务名称
runlevel #开机启动的级别,一般不用指定。
sleep #在重启服务的过程中,是否等待。如在服务关闭以后等待2秒再启动。(定义在剧本中。)
state #有四种状态,分别为:started--->启动服务, stopped--->停止服务, restarted--->重启服务, reloaded--->重载配置
比如设置nginx开启服务并设置自启动:
[root@ ~]# ansible web -m service -a 'name=nginx state=started enabled=true'
2.8 user模块
该模块主要是用来管理用户账号。
其主要选项如下:
comment # 用户的描述信息
createhome # 是否创建家目录
force # 在使用state=absent时, 行为与userdel –force一致.
group # 指定基本组
groups # 指定附加组,如果指定为(groups=)表示删除所有组
home # 指定用户家目录
move_home # 如果设置为home=时, 试图将用户主目录移动到指定的目录
name # 指定用户名
non_unique # 该选项允许改变非唯一的用户ID值
password # 指定用户密码
remove # 在使用state=absent时, 行为是与userdel –remove一致
shell # 指定默认shell
state # 设置帐号状态,不指定为创建,指定值为absent表示删除
system # 当创建一个用户,设置这个用户是系统用户。这个设置不能更改现有用户
uid # 指定用户的uid
2.9 group模块
该模块主要用于添加或删除组。
常用的选项如下:
gid= #设置组的GID号
name= #指定组的名称
state= #指定组的状态,默认为创建,设置值为absent为删除
system= #设置值为yes,表示创建为系统组
2.10 template模块
template模块⽤法和copy模块⽤法基本⼀致,它主要⽤于复制配置⽂件
常用参数:
backup:如果原目标文件存在,则先备份目标文件
dest:目标文件路径
force:是否强制覆盖,默认为yes
group:目标文件属组
mode:目标文件的权限
owner:目标文件属主
src:源模板文件路径
validate:在复制之前通过命令验证目标文件,如果验证通过则复制
官方简单示例:
- template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
- template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode="u=rw,g=r,o=r"
- template: src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'