Ansible模块参数详解

一、ping模块

进行主机连通性测试：

ansible web -m ping

二、command模块

ansible web -m command -a ‘chdir=*, executable=*, creates=*, removes=*’

参数：
chdir　 #在执行命令之前，先切换到该目录
free_form　 #必须参数，指定需要远程执行的命令，需要说明一点，free_form参数与其他参数并不相同，”free_form”并不是一个”实际存在”的参数名，比如，当我们想要在远程主机上执行ls命令时，我们并不需要写成”free_form=ls” ，这样写反而是错误的，因为并没有任何参数的名字是free_form，当我们想要在远程主机中执行ls命令时，直接写成ls即可，这就是free_form参数的含义，因为command模块的作用是执行命令，所以，任何一个可以在远程主机上执行的命令都可以被称为free_form。
creates 　 # 一个文件名，当这个文件存在，则该命令不执行,可以用来做判断
removes　 # 一个文件名，这个文件不存在，则该命令不执行

三、shell模块

可以在远程主机上调用shell解释器运行命令，有些linux命令在command模块中执行时，会出现一些异常，这个时候可以使用shell模块来执行，以避免这些异常。

ansible web -m shell -a ‘ps -ef | grep java’

参数：
chdir 　 # 在执行命令之前，先切换到该目录
executable 　 # 切换shell来执行命令，需要使用命令的绝对路径
free_form 　 # 要执行的Linux指令，一般使用Ansible的-a参数代替。
creates 　 # 一个文件名，当这个文件存在，则该命令不执行,可以用来做判断
removes 　 # 一个文件名，这个文件不存在，则该命令不执行

四、copy模块

参数：
src 　 #被复制到远程主机的本地文件。可以是绝对路径，也可以是相对路径。如果路径是一个目录，则会递归复制，用法类似于"rsync"
force 　 #当目标主机包含该文件，但内容不同时，设为"yes"，表示强制覆盖；设为"no"，表示目标主机的目标位置不存在该文件才复制。默认为"yes"
content 　 #用于替换"src"，可以直接指定文件的值
dest 　 #必选项，将源文件复制到的远程主机的绝对路径
backup 　 #当文件内容发生改变后，在覆盖之前把源文件备份，备份文件包含时间信息
owner 　 #指定文件拷贝到远程主机后的属主，但是远程主机上必须有对应的用户，否则会报错。
group 　 #指定文件拷贝到远程主机后的属组，但是远程主机上必须有对应的组，否则会报错。
mode 　 #指定文件拷贝到远程主机后的权限，如果你想将权限设置为”rw-r–r–“，则可以使用mode=0644表示，如果你想要在user对应的权限位上添加执行权限，则可以使用mode=u+x表示。
directory_mode 　 #递归设定目录的权限，默认为系统默认权限
others 　 #所有的 file 模块中的选项可以在这里使用

五、file模块

参数：
force 　 #需要在两种情况下强制创建软链接，一种是源文件不存在，但之后会建立的情况下；另一种是目标软链接已存在，需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no
group 　 #定义文件/目录的属组。后面可以加上mode：定义文件/目录的权限
owner 　 #定义文件/目录的属主。后面必须跟上path：定义文件/目录的路径
recurse 　 #递归设置文件的属性，只对目录有效，后面跟上src：被链接的源文件路径，只应用于state=link的情况
dest 　 #被链接到的路径，只应用于state=link的情况
state 　 #状态，有以下选项：

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

六、fetch模块

用于从远程主机获取（复制）文件到本地。

参数：
dest 　 #用来存放文件的目录
src 　 #在远程拉取的文件，并且必须是一个file，不能是目录

七、cron模块

用于管理cron计划任务。

参数：
day= 　 #应该运行的工作( 1-31, *, */2, )
hour= 　 #时 ( 0-23, *, */2, )
minute= 　 #钟( 0-59, *, */2, )
month= 　 #月( 1-12, *, /2, )
weekday= 　 #周 ( 0-6 for Sunday-Saturday, )
job= 　 #指明运行的命令是什么
name= 　 #定时任务描述
reboot 　 #任务在重启时运行，不建议使用，建议使用special_time
special_time 　 #特殊的时间范围，参数：reboot（重启时），annually（每年），monthly（每月），weekly（每周），daily（每天），hourly（每小时）
state 　 #指定状态，present表示添加定时任务（默认），absent表示删除定时任务
user 　 #以哪个用户的身份执行

disabled 　 #当计划任务有名称时，我们可以根据名称使对应的任务”失效”（注释掉对应的任务）。注意，使用此参数时，除了需要指定任务的名称，还需要同时指定任务的job 以及任务的时间设定，而且任务的时间设定必须和对应任务完全相同，否则在注释任务的同时，任务的时间设定会被修改，除非你确定这样做。

backup 　 #如果此参数的值设置为 yes，那么当修改或者删除对应的计划任务时，会先对计划任务进行备份，然后再对计划任务进行修改或者删除，cron 模块会在远程主机的 /tmp 目录下创建备份文件，以 crontab 开头并且随机加入一些字符，具体的备份文件名称会在返回信息的 backup_file 字段中看到，推荐将此此参数设置为 yes。

八、yum模块

参数：
name= 　 #所安装的包的名称
state= 　 #present—>安装（与installed等效）， latest—>安装最新的, absent—> 卸载软件（与removed 等效）。
update_cache 　 #强制更新yum的缓存
conf_file 　 #指定远程yum安装时所依赖的配置文件（安装本地已有的包）。
disable_pgp_check 　 #是否禁止GPG checking，只用于presentor latest。
disablerepo 　 #临时禁止使用yum库。 只用于安装或更新时。
enablerepo 　 #临时使用的yum库。只用于安装或更新时。

九、service模块

参数：
arguments 　 #命令行提供额外的参数
enabled 　 #设置开机启动。
name= 　 #服务名称
runlevel 　 #开机启动的级别，一般不用指定。
sleep 　 #在重启服务的过程中，是否等待。如在服务关闭以后等待2秒再启动。(定义在剧本中。)
state 　 #有四种状态，分别为：started—>启动服务， stopped—>停止服务， restarted—>重启服务， reloaded—>重载配置

十、user模块

参数：
comment 　 #用户的描述信息
createhome 　 #是否创建家目录
force 　 #在使用state=absent时, 行为与userdel –force一致.
group 　 #指定基本组

groups 　 #指定附加组，注意，如果说用户已经存在并且已经拥有多个附加组，那么如果想要继续添加新的附加组，需要结合 append 参数使用，否则在默认情况下，当再次使用 groups 参数设置附加组时，用户原来的附加组会被覆盖

append 　 #如果用户原本就存在多个附加组，那么当使用 groups 参数设置附加组时，当前设置会覆盖原来的附加组设置，如果不想覆盖原来的附加组设置，需要结合 append 参数，将 append 设置为 yes，表示追加附加组到现有的附加组设置，append 默认值为 no。

home 　 #指定用户家目录
move_home 　 #如果设置为home=时, 试图将用户主目录移动到指定的目录
name 　 #指定用户名
non_unique 　 #该选项允许改变非唯一的用户ID值

password 　 #此参数用于指定用户的密码。但是这个密码不能是明文的密码，而是一个对明文密码”加密后”的字符串，相当于 /etc/shadow 文件中的密码字段，是一个对明文密码进行哈希后的字符串，你可以在 python 的命令提示符下输入如下命令，生成明文密码对应的加密字符串。

remove 　 #当 state 的值设置为 absent 时，表示要删除远程主机中的用户。但是在删除用户时，不会删除用户的家目录等信息，这是因为 remove 参数的默认值为 no，如果设置为yes，在删除用户的同时，会删除用户的家目录。当 state=absent 并且 remove=yes 时，相当于执行 “userdel --remove” 命令。

shell 　 #指定默认shell
state 　 #此参数用于指定用户是否存在于远程主机中，可选值有 present、absent，默认值为 present，表示用户需要存在，指定值为absent表示删除
system 　 #当创建一个用户，设置这个用户是系统用户。这个设置不能更改现有用户
uid 　 #指定用户的uid

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，但是如果同名的密钥对已经存在，并不会对同名密钥做任何操作。

十一、group模块

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

十二、script模块

参数：
free_form 　 #必须参数，指定需要执行的脚本，脚本位于 ansible 管理主机本地，并没有具体的一个参数名叫 free_form，具体解释请参考 command 模块。
chdir 　 #指定一个远程主机中的目录，在执行对应的脚本之前，会先进入到 chdir 参数指定的目录中。
creates 　 #使用此参数指定一个远程主机中的文件，当指定的文件存在时，就不执行对应脚本，可参考 command 模块中的解释。
removes 　 #使用此参数指定一个远程主机中的文件，当指定的文件不存在时，就不执行对应脚本，可参考 command 模块中的解释。

十三、setup模块

该模块主要用于收集信息，是通过调用facts组件来实现的。
facts组件是Ansible用于采集被管机器设备信息的一个功能，我们可以使用setup模块查机器的所有facts信息，可以使用filter来查看指定信息。整个facts信息被包装在一个JSON格式的数据结构中，ansible_facts是最上层的值。
facts就是变量，内建变量 。每个主机的各种信息，cpu颗数、内存大小等。会存在facts中的某个变量中。调用后返回很多对应主机的信息，在后面的操作中可以根据不同的信息来做不同的操作。如redhat系列用yum安装，而debian系列用apt来安装软件。

参数：
filter 　 #用于进行条件过滤。如果设置，仅返回匹配过滤条件的信息。
ansible web -m setup
ansible web -m setup -a ‘filter=ansible_memory_mb’
ansible web -m setup -a ‘filter=*mb’

setup模块filter条件：
ansible_all_ipv4_addresses：仅显示ipv4的信息。
ansible_devices：仅显示磁盘设备信息。
ansible_distribution：显示是什么系统，例：centos,suse等。
ansible_distribution_major_version：显示是系统主版本。
ansible_distribution_version：仅显示系统版本。
ansible_machine：显示系统类型，例：32位，还是64位。
ansible_eth0：仅显示eth0的信息。
ansible_hostname：仅显示主机名。
ansible_kernel：仅显示内核版本。
ansible_lvm：显示lvm相关信息。
ansible_memtotal_mb：显示系统总内存。
ansible_memfree_mb：显示可用系统内存。
ansible_memory_mb：详细显示内存情况。
ansible_swaptotal_mb：显示总的swap内存。
ansible_swapfree_mb：显示swap内存的可用内存。
ansible_mounts：显示系统磁盘挂载情况。
ansible_processor：显示cpu个数(具体显示每个cpu的型号)。
ansible_processor_vcpus：显示cpu个数(只显示总的个数)。

十四、synchronize模块

使用rsync 模块，系统必须安装rsync 包，否则无法使用这个模块

参数：
archive 　 #是否采用归档模式同步，即以源文件相同属性同步到目标地址，默认yes
checksum 　 #是否效验，默认no
compress 　 #开启压缩，默认为开启
copy_links 　 #同步的时候是否复制连接，默认no
delete 　 #删除源中没有而目标存在的文件（即以推送方为主）默认no
dest= 　 #目标地址
dest_port 　 #目标接受的端口，ansible配置文件中的 ansible_ssh_port 变量优先级高于该 dest_port 变量，默认22
dirs 　 #以非递归的方式传输目录
existing_from 　 #用于定义排除多个文件夹和文件
group 　 #保留文件的所属组
mode 　 #模式，rsync 同步的方式 PUSH\PULL，默认都是推送push。如果你在使用拉取pull功能的时候，可以参考如下来实现mode=pull 更改推送模式为拉取模式
recursive 　 #是否递归 yes/no
rsync_opts 　 #使用rsync 的参数
rsync_path 　 #服务的路径，指定 rsync 命令来在远程服务器上运行。这个参考rsync命令的–rsync-path参数，–rsync-path=PATH # 指定远程服务器上的rsync命令所在路径信息
rsync_timeout 　 #指定 rsync 操作的 IP 超时时间，和rsync命令的 --timeout 参数效果一样.
src= 　 #源，同步的数据源

十五、yum_repository模块

参数：
name 　 #必须参数，用于指定要操作的唯一的仓库ID，也就是”.repo”配置文件中每个仓库对应的”中括号”内的仓库ID。
baseurl 　 #此参数用于设置 yum 仓库的 baseurl。
description 　 #此参数用于设置仓库的注释信息，也就是”.repo”配置文件中每个仓库对应的”name字段”对应的内容。
file 　 #此参数用于设置仓库的配置文件名称，即设置”.repo”配置文件的文件名前缀，在不使用此参数的情况下，默认以 name 参数的仓库ID作为”.repo”配置文件的文件名前缀，同一个”.repo” 配置文件中可以存在多个 yum 源。
enabled 　 #此参数用于设置是否激活对应的 yum 源，此参数默认值为 yes，表示启用对应的 yum 源，设置为 no 表示不启用对应的 yum 源。
gpgcheck 　 #此参数用于设置是否开启 rpm 包验证功能，默认值为 no，表示不启用包验证，设置为 yes 表示开启包验证功能。
gpgcakey 　 #当 gpgcheck 参数设置为 yes 时，需要使用此参数指定验证包所需的公钥。
state 　 #默认值为 present，当值设置为 absent 时，表示删除对应的 yum 源。

十六、replace模块

根据指定的正则表达式替换文件中的字符串，文件中所有被匹配到的字符串都会被替换。

参数：
path 　 #必须参数，指定要操作的文件，2.3版本之前，只能使用 dest, destfile, name指定要操作的文件，2.4版本中，仍然可以使用这些参数名，这些参数名作为 path 参数的别名使用。
regexp 　 #必须参数，指定一个 python 正则表达式，文件中与正则匹配的字符串将会被替换。
replace 　 #指定最终要替换成的字符串。
backup 　 #是否在修改文件之前对文件进行备份，最好设置为yes。

十七、find模块

参数：
paths 　 #必须参数，指定在哪个目录中查找文件，可以指定多个路径，路径间用逗号隔开，此参数有别名，使用别名 path 或者别名 name 可以代替 paths。

recurse 　 #默认情况下，只会在指定的目录中查找文件，也就是说，如果目录中还包含目录，ansible 并不会递归的进入子目录查找对应文件，如果想要递归的查找文件，需要使用 recurse 参数，当 recurse 参数设置为 yes 时，表示在指定目录中递归的查找文件。

hidden 　 #默认情况下，隐藏文件会被忽略，当 hidden 参数的值设置为 yes 时，才会查找隐藏文件。

file_type 　 #默认情况下，ansible 只会根据条件查找”文件”，并不会查找”目录”或”软链接”等文件类型，如果想要指定查找的文件类型，可以通过 file_type 指定文件类型，可指定的文件类型有 any、directory、file、link 四种。

patterns 　 #使用此参数指定需要查找的文件名称，支持使用 shell（比如通配符）或者正则表达式去匹配文件名称，默认情况下，使用 shell 匹配对应的文件名，如果想要使用 python 的正则去匹配文件名，需要将 use_regex 参数的值设置为 yes。

use_regex 　 #默认情况下，find 模块不会使用正则表达式去解析 patterns 参数中对应的内容，当 use_regex 设置为 yes 时，表示使用 python 正则解析 patterns 参数中的表达式，否则，使用 glob 通配符解析 patterns 参数中的表达式。

contains 　 #使用此参数可以根据文章内容查找文件，此参数的值为一个正则表达式，find 模块会根据对应的正则表达式匹配文件内容。

age 　 #使用此参数可以根据时间范围查找文件，默认以文件的 mtime 为准与指定的时间进行对比，比如，如果想要查找 mtime 在3天之前的文件，那么可以设置 age=3d，如果想要查找 mtime 在3天以内的文件，可以设置 age=-3d，这里所说的3天是按照当前时间往前推3天，可以使用的单位有秒(s)、分(m)、时(h)、天(d)、星期(w)。

age_stamp 　 #文件的时间属性中有三个时间种类，atime、ctime、mtime，当我们根据时间范围查找文件时，可以指定以哪个时间种类为准，当根据时间查找文件时，默认以 mtime 为准。

size 　 #使用此参数可以根据文件大小查找文件，比如，如果想要查找大于3M的文件，那么可以设置 size=3m,如果想要查找小于50k的文件，可以设置 size=-50k，可以使用的单位有 t、g、m、k、b。

get_checksum 　 #当有符合查找条件的文件被找到时，会同时返回对应文件的 sha1校验码，如果要查找的文件比较大，那么生成校验码的时间会比较长。

十八、lineinfile模块

参数：
path 　 #必须参数，指定要操作的文件。
line 　 #使用此参数指定文本内容。
regexp 　 #使用正则表达式匹配对应的行，当替换文本时，如果有多行文本都能被匹配，则只有最后面被匹配到的那行文本才会被替换，当删除文本时，如果有多行文本都能被匹配，这么这些行都会被删除。
state 　 #当想要删除对应的文本时，需要将state参数的值设置为absent，absent为缺席之意，表示删除，state的默认值为present。

backrefs 　 #默认情况下，当根据正则替换文本时，即使regexp参数中的正则存在分组，在line参数中也不能对正则中的分组进行引用，除非将backrefs参数的值设置为yes。backrefs=yes表示开启后向引用，这样，line参数中就能对regexp参数中的分组进行后向引用了，这样说不太容易明白，可以参考后面的示例命令理解。backrefs=yes除了能够开启后向引用功能，还有另一个作用，默认情况下，当使用正则表达式替换对应行时，如果正则没有匹配到任何的行，那么line对应的内容会被插入到文本的末尾，不过，如果使用了backrefs=yes，情况就不一样了，当使用正则表达式替换对应行时，同时设置了backrefs=yes，那么当正则没有匹配到任何的行时，则不会对文件进行任何操作，相当于保持原文件不变。

insertafter 　 #借助insertafter参数可以将文本插入到“指定的行”之后，insertafter参数的值可以设置为EOF或者正则表达式，EOF为End Of File之意，表示插入到文档的末尾，默认情况下insertafter的值为EOF，如果将insertafter的值设置为正则表达式，表示将文本插入到匹配到正则的行之后，如果正则没有匹配到任何行，则插入到文件末尾，当使用backrefs参数时，此参数会被忽略。

insertbefore 　 #借助insertbefore参数可以将文本插入到“指定的行”之前，insertbefore参数的值可以设置为BOF或者正则表达式，BOF为Begin Of File之意，表示插入到文档的开头，如果将insertbefore的值设置为正则表达式，表示将文本插入到匹配到正则的行之前，如果正则没有匹配到任何行，则插入到文件末尾，当使用backrefs参数时，此参数会被忽略。

backup 　 #是否在修改文件之前对文件进行备份。
create 　 #当要操作的文件并不存在时，是否创建对应的文件。

十九、blockinfile模块

参数：
path 　 #必须参数，指定要操作的文件。
block 　 #此参数用于指定我们想要操作的那”一段文本”，此参数有一个别名叫”content”，使用content或block的作用是相同的。

marker 　 #假如我们想要在指定文件中插入一段文本，ansible会自动为这段文本添加两个标记，一个开始标记，一个结束标记，默认情况下，开始标记为# BEGIN ANSIBLE MANAGED BLOCK，结束标记为# END ANSIBLE MANAGED BLOCK，我们可以使用marker参数自定义”标记”。比如，marker=#{mark}test ，这样设置以后，开始标记变成了# BEGIN test，结束标记变成了# END test，没错，{mark}会自动被替换成开始标记和结束标记中的BEGIN和END，我们也可以插入很多段文本，为不同的段落添加不同的标记，下次通过对应的标记即可找到对应的段落。

state 　 #state参数有两个可选值，present与absent，默认情况下，我们会将指定的一段文本”插入”到文件中，如果对应的文件中已经存在对应标记的文本，默认会更新对应段落，在执行插入操作或更新操作时，state的值为present，默认值就是present，如果对应的文件中已经存在对应标记的文本并且将state的值设置为absent，则表示从文件中删除对应标记的段落。

insertafter 　 #在插入一段文本时，默认会在文件的末尾插入文本，如果你想要将文本插入在某一行的后面，可以使用此参数指定对应的行，也可以使用正则表达式(python正则)，表示将文本插入在符合正则表达式的行的后面。如果有多行文本都能够匹配对应的正则表达式，则以最后一个满足正则的行为准，此参数的值还可以设置为EOF，表示将文本插入到文档末尾。

insertbefore 　 #在插入一段文本时，默认会在文件的末尾插入文本，如果你想要将文本插入在某一行的前面，可以使用此参数指定对应的行，也可以使用正则表达式(python正则)，表示将文本插入在符合正则表达式的行的前面。如果有多行文本都能够匹配对应的正则表达式，则以最后一个满足正则的行为准，此参数的值还可以设置为BOF，表示将文本插入到文档开头。

backup 　 #是否在修改文件之前对文件进行备份。
create 　 #当要操作的文件并不存在时，是否创建对应的文件。