根据Ansible官方的分类，将模块分为核心模块和额外模块，代码托管地址：https://github.com/ansible
核心模块按功能分类为：云模块、命令模块、数据库模块、文件模块、资产模块、消息模块、监控模块、网络模块、通知模块、包管理模块、源码控制模块、系统模块、单元模块、web设施模块、windows模块等。
具体可以参看官方页面ansible-modules-core。这里从官方分类的模块里选择最常用的一些模块进行介绍，介绍之前我们先调整一下hosts文件，把默认用户和密码添加到主机中，这样就不需要指定-u及-k了。
|
1 2 |
[test] 10.0.60.143 ansible_ssh_user=root ansible_ssh_pass=vm2016 |
一、常用模块介绍
- ping
测试主机是否是通的，用法很简单，不涉及参数。
|
1 |
$ ansible test -m ping |
- setup
setup模块，主要用于获取主机信息，在playbooks里经常会用到的一个参数。gather_facts就与该模块相关，setup模块下经常使用的一个参数是filter参数，具体使用示例如下：
|
1 2 3 4 5 6 7 8 |
# 查看主机内存信息 $ ansible test -m setup -a 'filter=ansible_*_mb' # 查看地接口为eth0-2的网卡信息 $ ansible test -m setup -a 'filter=ansible_eth[0-2]' # 将所有主机的信息输入到/tmp/facts目录下，每台主机的信息输入到主机名文件中（/etc/ansible/hosts里的主机名） $ ansible test -m setup --tree /tmp/facts |
- file
file模块主要用于远程主机上的文件操作，具体使用示例如下：
|
1 2 3 4 5 6 7 8 |
# 创建一个软连接 $ ansible test -m file -a "src=/etc/fstab dest=/tmp/fstab state=link" # 删除一个文件 $ ansible test -m file -a "path=/tmp/fstab state=absent" # 创建一个文件 $ ansible test -m file -a "path=/tmp/test state=touch" |
常用参数：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
force #需要在两种情况下强制创建软链接，一种是源文件不存在但之后会建立的情况下；另一种是目标软链接已存在,需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no; group #定义文件/目录的属组; mode #定义文件/目录的权限; owner #定义文件/目录的属主; path #必选项，定义文件/目录的路径, required; recurse #递归的设置文件的属性，只对目录有效; src #要被链接的源文件的路径，只应用于state=link的情况; dest #被链接到的路径，只应用于state=link的情况; state： directory #如果目录不存在，创建目录; file #即使文件不存在，也不会被创建; link #创建软链接; hard #创建硬链接; touch #如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间; absent #删除目录、文件或者取消链接文件; |
- copy
复制文件到远程主机，如下示例：
|
1 2 3 |
$ ansible test -m copy -a "src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644" $ ansible test -m copy -a "src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes" $ ansible test -m copy -a "src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'" |
常用参数：
|
1 2 3 4 5 6 7 8 9 |
backup #在覆盖之前将原文件备份，备份文件包含时间信息。有两个选项：yes|no; content #用于替代"src",可以直接设定指定文件的值; directory_mode #递归的设定目录的权限，默认为系统默认权限; force #如果目标主机包含该文件，但内容不同，如果设置为yes，则强制覆盖，如果为no，则只有当目标主机的目标位置不存在该文件时，才复制。默认为yes; others #所有的file模块里的选项都可以在这里使用; dest #必选项，要将源文件复制到的远程主机的绝对路径，如果源文件是一个目录，那么该路径也必须是个目录, required; src #要复制到远程主机的文件在本地的地址，可以是绝对路径，也可以是相对路径。如果路径是一个目录，它将递归复制。在这种情况下， #如果路径使用"/"来结尾，则只复制目录里的内容，如果没有使用"/"来结尾，则包含目录在内的整个内容全部复制，类似于rsync; validate #复制文件前进行验证,文件的路径的验证是通过"%s"; |
- service
用于管理主机服务，能够同时管理CentOS6和CentOS7，不区分CentOS6的service和CentOS7的systemctl，如下实例：
|
1 2 3 |
$ ansible test -m service -a "name=httpd state=started enabled=yes" $ ansible test -m service -a "name=foo pattern=/usr/bin/foo state=started" $ ansible test -m service -a "name=network state=restarted args=eth0" |
常用参数：
|
1 2 3 4 5 6 7 |
name #必选项,服务名称; state #对当前服务执行启动，停止、重启、重新加载等操作（started, stopped, restarted, reloaded）; enabled #是否开机启动yes|no; pattern #定义一个模式，如果通过status指令来查看服务的状态时，没有响应，就会通过ps指令在进程中根据该模式进行查找，如果匹配到，则认为该服务依然在运行; runlevel #运行级别; arguments #给命令行提供一些选项; sleep #如果执行了restarted，在则stop和start之间沉睡几秒钟; |
- cron
用于管理计划任务，如下实例：
|
1 2 3 4 5 |
$ ansible test -m cron -a 'name="a job for reboot" special_time=reboot job="/some/job.sh"' $ ansible test -m cron -a 'name="yum autoupdate" minute=*/1 hour=* day=* month=* weekday=* user="root" job="date>>/tmp/1.txt"' $ ansible test -m cron -a 'name="yum autoupdate" minute=1 hour=*/1 day=* month=* weekday=* user="root" job="date>>/tmp/1.txt"' $ ansible test -m cron -a 'backup="True" name="test" minute="0" hour="5,2" job="ls -alh > /dev/null"' $ ansilbe test -m cron -a 'cron_file=ansible_yum-autoupdate state=absent' |
常用参数：
|
1 2 3 4 5 6 7 8 9 10 11 12 |
name #该任务的描述; backup #对远程主机上的原任务计划内容修改之前做备份; cron_file #如果指定该选项，则用该文件替换远程主机上的cron.d目录下的用户的任务计划; day #日（1-31，，/2,……）; hour #小时（0-23，，/2，……）; minute #分钟（0-59，，/2，……）; month #月（1-12，，/2，……）; weekday #周（0-7，*，……）; job #要执行的任务,依赖于state=present; special_time #指定什么时候执行，参数：reboot(重启时),yearly(每年),annually,monthly,weekly,daily,hourly; state #确认该任务计划是创建还是删除; user #以哪个用户的身份执行; |
- yum
使用yum包管理器来管理软件包，实例如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
# 安装最新版本的apache; $ ansible test -m yum -a 'name=httpd state=latest' # 移除apache; $ ansible test -m yum -a 'name=httpd state=absent' # 升级所有的软件包; $ ansible test -m yum -a 'name=* state=latest ' # 安装整个Development tools相关的软件包; $ ansible test -m yum -a 'name="@Development tools" state=present' # 从本地仓库安装nginx; $ ansible test -m yum -a 'name=/usr/local/src/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present' # 从一个远程yum仓库安装nginx; $ ansible test -m yum -a 'name=http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present' |
常用参数：
|
1 2 3 4 5 6 |
name #要进行操作的软件包的名字，也可以传递一个url或者一个本地的rpm包的路径; config_file #yum的配置文件; disable_gpg_check #关闭gpg_check; disablerepo #不启用某个源; enablerepo #启用某个源; state #用于描述安装包最终状态，<em>present/latest</em>用于安装包，<em>absent</em>用于卸载安装包; |
- user
用户管理模块，使用实例：
|
1 |
$ ansible test -m user -a 'name=johnd comment="John Doe" uid=1040 group=admin' |
常用参数：
|
1 2 3 4 5 6 7 8 9 10 |
home #指定用户的家目录，需要与createhome配合使用; groups #指定用户的属组; uid #指定用的uid; password #指定用户的密码; name #指定用户名; createhome #是否创建家目录yes|no; system #是否为系统用户; remove #当state=absent时，remove=yes则表示连同家目录一起删除，等价于userdel -r; state #是创建还是删除; shell #指定用户的shell环境; |
注：指定password参数时，不能使用明文密码，因为后面这一串密码会被直接传送到被管理主机的/etc/shadow文件中，所以需要先将密码字符串进行加密处理。然后将得到的字符串放到password中即可。
生成一个密码
|
1 2 |
$ echo "123456" | openssl passwd -1 -salt $(< /dev/urandom tr -dc '[:alnum:]' | head -c 32) -stdin $1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0 |
用上面生成的密码创建用户
|
1 |
$ ansible all -m user -a 'name=foo password="$1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0"' |
不同的发行版默认使用的加密方式可能会有区别，具体可以查看/etc/login.defs文件确认，centos 6.5版本使用的是SHA512加密算法。
- group
组管理模块，使用实例：
|
1 |
$ ansible all -m group -a 'name=somegroup state=present' |
常用参数：
|
1 2 3 4 |
gid #指定gid; name #指定组名称; state #操作状态，present,absent; system #是否为系统组; |
- filesystem
在块设备上创建文件系统，示例如下：
|
1 2 |
$ ansible test -m filesystem -a 'fstype=ext2 dev=/dev/sdb1 force=yes' $ ansible test -m filesystem -a 'fstype=ext4 dev=/dev/sdb1 opts="-cc"' |
常用参数：
|
1 2 3 4 |
dev #目标块设备; force #在一个已有文件系统的设备上强制创建; fstype #文件系统的类型; opts #传递给mkfs命令的选项; |
- mount
配置挂载点
|
1 2 3 |
$ ansible test -m mount 'name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro state=present' $ ansible test -m mount 'name=/srv/disk src='LABEL=SOME_LABEL' state=present' $ ansible test -m mount 'name=/home src='UUID=b3e48f45-f933-4c8e-a700-22a159ec9077' opts=noatime state=present' |
|
1 2 3 4 |
$ ansible test -a 'dd if=/dev/zero of=/disk.img bs=4k count=1024' $ ansible test -a 'losetup /dev/loop0 /disk.img' $ ansible test -m filesystem -a 'fstype=ext4 force=yes opts=-F dev=/dev/loop0' $ ansible test -m mount 'name=/mnt src=/dev/loop0 fstype=ext4 state=mounted opts=rw' |
常用参数：
|
1 2 3 4 5 6 7 8 9 |
fstype #必选项,挂载文件的类型; name #必选项,挂载点; opts #传递给mount命令的参数; src #必选项,要挂载的文件; state #必选项; present #只处理fstab中的配置; absent #删除挂载点; mounted #自动创建挂载点并挂载之; umounted #卸载; |
- get_url
该模块主要用于从http、ftp、https服务器上下载文件（类似于wget）
|
1 |
$ ansible test -m filesystem -a 'url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440' |
常用参数：
|
1 2 3 4 5 |
sha256sum #下载完成后进行sha256 check; timeout #下载超时时间，默认10s; url #下载的URL; url_password、url_username #主要用于需要用户名密码进行验证的情况; use_proxy #使用代理,代理需事先在环境变更中定义; |
- unarchive
用于解压文件的模块，
|
1 2 3 |
$ ansible test -m unarchive -a 'src=foo.tgz dest=/var/lib/foo' $ ansible test -m unarchive -a 'src=/tmp/foo.zip dest=/usr/local/bin copy=no' $ ansible test -m unarchive -a 'src=https://example.com/example.zip dest=/usr/local/bin copy=no' |
常用参数：
|
1 2 3 4 5 6 7 8 |
copy #在解压文件之前，是否先将文件复制到远程主机，默认为yes。若为no，则要求目标主机上压缩包必须存在; creates #指定一个文件名，当该文件存在时，则解压指令不执行; dest #远程主机上的一个路径，即文件解压的路径; group #解压后的目录或文件的属组; list_files #如果为yes，则会列出压缩包里的文件，默认为no，2.0版本新增的选项; mode #解决后文件的权限; src #如果copy为yes，则需要指定压缩文件的源路径; owner #解压后文件或目录的属主; |
- script
在指定节点上执行shell/python脚本（注意，该脚本是在ansible控制节点上面的）
|
1 |
$ ansible test -m script -a '/root/src.sh' |
- shell
在指定节点上执行shell/python脚本（注意，该脚本是在远程节点）。
|
1 |
$ ansible test -m shell -a '/bin/bash /root/dest.sh' |
- command
用于执行远程系统命令，此模块为ansible默认执行的模块，也是常用模块之一。
|
1 |
$ ansible test -m command -a 'uname -n' |
- raw
类似于command模块、区别在于raw模块支持管道传递。
|
1 |
$ ansible test -m raw -a "tail -n2 /etc/passwd | head -n1" |
- synchronize
就是Linux下面的rsync命令操作。
|
1 |
$ ansible test -m synchronize -a "src=172.16.52.246 dest=/root delete=yes" |
rsync支持的参数，它也都同样都支持。常用的如下：
archive：归档，相当于同时开启recursive(递归)、links、perms、times、owner、group、-D选项都为yes ，默认该项为开启。
checksum：跳过检测sum值，默认关闭。
compress：是否开启压缩。
copy_links：复制链接文件，默认为no ，注意后面还有一个links参数。
delete：删除不存在的文件，默认no。
dest：目录路径。
dest_port：默认目录主机上的端口，默认是22，走的ssh协议。
dirs：传速目录不进行递归，默认为no，即进行目录递归。
rsync_opts：rsync参数部分。
set_remote_user：主要用于/etc/ansible/hosts中定义或默认使用的用户与rsync使用的用户不同的情况。
mode：push或pull 模块，push模的话，一般用于从本机向远程主机上传文件，pull模式用于从远程主机上取文件 。
如果您觉得本站对你有帮助，那么可以支付宝扫码捐助以帮助本站更好地发展，在此谢过。
