Ansible学习笔记之经常使用模块汇总

Ansible的模块应该是平常中用的最多的，掌握好模块的使用，能更好的写出palybook，因此我从网上收集总结了经常使用的的一些模块，以作记录和以后的查询使用。

(1)、fetch模块：文件拉取模块，主要是将远程主机中的文件拷贝到本机中

和copy模块的做用刚刚相反，而且在保存的时候使用hostname来进行保存，当文件不存在的时候，会出现错误，除非设置了选项fail_on_missing为yes

Dest:用来存放文件的目录，例如存放目录为backup，源文件名称为/etc/profile在主机pythonserver中，那么保存为/backup/pythonserver/etc/profile
Fail_on_missing: Yes/no,当源文件不存在的时候，标识为失败
Flat: 容许覆盖默认行为从hostname/path到/file的，若是dest以/结尾，它将使用源文件的基础名称
Src: 在远程拉取的文件，而且必须是一个file，不能是目录
Validate_checksum Yes/no,当文件fetch以后进行md5检查

案例1：从远程机器上床送文件到主控机
# ansible server -m fetch -a “src=/root/123 dest=/root
src表示为远程主机上须要传送的文件的路径，dest表示为本机上的路径，在传送过来的文件，是按照IP地址或hostname进行分类，而后路径是源文件的路径，例如上面的最终路径为/root/192.168.1.60/root/123在拉取文件的时候，必须拉取的是文件，不能拉取文件夹

案例2：指定路径目录进行保存
# ansible pythonserver -m fetch -a “src=/root/Ssh.py dest=/root/kel/ flat=yes”
在使用参数为flat的时候，若是dest的后缀名为/，那么就会保存在目录中，而后直接保存为文件名，如上例的结果为 dest”: “/root/kel/Ssh.py；
当dest后缀不为/的时候，那么就会直接保存为kel的文件，如上例1所示。主要是在于dest是否已/结尾，从而来区分这是个目录仍是路径。

(2)、assemble模块：文件组装模块，主要是将多份配置文件组装为一份配置文件。

Backup：Yes/no 是否建立备份文件，使用时间戳
Delimiter：配置文件内容之间的分隔符
Dest：目的文件用来链接全部的源文件
Follow：Yes/no 表示文件系统的连接，若是存在，应该follow
Group：文件所属组，至关于chown
Mode：文件属性，0644，记住保留前面的0
Owner：文件所属用户
Regexp：组装的时候是否匹配相关的文件进行组合
Remote_src：True/False，False表示src文件在本机上，True表示src在远程主机上
Src：已经存在的目录文件

案例：将本机上的配置文件组装发送到远程主机
# ansible pythonserver -m assemble -a “src=/root/kel/ dest=/tmp/kel.conf remote_src=False”
在本机目录/root/kel的文件进行组装，发送到远程配置文件/tmp/kel.conf中，在此注意参数remote_src为False表示组装本机的配置文件，若是在本机目录中不存在文件，那么将会显示Python代码和乱码

(3)、file模块：文件属性设置

force：须要在两种状况下强制建立软连接，一种是源文件不存在，但以后会创建的状况下；另外一种是目标软连接已存在，须要先取消以前的软链，而后建立新的
软链，有两个选项：yes|no
group：定义文件/目录的属组
mode：定义文件/目录的权限
owner：定义文件/目录的属主
path：必选项，定义文件/目录的路径
recurse：递归设置文件的属性，只对目录有效
src：被连接的源文件路径，只应用于state=link的状况
dest：被连接到的路径，只应用于state=link的状况
state：
directory：若是目录不存在，就建立目录
file：即便文件不存在，也不会被建立
link：建立软连接
hard：建立硬连接
touch：若是文件不存在，则会建立一个新的文件，若是文件或目录已存在，则更新其最后修改时间
absent：删除目录、文件或者取消连接文件

案例：远程文件符号连接建立
# ansible storm_cluster -m file -a “src=/etc/resolv.conf dest=/tmp/resolv.conf state=link”
src表示已经存在的文件，dest表示建立的软链接的文件名，最后的state状态为link
案例：远程文件符号连接删除
# ansible storm_cluster -m file -a “path=/tmp/resolv.conf state=absent”

(4)、copy模块：复制文件到远程主机

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

案例：将本地文件“/etc/ansible/ansible.cfg”复制到远程服务器，设置属主和属组及文件权限
# ansible storm_cluster -m copy -a “src=/etc/ansible/ansible.cfg dest=/tmp/ansible.cfg owner=root group=root mode=0644″

(5)、command模块：在远程主机上执行命令

Command不适用于有shell变量的状况，也不适用于有管道符或者&&的状况，若是要使用此种状况，那么可使用shell模块

相关选项以下：
creates：一个文件名，当该文件存在，则该命令不执行
free_form：要执行的linux指令
chdir：在执行指令以前，先切换到该目录
removes：一个文件名，当该文件不存在，则该选项不执行
executable：切换shell来执行指令，该执行路径必须是一个绝对路径

案例：查看远程服务器的负载信息
# ansible storm_cluster -m command -a “uptime”

(6)、shell模块：切换到某个shell执行指定的指令，与command不一样的是，此模块能够支持命令管道，同时还有另外一个模块也具有此功能：raw

chdir # 执行以前，先cd到指定目录在执行命令
creates # 一个文件名，当这个文件存在，则该命令不执行
executable # 切换shell来执行命令，须要使用命令的绝对路径
free_form= # 执行的命令
removes # 一个文件名，这个文件不存在，则该命令不执行

案例：远程执行shell脚本
# ansible storm_cluster -m shell -a “/tmp/rocketzhang_test.sh”

(7)、service模块：系统服务管理

arguments # 向服务传递的命令行参数
enabled # 设置服务开机自动启动，参数为yes|no
name= # 控制服务的名称
pattern # 若是经过status指令来查看服务的状态时，没有响应，就会经过ps指令在进程中根据该模式进行查找，若是匹配到，则认为该服务依然在运行
runlevel # 设置服务自启动级别
sleep # 若是执行了restarted，则在stop和start之间沉睡几秒钟
state # 启动`started’ 关闭`stopped’ 从新启动 `restarted’ 重载 `reloaded’

案例：启动http服务,并添加到启动服务项中，设置开机启动
# ansible web -m service -a “name=httpd state=started enabled=yes ”

(8)、cron模块：计划任务管理

backup # 若是设置，建立一个crontab备份
cron_file # 若是指定, 使用这个文件cron.d，而不是单个用户crontab
day # 日应该运行的工做( 1-31, *, */2, etc )
hour # 小时 ( 0-23, *, */2, etc )
job # 指明运行的命令是什么
minute # 分钟( 0-59, *, */2, etc )
month # 月( 1-12, *, */2, etc )
name # 定时任务描述
reboot # 任务在重启时运行，不建议使用，建议使用special_time
special_time # 特殊的时间范围，参数：reboot（重启时）,annually（每一年）,monthly（每个月）,weekly（每周）,daily（天天）,hourly（每小时）
state # 指定状态，prsent表示添加定时任务，也是默认设置，absent表示删除定时任务
user # 以哪一个用户的身份执行
weekday # 周 ( 0-6 for Sunday-Saturday, *, etc )

案例1：在指定节点上定义一个计划任务，每隔3分钟到主控端更新一次时间
# ansible all -m cron -a ‘name=”custom job” minute=*/3 hour=* day=* month=* weekday=* job=”/usr/sbin/ntpdate 172.16.254.139″‘

案例2：新建一个cron文件
# ansible pythonserver -m cron -a “name=’for test’ weekday=’2′ minute=’0′ hour=12 user=’root’ job=’cat /etc/passwd >/root/111′ cron_file=’test ansible'”
新增一个任务，在目录/etc/cron.d/目录中，文件名称为test ansible，用户为root

(9)、yum模块：软件包安装管理

conf_file # yum的配置文件
disable_gpg_check # 关闭gpg_check
disablerepo # 不启用某个源
enablerepo # 启用某个源
List # 非幂等性命令
name= # 指定要安装的包，若是有多个版本须要指定版本，不然安装最新的包
state # 安装(`present’)，安装最新版(`latest’)，卸载程序包(`absent’)

案例1：肯定一个包安装的是指定版本，以下：
# ansible server -m yum -a “name=acme-1.5 state=present”
案例2：安装一个最新版包：
# ansible server -m yum -a “name=acme state=latest”
案例3：指定repo来进行安装包
# ansible server -m yum -a “name=httpd enablerepo=kel state=present”
在指定源的时候，使用enablerepo，注意这个名字是配置文件/etc/yum.repo.d/目录中文件的section的名称，以下所示：
# cat rhel-source.repo |grep kel
[kel]name=kel
baseurl=file:///tmp/kel
案例4：更新全部安装包
# ansible server -m yum -a “name=* state=latest
案例5：指定rpm进行安装
# ansible server -m yum -a “name=/usr/local/src/kel.noarch.rpm state=present”
案例6：指定远程网址rpm进行安装
# ansible server -m yum -a “name=http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6.0.el6.ngx.noarch.rpm state=present”

(10)、synchronize模块：使用rsync同步文件

使用rsync 模块，系统必须安装rsync 包，不然没法使用这个模块

archive # 是否采用归档模式同步，即以源文件相同属性同步到目标地址
checksum # 是否效验
compress # 开启压缩，默认为开启
copy_links # 同步的时候是否复制链接
delete # 删除源中没有而目标存在的文件（即以推送方为主）
dest= # 目标地址
dest_port # 目标接受的端口，ansible配置文件中的 ansible_ssh_port 变量优先级高于该 dest_port 变量
dirs # 以非递归的方式传输目录
existing_only # Skip creating new files on receiver.
group # Preserve group
links # Copy symlinks as symlinks.
mode # rsync同步的方式，默认都是推送push。若是你在使用拉取pull功能，能够经过mode=pull更改推送模式为拉取模式
recursive # 是否递归 yes/no
rsync_opts # 使用rsync 的参数
rsync_path # 指定远程服务器上的rsync命令所在路径信息。这个参考rsync命令的–rsync-path参数，–rsync-path=PATH
rsync_timeout # 指定 rsync 操做的 IP 超时时间，和rsync命令的 –timeout 参数效果同样.
set_remote_user # put user@ for the remote paths. If you have a custom ssh config to define the remote user for
src=\‘#\‘” # 同步的数据源目录或文件
–exclude=.Git #忽略同步.git结尾的文件

因为模块默认启用了archive参数，该参数默认开启了recursive,links,perms,times,owner，group和-D参数。若是你将该参数设置为no，那么你将中止不少参数，好比会致使以下目的递归失败，致使没法拉取

案例1：把本机根目录下的time.sh文件同步到目标主机上。目标机器须要安装rsync软件
# ansible web -a ‘yum install rsync -y’
# ansible web -m synchronize -a ‘src=/time.sh dest=/tmp/’

(11)、user模块：系统用户帐号管理

comment # 用户的描述信息
createhome # 是否建立家目录
force # 在使用`state=absent’是, 行为与`userdel –force’一致.
group # 指定基本组
groups # 指定附加组，若是指定为(‘groups=’)表示删除全部组
home # 指定用户家目录
login_class # 能够设置用户的登陆类 FreeBSD, OpenBSD and NetBSD系统.
move_home # 若是设置为`home=’时, 试图将用户主目录移动到指定的目录
name= # 指定用户名
non_unique # 该选项容许改变非惟一的用户ID值
password # 指定用户密码
remove # 在使用 `state=absent’时, 行为是与 `userdel –remove’一致.
shell # 指定默认shell
state #设置账号状态，不指定为建立，指定值为absent表示删除
system # 当建立一个用户，设置这个用户是系统用户。这个设置不能更改现有用户。
uid #指定用户的uid
update_password # 更新用户密码

案例：添加用户foo，指定密码，设置家目录，不容许远程登陆
# ansible webserves -m user -a “name=foo password= home=/home/foo shell=/sbin/nologin”

(12)、group模块：系统用户组管理

gid # 设置组的GID号
name= # 管理组的名称
state # 指定组状态，默认为建立，设置值为absent为删除
system # 设置值为yes，表示为建立系统组

案例：建立一个foo组，指定gid号
# ansible webserves -m group -a “name=foo gid=360 system=yes”

(13)、Script模块：将本地脚本复制到远程主机并运行

creates # 一个文件名，当这个文件存在，则该命令不执行
free_form= # 本地脚本路径
removes # 一个文件名，这个文件不存在，则该命令不执行

案例：
#主控端/root/下必须有local.sh脚本。
#ansible test -m script -a ‘/root/local.sh’

(14)、setup模块:收集远程主机的facts

每一个被管理节点在接收并运行管理命令以前，会将本身主机相关信息，如操做系统版本、IP地址等报告给远程的ansbile主机
Fact_path：/etc/ansible/facts.d，Fact的路径
Filter：过滤串

案例1：收集fact而且进行保存
# ansible server -m setup –tree /tmp/facts
执行以后，会显示相关的fact，而且在/tmp/facts中会保存fact信息

案例2：收集内存信息并输出
# ansible pythonserver -m setup -a “filter=ansible_*_mb”
使用过滤字符串，从而进行了相关的匹配，获得相关的内存信息以下：
“ansible_facts”: {

“ansible_memfree_mb”: 746,

“ansible_memtotal_mb”: 996,

“ansible_swapfree_mb”: 2015,

“ansible_swaptotal_mb”: 2015

}

(15)、ini_file模块：ini文件管理模块主要是用来设置ini文件的格式的文件

添加、删除、修改单独的ini格式的文件，其中主要是用来修改部分的配置信息，而不是template或者是assemble，添加失去的section。

Backup： Yes/no，在修改以前进行备份
Dest： Ini类型文件的路径，若是不存在会建立
Follow： Yes/no，标识是否文件系统连接，若是存在，那么将遵循
Group：组名
Mode：权限
Option： 若是须要修改一个值，那么能够设置，若是添加删除一个整段，那么能够忽略
Others： 文件模块所使用的参数能够在这里使用
Owner：用户名
Section：在ini文件中的section名称，若是状态为present而且设置了一个值，那么会添加
State: 状态
Absent 删除
Present 新增(默认)
Value： 这个值和option相关联，若是删除那么会忽略

案例：添加其中的节的值
# ansible pythonserver -m ini_file -a “dest=/tmp/kel section=kel option=kel value=kel mode=0600 backup=yes”
表示在ini文件格式中添加一个值，路径为/tmp/kel，节名称为kel，字符为kel值为kel，在修改以前进行备份，ini文件格式以下：
[section]key=value

(16)、hostname模块：主要用来修改主机的名称

Name：主机名称

案例：修改主机名称
# ansible server -m hostname -a “name=Ansible”
在查看的时候，主要查看文件/etc/sysconfig/network，重启以后才能生效

(17)、ping模块：主要是无心义的测试模块

主要用来检查ansible是否能够用的模块以及python是否配置好的，在playbook中基本不会使用，在能成功链接以后，老是返回结果pong

# ansible all -m ping

(18)、raw模块：ssh命令执行模块

此模块的执行，在远程主机上，不须要python环境，主要是用来执行脏的ssh命令。
Free_form：须要执行的脚本（没有真正的参数为free_form）
Removes：当文件名称存在的时候，此步不会执行

raw模块是底层ssh的通信，不依靠python的模块，因此若是碰到低版本的系统，或者客户端是路由器的话，那么没有python模块的话，command和shell模块没法使用，能够先用这条命令安装完须要的包。

(19)、template模块：进行文档内变量的替换的模块

template使用了Jinjia2格式做为文件模版，它的每次使用都会被ansible标记为”changed”状态。且template下的文件可使用var里面定义的变量

backup: yes/no 创建个包括timestamp在内的文件备份，以备不时之需.
dest: 远程节点上的绝对路径，用于放置template文件。
group: 设置远程节点上的的template文件的所属用户组
mode: 设置远程节点上的template文件权限。相似Linux中chmod的用法
owner: 设置远程节点上的template文件所属用户
src: 本地Jinjia2模版的template文件位置。

案例：把/templates/foo.j2文件通过填写参数后，复制到远程节点的/etc/file.conf，设置文件权限
# ansible pythonserver -m template -a “src=/templates/foo.j2 dest=/etc/file.conf owner=foo group=foo mode=0644″

(20)、apt模块：ubuntu/debian的包管理工具

这个模块是ubuntu做为远端节点的OS的时候，用的最多的

cache_valid_time 若是update_cache参数起做用的时候，这个参数才会起做用。其用来控制update_cache的总体有效时间
deb 这个用于安装远程机器上的.deb后缀的软件包
default_release 等同于apt命令的-t选项，这里就很少说了
force yes/no，强制执行apt install/remove
install_recommends yes/no，这个参数能够控制远程电脑上是否只是下载软件包，仍是下载后安装，默认为true,设置为false的时候光下载软件包不安装
name apt要下载的软件包名字，支持name=git=1.6 这种制定版本的模式
purge yes/no，若是state参数值为absent,这个参数为yes的时候，将会强行干净的卸载
state 定义软件包的最终状态，latest时为安装最新软件，默认为present
latest
absent
present
update_cache yes/no，当这个参数为yes的时候等于apt-get update
upgrade yes/safe/full/dist，若是参数为yes或者safe，等同于apt-get upgrade.若是是full就是完整更新。若是是dist等于apt-get dist-upgrade。

案例：安装nginx最新的名字为squeeze-backport发布包，而且安装前执行更新
# ansible web -m apt -a “name=nginx state=latest default_release=squeeze-backports update_cache=yes”

(21)、wait_for模块:等待一个事件发生或处理完后，再继续运行下面的事情

connect_timeout 默认5秒，在下一个事情发生前等待连接的时间，单位是秒
delay 延时，你们都懂，在作下一个事情前延时多少秒
host 默认127.0.0.1，执行这个模块的host
path 当一个文件存在于文件系统中，下一步才继续。
port 端口号，如8080
state 默认started，对象是端口的时候start状态会确保端口是打开的，stoped状态会确认端口是关闭的
present 对象是文件的时候present或者started会确认文件是存在的，而absent会确认文件是不存在的。
started
stopped
absent

案例1：10秒后在当前主机开始检查8000端口，直到端口启动后返回# ansible web -m wait_for -a “port=8000 delay=10″案例2：检查path=/tmp/foo直到文件存在后继续# ansible web -m wait_for -a “path=/tmp/foo”案例3：确认/var/lock/file.lock不存在继续# ansible web -m wait_for -a “path=/var/lock/file.lock state=absent”