Ansible 模块篇

Ansible 之所以能自动化完成这么多操作，都是依赖于丰富的模块；类似Jenkins软件的强大的插件支持

查看模块

[root@vm00 ~]# ansible-doc -l

查看模块参数用法

[root@vm00 ~]# ansible-doc -s module
[root@vm00 ~]# ansible-doc help module

ansible 命令格式

ansible 主机或组-m 模块名-a '模块参数'  

command 模块

默认缺省模块

[root@vm00 ~]# ansible all -m command -a "/bin/echo 'hello,sir.'"
[root@vm00 ~]# ansible all -a 'chdir=/usr/local/src/ tar -cvzf test.tgz file'

shell 模块

和command一样；支持管道

[root@vm00 ~]# ansible test -m shell -a 'ps -ef |grep java'

raw 模块

和command一样；支持管道

ping 模块

测试主机连通性，没有参数

[root@vm00 ~]# ansible all -m ping

setup 模块

查看主机参数配置
filter 过滤参数，相当于grep功能

[root@vm00 ~]# ansible vm02 -m setup

将所有主机的信息输入到/tmp/facts目录下，每台主机的信息输入到主机名文件中（/etc/ansible/hosts里的主机名）

[root@vm00 ~]# ansible all -m setup --tree /tmp/facts 

获取主机ip地址

[root@vm00 ~]# ansible vm02 -m setup -a 'filter=ansible_default_ipv4'

获取主机内存使用情况

[root@vm00 ~]# ansible vm02 -m setup -a 'filter=ansible_memory_mb'

获取主机名

ansible vm02 -m setup -a 'filter=ansible_nodename'

file 模块

file模块主要用于远程主机上的文件操作，file模块包含如下选项：
force：需要在两种情况下强制创建软链接，一种是源文件不存在但之后会建立的情况下；另一种是目标软链接已存在,需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no
group：定义文件/目录的属组
mode：定义文件/目录的权限
owner：定义文件/目录的属主
path：必选项，定义文件/目录的路径
recurse：递归的设置文件的属性，只对目录有效
src：要被链接的源文件的路径，只应用于state=link的情况
dest：被链接到的路径，只应用于state=link的情况
state：

• directory：如果目录不存在，创建目录
• file：即使文件不存在，也不会被创建
• link：创建软链接
• hard：创建硬链接
• touch：如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间
• absent：删除目录、文件或者取消链接文件

[root@vm00 ~]# ansible nsxq -m file -a 'src=/etc/hosts dest=/tmp/hosts'
[root@vm00 ~]# ansible nsxq -a 'ls -lh /tmp/hosts'
[root@vm00 ~]# ansible nsxq -m file -a "path=/tmp/file1 state=touch"
[root@vm00 ~]# ansible nsxq -m file -a "dest=/tmp/hosts mode=600 owner=airmodel group=airmodel"
[root@vm00 ~]# ansible nsxq -m file -a "dest=/opt/test mode=755 owner=airmodel group=airmodel state=directory"

copy模块

复制文件到远程主机，copy模块包含如下选项：
backup：在覆盖之前将原文件备份，备份文件包含时间信息。有两个选项：yes|no
content：用于替代”src”,可以直接设定指定文件的值
dest：必选项。要将源文件复制到的远程主机的绝对路径，如果源文件是一个目录，那么该路径也必须是个目录
directory_mode：递归的设定目录的权限，默认为系统默认权限
force：如果目标主机包含该文件，但内容不同，如果设置为yes，则强制覆盖，如果为no，则只有当目标主机的目标位置不存在该文件时，才复制。默认为yes
others：所有的file模块里的选项都可以在这里使用
src：要复制到远程主机的文件在本地的地址，可以是绝对路径，也可以是相对路径。如果路径是一个目录，它将递归复制。在这种情况下，如果路径使用”/“来结尾，则只复制目录里的内容，如果没有使用”/“来结尾，则包含目录在内的整个内容全部复制，类似于rsync。

[root@vm00 ~]# ansible nsxq -m copy -a "src=/etc/hosts dest=/tmp/hosts"
[root@vm00 ~]# ansible test -m copy -a 'src=/etc/fstab dest=/tmp/fstab owner=airmodel group=airmodel mode=644 backup=yes'

service 模块

管理服务，该模块包含如下选项：
arguments：给命令行提供一些选项
enabled：是否开机启动 yes|no
name：必选项，服务名称
pattern：定义一个模式，如果通过status指令来查看服务的状态时，没有响应，就会通过ps指令在进程中根据该模式进行查找，如果匹配到，则认为该服务依然在运行
runlevel：运行级别
sleep：如果执行了restarted，在则stop和start之间沉睡几秒钟
state：对当前服务执行启动，停止、重启、重新加载等操作（started,stopped,restarted,reloaded）
ansible nsxq -m service -a ‘name=nginx state=started enabled=yes’

[root@vm00 ~]# ansible test -m service -a 'name=httpd state=started enabled=yes'

cron 模块

用于管理计划任务包含如下选项：
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
name：该任务的描述
special_time：指定什么时候执行，参数：reboot,yearly,annually,monthly,weekly,daily,hourly
state：确认该任务计划是创建还是删除
user：以哪个用户的身份执行
时间不特意指定的话，默认是 * * * * *

[root@vm00 ~]# ansible nsxq -m cron -a 'name="update ntp time" hour=2 user=root job="/usr/sbin/ntpdate cn.ntp.org.cn"'
[root@vm00 ~]# ansible nsxq -m cron -a 'name="update ntp time" state=absent'
[root@vm00 ~]# ansible test -m cron -a "name='show date' job='/root/test.sh' backup='True' hour=2 minute=*/5"

yum 模块

使用yum包管理器来管理软件包，其选项有：
config_file：yum的配置文件
disable_gpg_check：关闭gpg_check
disablerepo：不启用某个源
enablerepo：启用某个源
name：要进行操作的软件包的名字，也可以传递一个url或者一个本地的rpm包的路径
state：状态（present，absent，latest，installed）

[root@vm00 ~]# ansible nsxq -m yum -a 'name=httpd state=latest'
[root@vm00 ~]# ansible nsxq -m yum -a 'name="@Development Tools" state=present'
卸载操作
[root@vm00 ~]# ansible test -m yum -a "name=httpd state=absent"

user模块

user模块是请求的是useradd, userdel, usermod三个指令。

home：指定用户的家目录，需要与createhome配合使用
groups：指定用户的属组
uid：指定用的uid
password：指定用户的密码
name：指定用户名
createhome：是否创建家目录 yes|no
system：是否为系统用户
remove：当state=absent时，remove=yes则表示连同家目录一起删除，等价于userdel -r
state：是创建还是删除
shell：指定用户的shell环境
指定password的时候，需要指定加密后的密码，明文会直接写到/etc/shadow文件中，用户无法登陆

[root@vm00 ~]# echo "ffffff" | openssl passwd -1 -salt $(< /dev/urandom tr -dc '[:alnum:]' | head -c 32) -stdin
[root@vm00 ~]# ansible test -m user -a 'createhome=yes home=/home/user1 password="$1$01a9gEpb$nlv.OmSa1c4jDaGgeoDKi0" name=user1 state=present shell=/bin/bash'
[root@vm00 ~]# ansible test -m user -a 'name=user1 state=absent remove=yes'

group 模块

goup模块请求的是groupadd, groupdel, groupmod 三个指令。

[root@vm00 ~]# ansible test -m group -a 'name=group1 gid=700 state=present'

synchronize 模块

使用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；push模的话，一般用于从本机向远程主机上传文件，push的时候src是本机上的文件或目录; pull 模式用于从远程主机上取文件；pull的时候src是目标主机上的文件或目录
目录后边跟/表示同步目录下内容，不加/把目录同步过去

[root@vm00 ~]# ansible test -m synchronize -a 'src=/etc/hosts dest=/tmp mode=push'
[root@vm00 ~]# ansible test -m synchronize -a 'src=/etc/fstab dest=/tmp mode=pull'

filesystem 模块

在块设备上创建文件系统
选项：
dev：目标块设备
force：在一个已有文件系统 的设备上强制创建
fstype：文件系统的类型
opts：传递给mkfs命令的选项

[root@vm00 ~]# ansible test -a 'dd if=/dev/zero of=/abc.img bs=4k count=10000'
[root@vm00 ~]# ansible test -a 'losetup /dev/loop0 /abc.img'
[root@vm00 ~]# ansible test -m filesystem -a 'fstype=ext4 dev=/dev/loop0 force=yes opts=-F'

mount 模块

配置挂载点
选项：
dump
fstype：必选项，挂载文件的类型
name：必选项，挂载点
opts：传递给mount命令的参数
src：必选项，要挂载的文件
state：必选项

• present：只处理fstab中的配置
• absent：删除挂载点
• mounted：自动创建挂载点并挂载之
• umounted：卸载

[root@vm00 ~]# ansible test -m mount -a 'name=/opt/abc src=/abc.img fstype=ext4 opts=loop state=mounted'

模块的参数太多了，这篇文章基本上是copy过来的，这里贴一下出处：http://breezey.blog.51cto.com/2400275/1555530